projectdoc Toolbox

Space shortcuts

Page tree

Versions Compared

Old Version 5

changes.mady.by.user Robert Reiner

Saved on

compared with

New Version Current

changes.mady.by.user Robert Reiner

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Document Properties Marker
overridefalse


Doctypemacrohide
NameText Snippet Macro 
Short DescriptionTransclude text content from a remote server. 
Parent
Parent Property
property-nameName
 

Audience
Name List
doctyperole
render-no-hits-as-blanktrue
propertyAudience
 

Categories
Name List
doctypecategory
render-no-hits-as-blanktrue
namesLink / Information System
propertyAudience
 

Tags
Tag List
namesCode Block, Remote Transclusion
 

Type

Name List
doctypemacro-type
namesContent Reuse

 


Iteration
Iteration
valueproduction
hide
ExtensionInformation Systems Extension 
Since1.0 
Sort Keyhide



Section
indextrue
show-titlefalse
titleDescription

Transcludes a text snippet from a resource on a server.

The definition of the snippet is line based. Either there is a marker on a line or the line numbers are specified.

Transclusion
documentTransclusion Warning Accessing external Resources
idsContent


Transclusion
documentInformation System Extension Notice
idsSummary

In contrast to the System Transclusion Macro, the Text Snippet Macro allows to specify the link to the resource directly and therefore does not provide system identifiers to define a space-wide base URL.

...

Section
titleProperties


Section
titleURL

The URL to the resource to transclude.


Section
titleSnippet ID
tagsparameter, snippet-parameter

The identifier of the snippet to include.

With the line after the line containing the identifier the snippet starts. The line marking the end of the snippet again includes this identifier (and this line is also not part of the snippet).

Example Box
titleExample with Snippet ID

The example can be fetched with the ID 'important'.

Code Block
Lorem ipsum dolor sit amet, consectetur adipisici elit, sed eiusmod tempor
incidunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis
nostrud exercitation ullamco laboris nisi ut aliquid ex ea commodi consequat.
Quis aute iure reprehenderit in voluptate velit esse cillum dolore eu fugiat
nulla pariatur. Excepteur sint obcaecat cupiditat non proident, sunt in culpa
qui officia deserunt mollit anim id est laborum.

[important]
Ut wisi enim ad minim veniam, quis nostrud exerci tation ullamcorper suscipit
lobortis nisl ut aliquip ex ea commodo consequat. Duis autem vel eum iriure
dolor in hendrerit in vulputate velit esse molestie consequat, vel illum dolore
eu feugiat nulla facilisis at vero eros et accumsan et iusto odio dignissim qui
blandit praesent luptatum zzril delenit augue duis dolore te feugait nulla
facilisi.
[important]

Nam liber tempor cum soluta nobis eleifend option congue nihil imperdiet doming
id quod mazim placerat facer possim assum. Lorem ipsum dolor sit amet,
consectetuer adipiscing elit, sed diam nonummy nibh euismod tincidunt ut
laoreet dolore magna aliquam erat volutpat. Ut wisi enim ad minim veniam, quis
nostrud exerci tation ullamcorper suscipit lobortis nisl ut aliquip ex ea
commodo consequat.




Section
titleLines
tagsparameter, snippet-parameter

The line or line ranges to match. There may be multiple line ranges, separated by comma.

Here are some examples:

Specified 
Description
-12 
Transclude all lines up to and including line 12.
23 
Transclude line 23 only.
42-50 
Transclude lines 42 to 50, both edge values included.
90- 
Transclude from line 90 to the end of the file.
-12, 23, 42-50, 90- 
All of the above in combination.

Please note that this information is not used, if a snippet ID is provided.


Section
titleEncoding
tagsparameter, snippet-parameter

The encoding of the file. Defaults to the character type announced by the response.


Section
titleUse extra Snippet Marker
tagsparameter, snippet-parameter

Check if the extra labels "SNIPPET START" and "SNIPPET END" should assumed. This may help to make you snippet ID marker unique without having to add this identifier parts with the snippet ID explicitly.

Example Box
titleExample with Snippet ID

The example can be fetched with the ID 'important', but makes it less likely to match an arbitrary string in the text..

Code Block
Lorem ipsum dolor sit amet, consectetur adipisici elit, sed eiusmod tempor
incidunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis
nostrud exercitation ullamco laboris nisi ut aliquid ex ea commodi consequat.
Quis aute iure reprehenderit in voluptate velit esse cillum dolore eu fugiat
nulla pariatur. Excepteur sint obcaecat cupiditat non proident, sunt in culpa
qui officia deserunt mollit anim id est laborum.

[SNIPPET START important]
Ut wisi enim ad minim veniam, quis nostrud exerci tation ullamcorper suscipit
lobortis nisl ut aliquip ex ea commodo consequat. Duis autem vel eum iriure
dolor in hendrerit in vulputate velit esse molestie consequat, vel illum dolore
eu feugiat nulla facilisis at vero eros et accumsan et iusto odio dignissim qui
blandit praesent luptatum zzril delenit augue duis dolore te feugait nulla
facilisi.
[SNIPPET END important]

Nam liber tempor cum soluta nobis eleifend option congue nihil imperdiet doming
id quod mazim placerat facer possim assum. Lorem ipsum dolor sit amet,
consectetuer adipiscing elit, sed diam nonummy nibh euismod tincidunt ut
laoreet dolore magna aliquam erat volutpat. Ut wisi enim ad minim veniam, quis
nostrud exerci tation ullamcorper suscipit lobortis nisl ut aliquip ex ea
commodo consequat.




Transclusion
documentCode Block Macro Standard Parameters
idsContent


...

About

This site is maintained by smartics.

Imprint / Impressum

Data Privacy / Datenschutz 

End User License Agreement (EULA)


To get in touch please send us an e-mail!

smartics email

Keep up-to-date!

Read our

smartics Blog

Follow us on

Twitter YouTube Prezi

Find us on

Bitbucket GitHub Atlassian Marketplace

Powered by




© 2001-2023 smartics - Kronseder & Reiner GmbH