Difference between revisions of "Documentation/Nightly/WikiCheatSheet"

From Slicer Wiki
Jump to: navigation, search
Tag: 2017 source edit
(21 intermediate revisions by the same user not shown)
Line 1: Line 1:
 +
=Wiki templates=
  
= Wiki templates =
+
==Version==
  
== Version ==
+
*[[Template:Documentation/prevversion|Documentation/prevversion]] : <code><nowiki>{{documentation/prevversion}}</nowiki></code>
  
* [[Template:Documentation/version|Documentation/version]]
+
*[[Template:Documentation/nextversion|Documentation/nextversion]] : <code><nowiki>{{documentation/nextversion}}</nowiki></code>
  
* [[Template:Documentation/nextversion|Documentation/nextversion]]
+
*[[Template:Documentation/currentversion|Documentation/currentversion]]: Should be used outside namespaced wiki pages.
  
* [[Template:Documentation/subpathwithoutversion|Documentation/subpathwithoutversion]]
+
*[[Template:Documentation/version|Documentation/version]] : <code><nowiki>{{documentation/version}}</nowiki></code> : Should be used only from namespaced wiki pages.
  
* [[Template:Documentation/currentversion|Documentation/currentversion]]: Initially added to allow retrieving current version outside of the wiki.
+
Example of namespaced wiki pages:
  
 +
*[[Documentation/Nightly/Developers/Tutorials/DocumentExtension#Naming_conventions]]
 +
*[[Documentation/4.4/Developers]]
  
== Banners ==
+
Example of NON namespaced wiki page:
  
*  
+
*[[{{FULLPAGENAME}}]]
 +
*[[Slicer4:VisualBlog]]
  
  
 +
==Status==
  
== Doxygen ==
+
*[[Template:New|New]] : <code><nowiki>{{new}}</nowiki></code>
  
* <code>[[Template:Documentation/{{documentation/version}}/doxygen-class-url|Documentation/{{documentation/version}}/doxygen-class-url]]</code>
+
*[[Template:Updated|Updated]] : <code><nowiki>{{updated}}</nowiki></code>
  
* <code>[[Template:Documentation/{{documentation/version}}/doxygen-base-url|Documentation/{{documentation/version}}/doxygen-base-url]]</code>
+
*[[Template:Done|Done]] : <code><nowiki>{{done}}</nowiki></code>
 +
 
 +
*[[Template:Not Done|Not Done]] : <code><nowiki>{{Not Done}}</nowiki></code>
 +
 
 +
*[[Template:Wip|Wip]] : <code><nowiki>{{wip}}</nowiki></code>
 +
 
 +
==Highlights==
 +
 
 +
*[[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/banner|Documentation/banner]] : <code><nowiki>{{documentation/banner}}</nowiki></code>
 +
*[[Template:Historical|Historical]] : <code><nowiki>{{Historical}}</nowiki></code>
 +
 
 +
==Formatting==
 +
 
 +
*[[Template:Pre2|Pre2]]: : <code><nowiki>{{pre2|Some long text}}</nowiki></code> : Similar to <code>&lt;pre&gt;</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

Revision as of 04:23, 24 March 2020

Home < Documentation < Nightly < WikiCheatSheet

Wiki templates

Version

Example of namespaced wiki pages:

Example of NON namespaced wiki page:


Status

Highlights

  • Remark : {{remark|green|This is something awesome you should read}}

Banners

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}}

Version specific wiki templates

To learn more about documentation version (or namespace), see here

Version

Doxygen

Visual editing

Table