This page (revision-56) was last changed on 08-Aug-2014 06:47 by Volker Belli

This page was created on 25-Oct-2013 11:19 by Jochen Reutelshöfer

Only authorized users are allowed to rename pages.

Only authorized users are allowed to delete pages.

Page revision history

Version Date Modified Size Author Changes ... Change note
56 08-Aug-2014 06:47 6 KB Volker Belli to previous
55 08-Aug-2014 06:42 6 KB Volker Belli to previous | to last
54 08-Aug-2014 06:36 2 KB Volker Belli to previous | to last
53 23-Jun-2014 15:28 2 KB Albrecht Striffler to previous | to last
52 23-Jun-2014 15:28 2 KB Albrecht Striffler to previous | to last
51 23-Jun-2014 15:27 2 KB Albrecht Striffler to previous | to last
50 23-Jun-2014 15:25 2 KB Albrecht Striffler to previous | to last
49 23-Jun-2014 15:19 2 KB Albrecht Striffler to previous | to last
48 23-Jun-2014 15:18 2 KB Albrecht Striffler to previous | to last
47 23-Jun-2014 15:17 2 KB Albrecht Striffler to previous | to last
46 23-Jun-2014 15:14 2 KB Albrecht Striffler to previous | to last
45 23-Jun-2014 15:13 2 KB Albrecht Striffler to previous | to last
44 23-Jun-2014 15:13 2 KB Albrecht Striffler to previous | to last
43 23-Jun-2014 15:11 2 KB Albrecht Striffler to previous | to last
42 23-Jun-2014 15:07 2 KB Albrecht Striffler to previous | to last
41 23-Jun-2014 15:06 2 KB Albrecht Striffler to previous | to last

Page References

Incoming links Outgoing links
Doc Include
Doc Include

Version management

Difference between version and

