Difference between revisions of "Wikispooks:SMW Best Practice"

From Wikispooks
Jump to navigation Jump to search
(deprecate hardcoded data)
(clarify)
Line 23: Line 23:
  
 
===Descriptions===
 
===Descriptions===
''Every Wikispooks page needs a description. Since this format is fixed, it provides an easy way to start helping the transition to an SMW-based site''. Note that the description should:
+
''Every Wikispooks page needs a description. Since this format is fixed, it provides an easy way to start helping the transition to an SMW-based site''.<br/>
 +
The description should:
 
* Make sense when viewed in isolation (One of the main uses will be to describe links in from other pages)
 
* Make sense when viewed in isolation (One of the main uses will be to describe links in from other pages)
 
* Be a single paragraph of plaintext (no wiki formatting and no <Cr> use)
 
* Be a single paragraph of plaintext (no wiki formatting and no <Cr> use)

Revision as of 16:02, 2 March 2014

SMW.png

SMW is new on Wikispooks so editors and administrators are learning as they go, but some best practices are emerging:

Object Orientation

Full article: WikiSpooks:Semantic Objects

A set of objects is being co-developed with corresponding sets of properties, templates and forms (generally in that order). Each of these correspond to high level structures such as Event, Person, Group etc. and should consist of matching set or properties, semantic template and semantic form.

No Loose Markup

Wikispooks is following the SMW recommendation of strongly discouraging loose pieces of inline markup. For reasons of future-proofing and maintenance, SMW properties should be assigned through Semantic Templates. By using templates to add the semantic properties, it is easy to adjust them as needed. The main semantic template to use for replacing inline semantic data is Template:SMWData.

Presenting SMW Data

SMW querying is the recommended way to present large data tables inline in pages, since this is easier in terms of reuse. The main semantic template for displaying semantic data is Template:SMWDocs, which is a kind of 'catch all' for relevant data. When inserted in a page manually, it should usually be used just before the "References" section.

Updating existing Data

Until the basic structures are fixed, the process of updating the data is complicated by the fact that the target formats is still evolving.

Hardcoded Lists and Tables

Wikispooks still has a lot of data hardcoded in lists and tables (i.e. the data is intermingled with the presentation in a form that is hard to unpick or modify). For example, World War I/Key Players or US Efforts to Suppress Democracy since 1945. As a matter of general principle, hardcoded data tables and lists should be replaced where practical by a semantic template. Such tables have two main advantages over the existing method:

  1. They are easier to edit/upgrade (since the source data is much cleaner, and separate from the markup method, which is in a template)
  2. The semantic data they generate are available for use elsewhere (be that on Wikispooks or beyond)

Currently, the set of Semantic Properties is still too limited to allow elegant representation of a lot of the information in hard-coded data tables. New proprties will have to be created to allow existing hardcoded data to be represented by SMW. See the Category:Pages with hardcoded data tables and lists for a list of such pages.

Descriptions

Every Wikispooks page needs a description. Since this format is fixed, it provides an easy way to start helping the transition to an SMW-based site.
The description should:

  • Make sense when viewed in isolation (One of the main uses will be to describe links in from other pages)
  • Be a single paragraph of plaintext (no wiki formatting and no <Cr> use)
  • Be <500 characters (i.e ~4 lines at most)

Importing RDF Vocabularies

Semantic Mediawiki allows importing of RDF vocabularies so that Wikispooks properties can be equated to properties from other vocabularies. This is recommended where possible.


Wikispooks logo.png Policy.png Wikispooks to do.png Tools2.png SMW.png
Semantic
Mediawiki
Help.png