Difference between revisions of "Documentation/Nightly/WikiCheatSheet"
From Slicer Wiki
Tag: 2017 source edit |
|||
| (12 intermediate revisions by the same user not shown) | |||
| Line 1: | Line 1: | ||
| − | = Wiki templates = | + | =Wiki templates= |
| − | == Version == | + | ==Version== |
| − | * [[Template:Documentation/ | + | *[[Template:Documentation/prevversion|Documentation/prevversion]] : <code><nowiki>{{documentation/prevversion}}</nowiki></code> |
| − | * [[Template:Documentation/ | + | *[[Template:Documentation/nextversion|Documentation/nextversion]] : <code><nowiki>{{documentation/nextversion}}</nowiki></code> |
| − | + | *[[Template:Documentation/currentversion|Documentation/currentversion]]: Should be used outside namespaced wiki pages. | |
| − | * [[Template: | + | *[[Template:Documentation/version|Documentation/version]] : <code><nowiki>{{documentation/version}}</nowiki></code> : Should be used only from namespaced wiki pages. |
| − | + | Example of namespaced wiki pages: | |
| − | * [[ | + | *[[Documentation/Nightly/Developers/Tutorials/DocumentExtension#Naming_conventions]] |
| + | *[[Documentation/4.4/Developers]] | ||
| − | + | Example of NON namespaced wiki page: | |
| − | * [[ | + | *[[{{FULLPAGENAME}}]] |
| + | *[[Slicer4:VisualBlog]] | ||
| − | |||
| − | + | ==Status== | |
| − | + | *[[Template:New|New]] : <code><nowiki>{{new}}</nowiki></code> | |
| − | * [[Template: | + | *[[Template:Updated|Updated]] : <code><nowiki>{{updated}}</nowiki></code> |
| − | + | *[[Template:Done|Done]] : <code><nowiki>{{done}}</nowiki></code> | |
| − | * [[Template: | + | *[[Template:Not Done|Not Done]] : <code><nowiki>{{Not Done}}</nowiki></code> |
| − | * [[Template: | + | *[[Template:Wip|Wip]] : <code><nowiki>{{wip}}</nowiki></code> |
| − | == | + | ==Highlights== |
| − | * [[Template: | + | *[[Template:Note|Note]] : <code><nowiki>{{note}}</nowiki></code> |
| − | + | *[[Template:Remark|Remark]] : <code><nowiki>{{remark|green|This is something awesome you should read}}</nowiki></code> | |
| − | == | + | ==Banners== |
| − | * [[Template:Documentation/ | + | *[[Template:Documentation/banner|Documentation/banner]] : <code><nowiki>{{documentation/banner}}</nowiki></code> |
| + | *[[Template:Historical|Historical]] : <code><nowiki>{{Historical}}</nowiki></code> | ||
| + | *[[Template:Documentation/historicaltraining|historicaltraining]] : <code><nowiki>{{Documentation/historicaltraining}}</nowiki></code> | ||
| − | + | ==Formatting== | |
| − | * [[Template:Documentation/versioncheck|Documentation/versioncheck]] | + | *[[Template:Pre2|Pre2]]: : <code><nowiki>{{pre2|Some long text}}</nowiki></code> : Similar to <code><pre></code> tag but include a horizontal scroll bar |
| + | |||
| + | ==Images== | ||
| + | |||
| + | *[[Template:octicon/bookmark|octicon/bookmark]] : <code><nowiki>{{octicon/bookmark|Documentation/Nightly/Developers/Build_Instructions}}</nowiki></code> | ||
| + | |||
| + | *[[Template:Tool]] : <code><nowiki>[[{{tool|logo|cdash}}|x50px]] </nowiki></code> | ||
| + | |||
| + | =Version specific wiki templates= | ||
| + | |||
| + | To learn more about documentation version (or namespace), see [[Documentation/{{documentation/version}}/Developers/Tutorials/DocumentModule#Documentation_version|here]] | ||
| + | |||
| + | ==Version== | ||
| + | |||
| + | *[[Template:Documentation/version|Documentation/version]] | ||
| + | |||
| + | *[[Template:Documentation/subpathwithoutversion|Documentation/subpathwithoutversion]] | ||
| + | |||
| + | *[[Template:Documentation/versioncheck|Documentation/versioncheck]] | ||
| + | |||
| + | ==Doxygen== | ||
| + | |||
| + | *[[Template:Documentation/{{documentation/version}}/doxygen-class-url|Documentation/{{documentation/version}}/doxygen-class-url]] | ||
| + | |||
| + | *[[Template:Documentation/{{documentation/version}}/doxygen-base-url|Documentation/{{documentation/version}}/doxygen-base-url]] | ||
| + | |||
| + | =Visual editing= | ||
| + | ==Table== | ||
| + | |||
| + | *Table generator: http://www.tablesgenerator.com/mediawiki_tables | ||
Latest revision as of 22:11, 22 November 2022
Home < Documentation < Nightly < WikiCheatSheetContents
Wiki templates
Version
- Documentation/prevversion :
{{documentation/prevversion}}
- Documentation/nextversion :
{{documentation/nextversion}}
- Documentation/currentversion: Should be used outside namespaced wiki pages.
- Documentation/version :
{{documentation/version}}: Should be used only from namespaced wiki pages.
Example of namespaced wiki pages:
- Documentation/Nightly/Developers/Tutorials/DocumentExtension#Naming_conventions
- Documentation/4.4/Developers
Example of NON namespaced wiki page:
Status
- New :
{{new}}
- Updated :
{{updated}}
- Done :
{{done}}
- Not Done :
{{Not Done}}
- Wip :
{{wip}}
Highlights
- Note :
{{note}}
- Remark :
{{remark|green|This is something awesome you should read}}
Banners
- Documentation/banner :
{{documentation/banner}} - Historical :
{{Historical}} - historicaltraining :
{{Documentation/historicaltraining}}
Formatting
- Pre2: :
{{pre2|Some long text}}: Similar to<pre>tag but include a horizontal scroll bar
Images
- octicon/bookmark :
{{octicon/bookmark|Documentation/Nightly/Developers/Build_Instructions}}
- Template:Tool :
[[{{tool|logo|cdash}}|x50px]]
Version specific wiki templates
To learn more about documentation version (or namespace), see here
Version
Doxygen
Visual editing
Table
- Table generator: http://www.tablesgenerator.com/mediawiki_tables
