KwGrid:Editing Help: Difference between revisions
From KitwarePublic
Jump to navigationJump to search
(Remove blurb about Private access, this does not quite work) |
(example for the kw_include_file extension) |
||
| Line 1: | Line 1: | ||
In addition to the guidelines provided in the [http://meta.wikimedia.org/wiki/Help:Editing MediaWiki General Editing] page, the following rules are suggested: | In addition to the guidelines provided in the [http://meta.wikimedia.org/wiki/Help:Editing MediaWiki General Editing] page, the following rules are suggested: | ||
==Page and File Names== | |||
* 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. | ||
| Line 10: | Line 8: | ||
* 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>. | * 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>. | ||
==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 [[: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. | ||
| Line 17: | Line 15: | ||
</pre> | </pre> | ||
==Templates== | |||
* The [[:Template:kwGrid:Note Box|kwGrid:Note Box]] template can be used to provide a short note: | * The [[:Template:kwGrid:Note Box|kwGrid:Note Box]] template can be used to provide a short note: | ||
| Line 23: | Line 21: | ||
{{kwGrid:Note Box|message=This is an example of text inside a Note Box template.}} | {{kwGrid:Note Box|message=This is an example of text inside a Note Box template.}} | ||
</pre> | </pre> | ||
...is rendered as: | |||
{{kwGrid:Note Box|message=This is an example of text inside a Note Box template.}} | {{kwGrid:Note Box|message=This is an example of text inside a Note Box template.}} | ||
| Line 29: | Line 28: | ||
{{kwGrid:Warning Box|message=This is an example of text inside a Warning Box template.}} | {{kwGrid:Warning Box|message=This is an example of text inside a Warning Box template.}} | ||
</pre> | </pre> | ||
...is rendered as: | |||
{{kwGrid:Warning Box|message=This is an example of text inside a Warning Box template.}} | {{kwGrid:Warning Box|message=This is an example of text inside a Warning Box template.}} | ||
| Line 35: | Line 35: | ||
{{kwGrid:Help Box|message=This is an example of text inside a Help Box template.}} | {{kwGrid:Help Box|message=This is an example of text inside a Help Box template.}} | ||
</pre> | </pre> | ||
...is rendered as: | |||
{{kwGrid:Help Box|message=This is an example of text inside a Help Box template.}} | {{kwGrid:Help Box|message=This is an example of text inside a Help Box template.}} | ||
| Line 41: | Line 42: | ||
{{kwGrid:Security Box|message=This is an example of text inside a Security Box template.}} | {{kwGrid:Security Box|message=This is an example of text inside a Security Box template.}} | ||
</pre> | </pre> | ||
...is rendered as: | |||
{{kwGrid:Security Box|message=This is an example of text inside a Security Box template.}} | {{kwGrid: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. | |||
* <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> | |||
{{kwGrid:Footer}} | {{kwGrid:Footer}} | ||
Revision as of 19:26, 8 February 2005
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.
- 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.
Page Content
- Terminate a page with a call to the 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.
{{kwGrid:Footer}}
Templates
- The kwGrid:Note Box template can be used to provide a short note:
{{kwGrid:Note Box|message=This is an example of text inside a Note Box template.}}
...is rendered as: Template:KwGrid:Note Box
- The kwGrid:Warning Box template can be used to provide a short warning:
{{kwGrid:Warning Box|message=This is an example of text inside a Warning Box template.}}
...is rendered as: Template:KwGrid:Warning Box
- The kwGrid:Help Box template can be used to provide a short help:
{{kwGrid:Help Box|message=This is an example of text inside a Help Box template.}}
...is rendered as: Template:KwGrid:Help Box
- The kwGrid:Security Box template can be used to provide a short security notice:
{{kwGrid:Security Box|message=This is an example of text inside a Security Box template.}}
...is rendered as: Template:KwGrid:Security Box
Extensions
MediaWiki, the software that runs this wiki, allows developers to 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.
- kw_include_file: 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:
<kw_include_file>http://public.kitware.com/cgi-bin/viewcvs.cgi/*checkout*/scripts/media-wiki-extensions/kwIncludeFile.php?root=kwGridWeb</kw_include_file>
...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>
