Template:Guideline/doc

This is a documentation subpage for . It contains usage information, categories and other content that is not part of the original template page.

This template is still in development This template will implement a guideline on a page.

Guideline Address

The guideline is defined by an address. For indexing purposes, the address may consist of different levels, separated with slashes (/). For further explanation, I'll call this the <address>

Roads/Country

Guideline Region

The Region of the guideline is where the guideline is applied. Examples of regions:

Benelux
Belgium
USA
...

There is one special Region that defines the default or general guideline. The name of this Special Region still needs to be defined. For further explanation, I'll call this special region <Default> but a more self explaining name should be chosen: Some examples:

Default
General
Guideline
International
World
Universe
Global
Universal
<empty>     (this means, no <Default>, just <address> pages for the default)
...

Once a name is chosen, it will be a lot of work to change it but it is doable

How it should work

{{ guideline | <address> }}

The guideline works out on which page it is transcluded. From the page name it will derive the base page name as the region where it is used. For further explanation, I'll call this as <region>

Benelux/Roads/anothersubpage
-> <Region> is Benelux

The template will try to find the following pages:

[[<Region>/<address>]]
[[<Default>/<address>]]

If a page is empty (Blanked), the page is considered as not found.

If there is only the Default page (witch should occurs in most of the time), the content of the <Default>/<address> page is transcluded.

If you want to overwrite the guideline, the page <Region>/<address> is created (contains content). In this case, the content of the <Default>/<address> page is transcluded in small print and with strike through. Followed by the content of the <Region>/<address> page.

A method of adding content to a guideline is not yet determined. A possible method could be transcluding the <Default>/<address> page on to the <Region>/<address> page. If this could be detected, it is potentialy the best solution. If not, this will result in the content of the <Default>/<address> page being placed first strike through and then as normal.

Where is this templated used

This template is used on general pages about a <Subject> like roads / highways / Landmarks ...

This pages are located under <Default>/<Subject> and make use of the Template:Guideline.

Regions can then import these paged by creating a page called: <Region>/<Subject> and the content will be transcluding the <Default>/<Subject> page.

content of page <Region>/<Subject>:
{{:<Default>/<address>}}

This results in an immediate update on the region pages if the default page is updated so regions will be up to date when new guidelines are added.

Other examples on the web

Take a look at the sourcecode of one of the following pages:

http://wiki.cyanogenmod.org/w/Hammerhead_Info?setlang=en
http://wiki.cyanogenmod.org/index.php?title=Install_CM_for_hammerhead&action=edit&setlang=en