KwGrid:Editing Help: Difference between revisions

From KitwarePublic
Jump to navigationJump to search
(document the kw_article_time_stamp extension)
 
(36 intermediate revisions by 9 users not shown)
Line 5: Line 5:
* Prefix a page name with the <tt>kwGrid:</tt> namespace (lowercase <tt>kw</tt>). For example, [[kwGrid:Welcome]]. Used the [http://meta.wikimedia.org/wiki/Help:Piped_link piped link] notation to hide the namespace when the page is rendered. Namespaces allow separation of different kinds of unrelated content within the same Wiki (i.e. isolate projects like VTK, CMake, ITK, kwGrid). Namespaces also provide facilities to limit searches to a particular area and allow easy exporting of a selection of work.
* Prefix a page name with the <tt>kwGrid:</tt> namespace (lowercase <tt>kw</tt>). For example, [[kwGrid:Welcome]]. Used the [http://meta.wikimedia.org/wiki/Help:Piped_link piped link] notation to hide the namespace when the page is rendered. Namespaces allow separation of different kinds of unrelated content within the same Wiki (i.e. isolate projects like VTK, CMake, ITK, kwGrid). Namespaces also provide facilities to limit searches to a particular area and allow easy exporting of a selection of work.
* Use spaces at will. For example, use [[kwGrid:My Own Hardware]] over [[kwGrid:MyOwnHardware]].
* Use spaces at will. For example, use [[kwGrid:My Own Hardware]] over [[kwGrid:MyOwnHardware]].
* Use slashes (/) to provide additional structure and depth. For example, the [[kwGrid:Partners]] page provides links to pages describing each partner one by one: use [[kwGrid:Partners/Argonne National Lab]] over [[kwGrid:Partners Argonne National Lab]], as it emphasizes that it is a "sub-page" of [[kwGrid:Partners]] and mimics the traditional web structure.
* Use slashes (/) to provide additional structure and depth. For example, the [[kwGrid:Partners]] page provides links to pages describing each partner one by one: use [[kwGrid:Partners/Argonne National Lab]] over [[kwGrid:Partners Argonne National Lab]], as it emphasizes that it is a "sub-page" of [[kwGrid:Partners]] and mimics the traditional web structure. Furthermore, if the [http://en.wikipedia.org/wiki/Help:Link#Subpage_feature sub-page feature] is enabled in the Wiki, a link is automatically created on top of the sub-page to the "parent" page.
* Use the same rules to upload files, but remove spaces and slashes since they are not allowed in a file name. For example: <tt>kwGridPartnersArgonneNationalLab.png</tt>. Let the [[kwGrid:Team|team]] know about the files, images, PDF or Word documents you upload, so that we can also archive a copy in the [[kwGrid:Download#CVS|CVS]] repository.
* Use the same rules to upload files, but remove spaces and slashes since they are not allowed in a file name. For example: <tt>kwGridPartnersArgonneNationalLab.png</tt>. Let the [[kwGrid:Team|team]] know about the files, images, PDF or Word documents you upload, so that we can also archive a copy in the [[kwGrid:Download#CVS|CVS]] repository.


==Page Content==
==Page Content==


* Terminate a page with a call to the [[:Template:kwGrid:Footer|kwGrid:Footer]] template. This automatically adds a footer to the page. This template is used to provide extra navigational links and associate the page to specific searchable categories. Check the bottom of this page to see how this template is rendered.
* Terminate a page with a call to the [[:kwGrid:Template/Footer|Footer]] template. This automatically adds a footer to the page. This template is used to provide extra navigational links and associate the page to specific searchable categories. Check the bottom of this page to see how this template is rendered.
<pre>
<pre>
{{kwGrid:Footer}}
{{:kwGrid:Template/Footer}}
</pre>
</pre>


==Templates==
==Templates==


===<tt>kwGrid:Mail To</tt>===
===<tt>Mail To</tt>===
The [[:Template:kwGrid:Mail To|kwGrid:Mail To]] template can be used to build a mailto: link prefixed with a small mail icon [[Image:kwGridMailToIcon.png]]. For example:
The [[:kwGrid:Template/Mail To|Mail To]] template can be used to build a mailto: link prefixed with a small mail icon [[Image:kwGridMailToIcon.png]]. For example:
<pre>
<pre>
{{kwGrid:Mail To|sebastien.barre@kitware.com|Sebastien Barre}}
{{:kwGrid:Template/Mail To|sebastien.barre@kitware.com|Sebastien Barre}}
</pre>
</pre>
...is rendered as:
...is rendered as:
{{kwGrid:Mail To|sebastien.barre@kitware.com|Sebastien Barre}}
{{:kwGrid:Template/Mail To|sebastien.barre@kitware.com|Sebastien Barre}}


===<tt>kwGrid:Note Box</tt>===
===<tt>Note Box</tt>===
The [[:Template:kwGrid:Note Box|kwGrid:Note Box]] template can be used to provide a short note:
The [[:kwGrid:Template/Note Box|Note Box]] template can be used to provide a short note:
<pre>
<pre>
{{kwGrid:Note Box|message=This is an example of text inside a Note Box template.}}
{{:kwGrid:Template/Note Box|message=This is an example of text inside a Note Box template.}}
</pre>
</pre>
...is rendered as:
...is rendered as:
{{kwGrid:Note Box|message=This is an example of text inside a Note Box template.}}
{{:kwGrid:Template/Note Box|message=This is an example of text inside a Note Box template.}}


===<tt>kwGrid:Warning Box</tt>===
===<tt>Warning Box</tt>===
The [[:Template:kwGrid:Warning Box|kwGrid:Warning Box]] template can be used to provide a short warning:
The [[:kwGrid:Template/Warning Box|Warning Box]] template can be used to provide a short warning:
<pre>
<pre>
{{kwGrid:Warning Box|message=This is an example of text inside a Warning Box template.}}
{{:kwGrid:Template/Warning Box|message=This is an example of text inside a Warning Box template.}}
</pre>
</pre>
...is rendered as:
...is rendered as:
{{kwGrid:Warning Box|message=This is an example of text inside a Warning Box template.}}
{{:kwGrid:Template/Warning Box|message=This is an example of text inside a Warning Box template.}}


===<tt>kwGrid:Help Box</tt>===
===<tt>Help Box</tt>===
The [[:Template:kwGrid:Help Box|kwGrid:Help Box]] template can be used to provide a short help:
The [[:kwGrid:Template/Help Box|Help Box]] template can be used to provide a short help:
<pre>
<pre>
{{kwGrid:Help Box|message=This is an example of text inside a Help Box template.}}
{{:kwGrid:Template/Help Box|message=This is an example of text inside a Help Box template.}}
</pre>
</pre>
...is rendered as:
...is rendered as:
{{kwGrid:Help Box|message=This is an example of text inside a Help Box template.}}
{{:kwGrid:Template/Help Box|message=This is an example of text inside a Help Box template.}}


===<tt>kwGrid:Tip Box</tt>===
===<tt>Tip Box</tt>===
The [[:Template:kwGrid:Tip Box|kwGrid:Tip Box]] template can be used to provide a short tip:
The [[:kwGrid:Template/Tip Box|Tip Box]] template can be used to provide a short tip:
<pre>
<pre>
{{kwGrid:Tip Box|message=This is an example of text inside a Tip Box template.}}
{{:kwGrid:Template/Tip Box|message=This is an example of text inside a Tip Box template.}}
</pre>
</pre>
...is rendered as:
...is rendered as:
{{kwGrid:Tip Box|message=This is an example of text inside a Tip Box template.}}
{{:kwGrid:Template/Tip Box|message=This is an example of text inside a Tip Box template.}}


===<tt>kwGrid:Security Box</tt>===
===<tt>Security Box</tt>===
The [[:Template:kwGrid:Security Box|kwGrid:Security Box]] template can be used to provide a short security notice:
The [[:kwGrid:Template/Security Box|Security Box]] template can be used to provide a short security notice:
<pre>
<pre>
{{kwGrid:Security Box|message=This is an example of text inside a Security Box template.}}
{{:kwGrid:Template/Security Box|message=This is an example of text inside a Security Box template.}}
</pre>
</pre>
...is rendered as:
...is rendered as:
{{kwGrid:Security Box|message=This is an example of text inside a Security Box template.}}
{{:kwGrid:Template/Security Box|message=This is an example of text inside a Security Box template.}}


==Extensions==


MediaWiki, the software that runs this wiki, allows developers to [http://meta.wikimedia.org/wiki/Write_your_own_MediaWiki_extension write their own extensions] to the wiki markup. An extension defines an HTML/XML-style tag which can be used in the wiki editor like any other markup.
{{:kwGrid:Template/Footer}}
 
===<tt>kw_include_file</tt>===
This tag allows you to include the contents of a remote file in your page. It is typically used to include source code and prevent duplication between a source tree and a web page. For safety reasons, access to the local filesystem is denied and translations are performed to (hopefully) prevent people from including malicious HTML/JavaScript code. The following example include the extension code itself through CVSWeb:
<pre>
<kw_include_file>http://public.kitware.com/cgi-bin/viewcvs.cgi/*checkout*/scripts/media-wiki-extensions/kwIncludeFile.php?root=kwGridWeb</kw_include_file>
</pre>
...is rendered as:
<kw_include_file>http://public.kitware.com/cgi-bin/viewcvs.cgi/*checkout*/scripts/media-wiki-extensions/kwIncludeFile.php?root=kwGridWeb</kw_include_file>
 
===<tt>kw_article_time_stamp</tt>===
This tag allows you to include the time stamp of a Wiki article, i.e. its last modification date. Note that the built-in page-caching feature may lead to incorrect results sometimes. The following example includes the time stamp of the current page and the [[kwGrid:Welcome|Welcome]] page:
<pre>
* [[kwGrid:Editing_Help]]: <kw_article_time_stamp>kwGrid:Editing Help</kw_article_time_stamp>
* [[kwGrid:Welcome]]: <kw_article_time_stamp>kwGrid:Welcome</kw_article_time_stamp>
</pre>
...is rendered as:
* [[kwGrid:Editing_Help]]: <kw_article_time_stamp>kwGrid:Editing Help</kw_article_time_stamp>
* [[kwGrid:Welcome]]: <kw_article_time_stamp>kwGrid:Welcome</kw_article_time_stamp>
 
{{kwGrid:Footer}}

Latest revision as of 13:27, 15 November 2019

In addition to the guidelines provided in the MediaWiki General Editing page, the following rules are suggested:

Page and File Names

  • Prefix a page name with the kwGrid: namespace (lowercase kw). For example, kwGrid:Welcome. Used the piped link notation to hide the namespace when the page is rendered. Namespaces allow separation of different kinds of unrelated content within the same Wiki (i.e. isolate projects like VTK, CMake, ITK, kwGrid). Namespaces also provide facilities to limit searches to a particular area and allow easy exporting of a selection of work.
  • Use spaces at will. For example, use kwGrid:My Own Hardware over kwGrid:MyOwnHardware.
  • Use slashes (/) to provide additional structure and depth. For example, the kwGrid:Partners page provides links to pages describing each partner one by one: use kwGrid:Partners/Argonne National Lab over kwGrid:Partners Argonne National Lab, as it emphasizes that it is a "sub-page" of kwGrid:Partners and mimics the traditional web structure. Furthermore, if the sub-page feature is enabled in the Wiki, a link is automatically created on top of the sub-page to the "parent" page.
  • Use the same rules to upload files, but remove spaces and slashes since they are not allowed in a file name. For example: kwGridPartnersArgonneNationalLab.png. Let the team know about the files, images, PDF or Word documents you upload, so that we can also archive a copy in the CVS repository.

Page Content

  • Terminate a page with a call to the Footer template. This automatically adds a footer to the page. This template is used to provide extra navigational links and associate the page to specific searchable categories. Check the bottom of this page to see how this template is rendered.
{{:kwGrid:Template/Footer}}

Templates

Mail To

The Mail To template can be used to build a mailto: link prefixed with a small mail icon KwGridMailToIcon.png. For example: 

{{:kwGrid:Template/Mail To|sebastien.barre@kitware.com|Sebastien Barre}}

...is rendered as: KwGridMailToIcon.png Sebastien Barre

Note Box

The Note Box template can be used to provide a short note: 

{{:kwGrid:Template/Note Box|message=This is an example of text inside a Note Box template.}}

...is rendered as:

KwGridInfoIcon.png Note: This is an example of text inside a Note Box template.

Warning Box

The Warning Box template can be used to provide a short warning: 

{{:kwGrid:Template/Warning Box|message=This is an example of text inside a Warning Box template.}}

...is rendered as:

KwGridWarningIcon.png Warning: This is an example of text inside a Warning Box template.

Help Box

The Help Box template can be used to provide a short help: 

{{:kwGrid:Template/Help Box|message=This is an example of text inside a Help Box template.}}

...is rendered as:

KwGridHelpIcon.png Help: This is an example of text inside a Help Box template.

Tip Box

The Tip Box template can be used to provide a short tip: 

{{:kwGrid:Template/Tip Box|message=This is an example of text inside a Tip Box template.}}

...is rendered as:

KwGridWrenchIcon.png Tip: This is an example of text inside a Tip Box template.

Security Box

The Security Box template can be used to provide a short security notice: 

{{:kwGrid:Template/Security Box|message=This is an example of text inside a Security Box template.}}

...is rendered as:

KwGridPadlockIcon.png Security Notice: This is an example of text inside a Security Box template.



kwGrid: [Welcome | Site Map | Editing Help] - [Public Web | Public Wiki | Private Wiki]
Retrieved from "https://public.kitware.com/Wiki/index.php?title=KwGrid:Editing_Help&oldid=63986"