Help:Contents
From AcceleoWiki
This page explains how to use tools such as templates provided which ease page editions. You will find basic help on this topic here.
Contents |
Templates
FAQ Entry
The following templates should be in order to insert a new FAQ entry.
| Question: |
{{FAQQuestion
|How can I insert a new FAQ entry?}}
| |
|---|---|---|
| Answer: |
{{FAQAnswer
|You have to use those two templates.}}
|
Answer: You have to use those two templates. |
A notable side effect of this template is that it discard section editing feature. Since questions are rendered as title, in order to generate the corresponding table of contents, the [edit] link would be displayed weirdly.
Attribution box/Media information
Media can be attributed and documented using the following template
{{Information
|source=Source
|description=Description
|author=Author
|date=Date
|permission=Permission
}}
|
|
A shortcut has been created for icon extracted from the Oxygen icon set:
{{OxygenInformation}}
|
|
Note
If you want to place a note in your page, you can use the following template
{{Note|Place your content here}}
|
|
Modules
Modules have their own infobox
{{Module
|name=Name
|status=incubation
|licence=Licence
|target=Target
|metamodel=Metamodel
|contributor=Initial Contributor
|contact=Contact
}}
|
| ||||||||||||||||
Planning Entry
A template has been created to display a progress bar used on module pages to display the current progress of a planning entry.
{{ModulePlanningEntry
|name=Task
|percent=50
}}
|
50%
Task:
|
Syntax highlight
Source code can be highlight since this wiki has the GeSHi extension installed. Acceleo template code can also be colorized.
<source lang="acceleo"> <% metamodel http://www.eclipse.org/uml2/2.0.0/UML %> <%-- test --%> <%script type="uml.Class" name="genDesc" file="<%name%>.html"%> <html> <head/> <body> <h1>Class Description</h1> <p>Name of class : <%name%></p> <p>Comment : <%ownedComment.body%> </body> </html> </source> |
<% metamodel http://www.eclipse.org/uml2/2.0.0/UML %> <%-- test --%> <%script type="uml.Class" name="genDesc" file="<%name%>.html"%> <html> <head/> <body> <h1>Class Description</h1> <p>Name of class : <%name%></p> <p>Comment : <%ownedComment.body%> </body> </html> |
Those languages are currently supported:
- Acceleo
- C / C++ / C#
- Java
- PHP
- XML
- See the full list
Add the attribute line="true" in the source tag in order to use the line numbering feature.
