Difference between revisions of "Wikispooks:Semantic Mediawiki"

From Wikispooks
Jump to navigation Jump to search
m (typo)
(Expand)
Line 1: Line 1:
 
{{HelpSection|image=SMW.png}}
 
{{HelpSection|image=SMW.png}}
−
'''Semantic Mediawiki''' (SMW) is an extension for the basic [[Mediawiki]] software that powers the Wikispooks site. Its purpose is to provide semantic definition and querying capabilities which are lacking in the basic software. This offers two main benefits to the site - (i) a richer set of ways to organise and use the information, (ii) the possibility to define {{WSLink|site feeds}} to export the data in a predictable format, which others can build.
+
'''Semantic Mediawiki''' (SMW) is an extends the basic Mediawiki software by providing semantic definition and querying capabilities. This offers two main benefits to the site - (i) a richer set of ways to organise and use the information, (ii) the possibility to define {{WSLink|site feeds}} to export the data in a predictable format, for others to build on.
  
−
==Learning SMW==
+
==Starting with SMW==
−
Learning Semantic Mediawiki may be quite a steep learning curve for non-computer scientists, but remember that it is a large piece of software and not much is needed to get started. Administrators are available to answer queries and give help where needed. A useful guide to the syntax - which gives an idea of the range of SMW is the quick reference guide, available [http://postable.net/smwqr/smw-quick-reference.pdf here].
+
Semantic Mediawiki may seem to present quite a steep learning curve for non-computer scientists, as it is a large piece of software and the idea of 'semantic data' may not be easily graspable. [[User:Robin|] has volunteered to answer any and all {{SMW}}} queries and give to beginners help where needed. If you want to get to grips with the syntax, there is a lot of help online about this, and a useful guide to the syntax - which also gives an idea of the range of SMW - is the quick reference guide, available [http://postable.net/smwqr/smw-quick-reference.pdf here]. Note that you don't actually need to understand any syntax to get started - if you can fill in a form, then you can fill in semantic data!
  
−
==SMW on Wikispooks==
+
==Use on Wikispooks==
−
SMW is installed on Wikispooks together with a bunch of associated extensions (Semantic Bundle). Towards the end of 2013, Wikispooks has been expanding its use of SMW - most notably through Semantic Forms extension. Policy and practices in this area are currently fluid a Wikispooks editors are gradually learning how to get the best out of the software, and simultaneously developing a framework for its use on the site. Some best practices are emerging:
+
{{FA|Wikispooks:SMW Best Practice}}
 +
SMW is installed on Wikispooks together with a bunch of associated extensions (Semantic Bundle). Towards the end of 2013, Wikispooks has been expanding its use of SMW. Policy and practices in this area are currently fluid a Wikispooks editors are gradually learning how to get the best out of the software, and simultaneously developing a framework for its use on the site. Some best practices are emerging:
  
−
===No loose markup===
+
==Semantic Properties==
−
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 templates''. See [[:Category:Semantic Templates|Semantic Templates]] for suitable templates. The main semantic template to use for replacing inline semantic data is [[Template:SMWData]].
+
{{FA|WikiSpooks:Semantic Properties}}
−
 
+
A ''property'' is the basic type of semantic data. Wikispooks currently has [[:Category:Properties|{{#expr: {{PAGESINCAT:Special Properties}}+{{PAGESINCAT:Stable Properties}}+{{PAGESINCAT:Experimental Properties}} properties]] in use, each of which is documented using [[Template:Property]].  
−
===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.
 
−
 
 
−
===Timelines===
 
−
{{FA|WikiSpooks:Timelines}}
 
−
Experiments with timelines, notably the [[JFK Assassination Timeline]] have made further use of SMW. Timelines are a semantic results format which must have at least one date property defined in order to correctly displayed events. The JFK timeline currently uses 3 semantic property definitions (Start, End and Description), 'Start' and 'End' are of property type '[[Special:Types/Date|Date]]' and 'Description is of property type '[[Special:Types/Text|Text]]'.
 
  
−
The properties currently used by the timelines experiments may need to be changed to accord with standard but evolving semantic properties syntax and grammar.
+
==Semantic Templates==
 +
{{FA|WikiSpooks:Semantic Templates}}
 +
If you can code ordinary [[Help:Templates|Templates]], then you should find it no trouble to code Semantic Templates. All the structure and syntax from ordinary Mediawiki applies. In addition there are a couple of parser functions to provide access to the semantic properties.
  
−
==Properties==
+
==Semantic Forms==
−
 
+
{{FA|WikiSpooks:Semantic Forms}}
−
{{FA|WikiSpooks:Semantic Properties}}
+
A ''form'' is just what it sounds like - a set of boxes and checkboxes to be filled in. The 'semantic' aspect is that each of these fields is tied to particular parameters in a template. Wikispooks currently has only a few semantic forms in use, because the first priority is defining the objects and templates.
−
A ''property'' is the basic type of semantic data. Wikispooks currently uses [[:Category:Properties|{{#expr: {{PAGESINCAT:Special Properties}}+{{PAGESINCAT:Stable Properties}}+{{PAGESINCAT:Experimental Properties}}+{{PAGESINCAT:Mooted Properties}}}} properties]], all marked up with [[Template:Property]].  
 
  
 
==Development==
 
==Development==
−
Existing use of SMW suggests that it has considerable potential to enhance the functionality of the site, making its contents more accessible to well thought out querying. Among other things, this will require:
+
SMW has considerable potential to enhance the functionality of the site. Among other things, this will require some capable programming by editors up to speed on SMW who:
−
 
+
#Define a core set of semantic ''objects'' for structuring the data, with their own sets of properties and interrelationships
−
*Some capable programming by editors up to speed on SMW
+
#Creating a set of semantic ''templates'' to present these objects and their interrelationships
−
*Identifying and defining a core set of semantic ''properties'' (and possibly also ''concepts'') which are useful for structuring the data
+
#Creating a set of semantic ''forms'' to present these objects and their interrelationships
−
*Applying these new structures to the existing content
+
#Processing the existing content to fit it into these structures
−
*Allowing for seemlessly creation of these structures on new pages by non-SMW aware users (i.e. through semantic forms)
+
#Allowing for seamless creation of these structures on new pages by non-SMW aware users (i.e. through semantic forms)
  
 
===Integrating with Mediawiki===
 
===Integrating with Mediawiki===
−
Mediawiki's main organisational tools for arranging pages are the ''namespace'' and the ''category''. Adding SMW's ''properties'' and ''concepts'' to the mix allows for considerable flexibility in how to organise data. The basic approach is a replacement of the generic ''grouped together with'' (category) relationship by SMW's more precisely defined relationships (properties). How best to do this remains an open question, but some basic principles are:
+
Mediawiki's main organisational tools for arranging pages are the ''namespace'' and the ''category''. The latter structure is more or less deprecated on Wikispooks, since SMW has proved that it is able to provide a superior user experience with not much more work than categories. There is a possibility of greatly expanding the use of namespaces to reflect the structure of objects defined (i.e. having separate namespaces for {{t|Person:}}, {{t|Event:}}, {{t|Book:}}, {{t|Nation:}} etc. Input is welcome about this on this talk page.
−
#''Properties'' and ''Concepts'' are generally to be preferred to ''categories''
 
−
#For reasons of reliability and maintenance, data should be dynamically produced (e.g. from templates) rather than input by hand whenever possible
 
−
#''Hard thinking'' is preferable to ''hard work'' where possible :)
 
−
 
 
−
''See [[{{TALKPAGENAME}}]] for more detailed discussion''.
 
  
−
{{WikiSpooks Footer/Technical}}
+
{{WikiSpooks Footer/Semantic Mediawiki}}
−
[[Category:WikiSpooks Technical]]
+
[[Category:Project]]

Revision as of 17:51, 4 January 2014

SMW.png

Semantic Mediawiki (SMW) is an extends the basic Mediawiki software by providing semantic definition and querying capabilities. This offers two main benefits to the site - (i) a richer set of ways to organise and use the information, (ii) the possibility to define site feeds to export the data in a predictable format, for others to build on.

Starting with SMW

Semantic Mediawiki may seem to present quite a steep learning curve for non-computer scientists, as it is a large piece of software and the idea of 'semantic data' may not be easily graspable. [[User:Robin|] has volunteered to answer any and all SMW} queries and give to beginners help where needed. If you want to get to grips with the syntax, there is a lot of help online about this, and a useful guide to the syntax - which also gives an idea of the range of SMW - is the quick reference guide, available here. Note that you don't actually need to understand any syntax to get started - if you can fill in a form, then you can fill in semantic data!

Use on Wikispooks

Full article: Wikispooks:SMW Best Practice

SMW is installed on Wikispooks together with a bunch of associated extensions (Semantic Bundle). Towards the end of 2013, Wikispooks has been expanding its use of SMW. Policy and practices in this area are currently fluid a Wikispooks editors are gradually learning how to get the best out of the software, and simultaneously developing a framework for its use on the site. Some best practices are emerging:

Semantic Properties

Full article: WikiSpooks:Semantic Properties

A property is the basic type of semantic data. Wikispooks currently has {{#expr: 13+113+134 properties in use, each of which is documented using Template:Property.

Semantic Templates

Full article: WikiSpooks:Semantic Templates

If you can code ordinary Templates, then you should find it no trouble to code Semantic Templates. All the structure and syntax from ordinary Mediawiki applies. In addition there are a couple of parser functions to provide access to the semantic properties.

Semantic Forms

Full article: WikiSpooks:Semantic Forms

A form is just what it sounds like - a set of boxes and checkboxes to be filled in. The 'semantic' aspect is that each of these fields is tied to particular parameters in a template. Wikispooks currently has only a few semantic forms in use, because the first priority is defining the objects and templates.

Development

SMW has considerable potential to enhance the functionality of the site. Among other things, this will require some capable programming by editors up to speed on SMW who:

  1. Define a core set of semantic objects for structuring the data, with their own sets of properties and interrelationships
  2. Creating a set of semantic templates to present these objects and their interrelationships
  3. Creating a set of semantic forms to present these objects and their interrelationships
  4. Processing the existing content to fit it into these structures
  5. Allowing for seamless creation of these structures on new pages by non-SMW aware users (i.e. through semantic forms)

Integrating with Mediawiki

Mediawiki's main organisational tools for arranging pages are the namespace and the category. The latter structure is more or less deprecated on Wikispooks, since SMW has proved that it is able to provide a superior user experience with not much more work than categories. There is a possibility of greatly expanding the use of namespaces to reflect the structure of objects defined (i.e. having separate namespaces for Person:, Event:, Book:, Nation: etc. Input is welcome about this on this talk page.


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









Retrieved from "https://wikispooks.com/w/index.php?title=Wikispooks:Semantic_Mediawiki&oldid=26051"