Help:Guidelines

ICE Enterprises
Jump to: navigation, search

For the purpose of standardization within the ICE Wiki, please follow the guidelines laid out here when creating or editing pages.

For help with wiki formatting or other questions regarding the wiki, please refer to the online MediaWiki help.

Contents

General

These standards apply to all pages.

Sections

Explicitly demarcated sections are vital to the structure of an effective wiki page.

Sections are assigned by using heading markup code:

== Section Name ==

This example implements a level 2 section (2 × =), which is the highest level section which should be used in a page (the page title is displayed as an implicit level 1 section heading). Subsections are declared using lower level headings, e.g.

=== Subsection Name ===
==== Sub-Subsection Name ====
etc.

Note: A level 1 heading (=) should be reserved only for the title which the wiki system automatically prints.

Be sure to use sections and subsections as much as possible to organize information: this not only improves the aesthetics of a page but also enhances the semantic value of the structure and populates the automatically generated page outline.

The basic anatomy of a product page should remain consistent for ease of editing and browsing. Model the structure after the following:

For examples of how this would look in practice, see below on Example Pages.

Categories and Hierarchy

Every page must be a member of a category. In the particular idiom of MediaWiki, categories are the most convenient and powerful way to organize pages a virtual hierarchy. Categories may contain pages, but also other categories. Additionally, pages may be members of multiple categories.

To add a page to a category, insert the following tag, generally as the last line:

[[Category:category_name]]

A category has its own home page with an automatic listing of its members, but for aesthetic purposes, we have opted, for all practical purposes, to replace these with our own index pages. This works by creating an index page by the same name as the category, e.g. Category:Foo → Foo. Then, by a using a number of extensions and templates (quasi-preprocessors marked by {{...}}), we can create an index page that has a link to the parent directory as well as a list of the contents of its corresponding category (only edit category_name):

{{Gotoparent|category_name}}
{{Catindex|category={{PAGENAME}}}}
[[Category:Index_pages]]

The built-in category index page (Category:category_name) contains only a category tag to its parent category and a redirect command pointing to the fa├žade index page above:

#REDIRECT [[category_name]]
[[Category:parent_category]]

Example Pages

For ease of use, you may copy and paste these example page skeletons to create a particular type of page.

Note: It is recommended that you remove the explanatory comments (<!-- -->) before publishing.

I/O Modules

<div class="description">A General Description</div> <!-- must be first line -->
[[File:<image_name>|thumb|<caption>]]
Introductory text

== Features ==

* A
* B
* C

== Applications ==

* A
* B
* C

== Other Sections ==

Blah, blah, blah...

{{pagebreak}} <!-- (optional) for printing purposes, allows for logical page breaks

== Pricing and Status ==
{{Status|<status>|<price>}}

[[Category|<module_category>]]
{{footer}}    <!-- (optional) added only if {{pagebreak}} is never used -->

ICE Wiki Templates

In MediaWiki terminology, a template is a type of macro which accepts and returns data in order to automate aspects of the wiki and page content. This type of template uses the following syntax: {{Template_name|parameter1|parameter2|...}}.

The templates detailed in this section were specifically written for ICE Wiki.

Gotoparent

This template provides a link to the supplied parent category index. It allows for easy navigation up the categorical hierarchy.

Catindex

This template uses the CategoryTree extension and template to produce a simple list of the members of the supplied category and an introductory line, naming the category which it lists.

Status

The syntax for the Status template is

{{Status|<status>|<price>}}

There are three options for the Status template's status parameter:

The price parameter should be given as a number without the dollar sign.

The prod Parameter

A typical Status template implementation, a product in production, would look like this:

{{Status|prod|500.00}}

This yields:

This model is in production. For pricing, please see the Pricing page.

The dev Parameter

{{Status|dev}}

This yields:

This model is currently in development.

The eol Parameter

{{Status|eol}}

This yields:

EOL has been declared for this model: see End-of-Life for details. Please call for pricing and availability.

See Template:Status for more.

Print Templates

Footer

This is only rendered when printing. It adds a standard ICE footer to the bottom of each page. It should only be used when {{pagebreak}} is never used on the page. It should generally be placed at the bottom of the page.

Pagebreak

Pagebreak is used to insert logical page break when printing the page. It utilizes the {{footer}} template itself, hence the redundancy of uses both on a page.

Personal tools
Namespaces
Variants
Actions
Navigation
Products
Support
Corporate
Toolbox
Help