KwGrid:Editing Help: Difference between revisions

From KitwarePublic
Jump to navigationJump to search
(Add security box template example)
(Add info about private section and file names)
Line 3: Line 3:
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 Name===
===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.
* 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.
* 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>.
* Restrict access to a page by prefixing it with [[kwGrid:Private/]]. For example, [[kwGrid:Private/Welcome]]. This places the page in the password-protected private section of the kwGrid Wiki. In the same way, restrict access to files you upload by prefixing them with <tt>kwGridPrivate</tt>.


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

Revision as of 06:18, 5 February 2005

Editing Help

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.
  • Restrict access to a page by prefixing it with kwGrid:Private/. For example, kwGrid:Private/Welcome. This places the page in the password-protected private section of the kwGrid Wiki. In the same way, restrict access to files you upload by prefixing them with kwGridPrivate.

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

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

Template:KwGrid:Note Box

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

Template:KwGrid:Warning Box

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

Template:KwGrid:Help Box

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

Template:KwGrid:Security Box

Template:KwGrid:Footer