Style

= Style Guide =

On this page, we summarize best practices for keeping the GoodRelations Wiki consistent.

URI Pattern
We use a hierarchical URI pattern:


 * Pages of generic relevance are in the "root" name space
 * Example: http://wiki.goodrelations-vocabulary.org/Logo
 * The following types of documents have their own subspaces
 * /Cookbook/ - all recipes
 * /Case_studies/ - all case studies
 * /Tools/ - all tools
 * /Events/ - all events
 * /Vocabularies/ - all ontologies (VSO etc.)
 * /GEP/ - GoodRelations Enhancement Proposals

Examples:


 * http://wiki.goodrelations-vocabulary.org/Case_studies/Best_Buy
 * http://wiki.goodrelations-vocabulary.org/Tools/BMEcat2GR

Color Codes

 * Links
 * Foreground color: #df6010
 * Code listings
 * Background color: #fff9ef
 * Border color: #efa363
 * Header menu
 * Background color on select: #636161
 * Background color on hover: none
 * Border color: #bd7b1a
 * Navigation boxes and footer bar
 * Background color: #eeeeee
 * Border color: #dddddd (bottom or top)

Basic Structure
Page titles use H1, e.g. = The GoodRelations Cookbook = All subsections use H2. e.g. = The GoodRelations Cookbook = blabla

Section 1
blabla

Pages
Page URIs should be useful page titles, e.g.


 * http://wiki.goodrelations-vocabulary.org/Case_studies

Only the first character is capitalized, unless the page title is a proper name, e.g.


 * http://wiki.goodrelations-vocabulary.org/GoodRelations_Validator

If the full page title is pretty long, use a good acronym and disable the displaying of this as the page title, e.g. as in


 * http://wiki.goodrelations-vocabulary.org/BMEcat2GR

Categories
Category names should be in singular form, with proper English capitalization and underscores for spaces (no CamelWords). Examples:


 * http://wiki.goodrelations-vocabulary.org/Category:Tool
 * http://wiki.goodrelations-vocabulary.org/Category:Shop_Extension

Multiple Columns
Use a div element instead of tables:

Two columns
&lt;div style="background-color:#EEEEEE;"&gt; &lt;div style="float: left; width: 50%;"&gt; 'Tools &lt;/div&gt; &lt;div style="float: left; width: 50%;"&gt; 'FAQs &lt;/div&gt; &lt;div style="clear: left;"&gt;&lt;/div&gt; &lt;/div&gt;

Three columns
&lt;div style="background-color:#EEEEEE;"&gt; &lt;div style="padding: 6px; float: left; width: 30%;"&gt; 'Tools &lt;/div&gt; &lt;div style="padding: 6px; float: left; width: 30%;"&gt; 'FAQs &lt;/div&gt; &lt;div style="padding: 6px; float: left; width: 30%;"&gt; 'People &lt;/div&gt; &lt;div style="clear: left;"&gt;&lt;/div&gt; &lt;/div&gt;

Disabling Page Title
Insert (has been disabled - titles only appear if colon is found in title name, e.g. Mediawiki:Sidebar)

Forcing the Table of Contents to be Displayed at a Certain Position
or

Side-bar
Edit http://wiki.goodrelations-vocabulary.org/Mediawiki:Sidebar

Example
According to scientists, the Sun is pretty big.&lt;ref&gt;E. Miller, The Sun, (New York: Academic Press, 2005), 23-5.&lt;/ref&gt; The Moon, however, is not so big.&lt;ref&gt;R. Smith, "Size of the Moon", Scientific American, 46 (April 1978): 44-6.&lt;/ref&gt;

Sample result
According to scientists, the Sun is pretty big. The Moon, however, is not so big.

Slideshare
This widget allows you to add SlideShare presentations to your wiki page.

To insert this widget, use the following code:

Parameters

 * doc - is a parameter from embed code
 * start - optional parameter to define start slide number
 * width &amp; height - optional, 425x348 is a default
 * player - defaults to '2' and allows you to switch to other players
 * norelated - if set, widget will not display related content and sharing functionality at the end of the deck