Wiki source code of How to include a velocity page into another page ?
Version 4.2 by Vincent Massol on 2017/09/01
Hide last authors
| author | version | line-number | content |
|---|---|---|---|
 |
3.1 | 1 | {{box cssClass="floatinginfobox" title="**Contents**"}} |
| 2 | {{toc/}} | ||
| 3 | {{/box}} | ||
 |
1.11 | 4 | |
| |
3.1 | 5 | In order to include a velocity page into another page you have to use velocity macros. Here are the possible macros you can use for this purpose: |
| |
1.1 | 6 | |
| |
3.1 | 7 | = Include a *.vm script = |
| |
1.1 | 8 | |
 |
4.1 | 9 | These macros take as parameter a relative URL to a {{code}}*.vm{{/code}} script. |
| |
1.17 | 10 | |
| |
3.1 | 11 | == template() == |
| |
1.17 | 12 | |
| |
3.1 | 13 | {{info}} |
| 14 | Specification: [[extensions:Extension.Template Macro]] | ||
| 15 | {{/info}} | ||
| |
1.1 | 16 | |
| |
3.1 | 17 | This is the equivalent of the C preprocessor include directive: the result is a copy of the script passed as argument, into your script. |
| |
1.17 | 18 | |
| |
3.1 | 19 | = Include the Velocity code of another XWiki page = |
| |
1.17 | 20 | |
| |
3.1 | 21 | These macros take as parameter the XWiki name of the page, Space.Page. |
| |
2.1 | 22 | |
| |
3.1 | 23 | == includeInContext() == |
| |
1.13 | 24 | |
| |
3.1 | 25 | {{info}} |
| 26 | Specification: [[extensions:Extension.Include In Context Macro]] | ||
| 27 | {{/info}} | ||
| |
1.1 | 28 | |
| |
3.1 | 29 | If you have a script stored as an XWiki page you can include its code into another script by using includeInContext: |
| |
2.1 | 30 | |
| |
3.1 | 31 | {{code}} |
| 32 | #includeInContext("mySpace.myPage") | ||
| 33 | {{/code}} | ||
| |
2.1 | 34 | |
| |
3.1 | 35 | == includeForm() == |
| 36 | |||
| 37 | {{info}} | ||
| 38 | Specification: [[extensions:Extension.Include Form Macro]] | ||
| 39 | {{/info}} | ||
| 40 | |||
| 41 | Similar to includeInContext(), except that using includeForm() in a page will set the default edit mode for that page as "inline". For example, the script you want to include uses the method ##com.xpn.xwiki.doc.XWikiDocument.display()## to access a field of an object attached to the including page, like a typical class sheet: | ||
| 42 | |||
| |
2.1 | 43 | {{code language="velocity"}} |
| |
1.1 | 44 | ## Change class name to your class name |
| 45 | #set($class = $doc.getObject("CompanionTemplateSystem.CompanionDocumentMetaDataClass").xWikiClass) | ||
| 46 | |||
| 47 | <dl> | ||
| 48 | #foreach($prop in $class.properties) | ||
| 49 | #if(($prop.getName() != "Copyright") && ($prop.getName() != "TargetGroup") ) | ||
| 50 | <dt> *${prop.prettyName}* </dt> | ||
| 51 | <dd>$doc.display($prop.getName())</dd> | ||
| 52 | #end | ||
| 53 | #end | ||
| 54 | </dl> | ||
| |
2.1 | 55 | {{/code}} |
| 56 | |||
| |
3.1 | 57 | which is stored as a regular XWiki page (let's say myPage in mySpace). |
| |
1.1 | 58 | |
| |
3.1 | 59 | You will include the page using includeForm(): |
| |
2.1 | 60 | |
| |
3.1 | 61 | {{code}} |
| 62 | #includeForm("mySpace.myPage") | ||
| 63 | {{/code}} | ||
| |
1.1 | 64 | |
| |
3.1 | 65 | This way, the including page will always be edited in inline mode by default. Thus in the example of the class sheet, the including page will display input fields mapped to the respective object fields. |
| |
1.14 | 66 | |
| |
3.1 | 67 | If you prefer to keep the default edit as set in your XWiki.XWikiPreferences class, you can use the other macros, and still edit a page in inline mode: choose the "Inline form" option in the "Edit" menu, provided your user type is advanced. |
| 68 | |||
| 69 | == includeTopic() == | ||
| 70 | |||
| 71 | {{info}} | ||
| 72 | Specification: [[extensions:Extension.Include Topic Macro]] | ||
| 73 | {{/info}} | ||
| 74 | |||
| 75 | Same syntax as includeInContext(). Contrary to includeInContext(), the included XWiki page is interpreted in its own context. For example, you would include a page using includeTopic() if the included page had to access its own objects in order for the including page to be displayed properly. |