At line 5 changed one line
Within the markup, each non-empty line specifies an included section or article. There are two types of includes, a "simple include" and a "normalized header include". To include an article or header, use the normal wiki-like syntax, such as e.g. "~[article~]", "~[article#header~]" or "~[displayed name ~| article~]".
%%prettify
{{{
%%include...
}}}
/%
At line 7 changed one line
A simple example looks like:
For an include at least the target of the page or page fragment that should be include needs to be specified in the body of the markup:
At line 12 changed 2 lines
// the minus before the link suppresses the header of the included section,
// you may remove it to show the header as well
// here goes a comment
At line 21 added one line
__Renders as:__
At line 19 removed 3 lines
__Renders as:__ (without the lines above and below)
----
At line 23 changed 3 lines
// the minus before the link suppresses the header of the included section,
// you may remove it to show the header as well
- [Main#d3web - The Open-Source Diagnostic Platform]
Main#d3web - The Open-Source Diagnostic Platform
At line 28 changed one line
----
! Including a Chapter of a Page
At line 29 added 2 lines
The markup allows to include a specific (sub-)chapter of a wiki page. Therefore the chapter mechanism from the basic wiki markup is used as described on [Doc BasicMarkup].
After the include page name, the respective header name can be appended using '#'. In the following example only the chapter ''Contacts'' of the page ''Getting Started'' is included:
At line 31 removed 9 lines
!!! Simple Include
The simple include is very hand if you want to integrate some page content into another wiki page without duplicate the content, e.g. to create some overview page or a kind of summary page with the most relevant information about some topics.
To include a article, use the article name as article name. The whole content of the article will be displayed. To include a header section use article name#header title. There will be the header section included, as well as all the sections naturally belongs to the header (all sections until a header with the same level or a higher level will follow).
Using simple includes (and only there), you can also skip the brackets "~[...~]" (for backward compatibility), because we know that each line contains a link.
%%prettify
At line 41 changed 4 lines
%%Include
[my full article] // Includes the content of the full article (with no additional header)
my other article // Includes the content of the full article (with no additional header)
[my partial article#my header] // Includes header "my header" plus the sections belonging to the header
%%include
Info Commercial Support#Contact
@frame: true
At line 47 removed one line
/%
At line 39 added one line
__Renders as:__
At line 50 changed one line
!!! Normalized Header Include
%%include
Info Commercial Support#Contact
@frame: true
@zoom: 100%
%
At line 52 changed one line
This extended version of the include is intended to create some complex article out of a binch of other articles, e.g. when creating a complete document and define a set of articles as chapters or sections within your document. The major advantages are that you can add headers to included articles and
! The Frame Annotation
At line 54 changed one line
You can also include a section using header normalization. Here you precede every include by one or more enumeration characters ("#", "*", or "-"). Include declaration will be used as a synthetic header. The level of the header will be the highest with one enumeration character (like page headings); for two enumeration characters there will be a heading of similar to "!!!", for tree characters "!!" and so on.
By default the included content is surrounded by a frame that also highlighted by mouse over. On the upper right corner a tool menu provides a link to the original page.
That frame can also be suppressed using the ''frame'' annotation.
Then, the content is seamlessly integrated in the local wiki page content:
At line 56 removed one line
The enumeration icons have different meanings. "#" is the usual one. It creates headings and allows the headings style to be enumerated (if defined in the corresponding style). Using "*" suppresses the enumeration of the headings, for the specified heading and all headings included. Using the "-" will suppress the heading that is included (but not the headings with deeper level that are also included by the statement.
At line 58 removed 3 lines
If you are defining an include line with an empty link, only the heading is created without including anything.
%%prettify
At line 62 changed 7 lines
%%Include
* [Status] // includes article Status suppressing header numbering
# [Preface | my full article] // includes article with header "Preface"
# [About |] // creates top-level header without including anything
# About // identical to the line above
## [About the Project] // includes article as sub-heading section
## [About this Document] // includes an other article as sub-heading section
%%include
Info Commercial Support#Contact
At line 71 removed one line
/%
At line 74 changed one line
!!! Additional Annotations
__Renders as:__
At line 76 removed 7 lines
!! The Frame Annotation
By default, the content is seamlessly integrated in the local wiki page content. But the included content can be surrounded by a frame that also highlighted by mouse over. On the upper right corner a tool menu provides a link to the original page. That frame can also be activated using the ''frame'' annotation.
%%prettify
{{{
At line 84 changed 2 lines
- [Main#d3web - The Open-Source Diagnostic Platform]
@frame: show
Info Commercial Support#Contact
@zoom: 100%
At line 87 removed 2 lines
}}}
/%
At line 90 changed 7 lines
__Renders as:__ (without the lines above and below)
----
%%include
- [Main#d3web - The Open-Source Diagnostic Platform]
@frame: show
%
----
! The Zoom Annotation
At line 98 removed 3 lines
!! The Zoom Annotation
At line 102 removed 2 lines
%%prettify
At line 106 changed 2 lines
[Main#Quick Start]
@zoom: 50%
Info Commercial Support#Contact
@zoom: 150%
At line 110 removed one line
/%
At line 112 changed 2 lines
__Renders as:__ (without the lines above and below)
----
__Renders as:__
At line 115 changed 2 lines
[Main#Quick Start]
@zoom: 50%
Info Commercial Support#Contact
@zoom: 150%
At line 118 removed one line
----
At line 120 changed one line
__Note:__ The zoom attribute is currently not displayed correctly on all browsers for all zoom levels (Chrome works best for this feature at the moment).
__Note:__ The zoom attribute is not displayed correctly on all browsers for all zoom levels (Chrome recommended for this feature).
At line 122 removed 15 lines
!! The Definition Annotation
By default the definition of the include itself is only visible when it is erroneous or you edit it. You can force that the include definition is shown by adding the "{{@definition:show}}" annotation to the include markup. This is required if you rely on the tool menu of the include markup, e.g. to use the "Microsoft Word" download tool.
!!! Known Limitations
Unfortunately there are currently a bunch of known drawbacks using the include markup. They might be fixed in the future (or not), but they require a more deeper intervention into the JSP-Wiki behavior. These drawbacks are:
;Images: Images that are included with some section or article are not displayed if they are referenced inside the original page with only the file name and no article name. As a workaround, specify the article name together with the image name in the {{src}}-attribute of the image declaration.
;Header Normalization: The feature of header normalization only works well when you export the page using the "word export" menu item on the include markup (to be able to do that, "@definition: show" must be set). Unfortunately JSP-Wiki does not allow us to normalize the headers at the moment for rendering content inside wiki pages.
;TableOfContents: Using the table-of-contents plugin "{{~[{TableOfContents}~]}}" works well for the word download, but unfortunately not for for the included contents when using "header normalization". This is a side effect of the limitation [Header Normalization|Doc Include#Header Normalization] and may be fixed with that in some future.
This page (revision-56) was last changed on 08-Aug-2014 06:47 by Volker Belli Top