Difference between revisions of "Help:Getting started"

From semantic-mediawiki.org
m ("Starter kid": typo)
Line 1: Line 1:
<div style="padding: 2px; border: 0px solid rgb(22, 78, 175); border-radius: 5px; width: 31%; min-width: 220px; float: left; margin: 5px;">
 
<h2 class="frontpagesectionheader smw-light-blue">About</h2>
 
* [[Help:Introduction to Semantic MediaWiki|Introduction to SMW]]
 
* [[FAQ|Frequently Asked Questions]]
 
* [[Talks and publications]]
 
* [[Testimonials]] / [[Sites using Semantic MediaWiki|SMW-using wikis]]
 
</div>
 
<div style="padding: 2px; border: 0px solid rgb(22, 78, 175); border-radius: 5px; width: 31%; min-width: 220px; float: left; margin: 5px;">
 
<h2 class="frontpagesectionheader smw-light-blue">Installation</h2>
 
* [[Help:Administrator manual|Administrator manual]]
 
* [[Help:Installation|Installation]]
 
* [[Help:Configuration|Configuration]]
 
* [[Help:Extensions|Related extensions]]
 
</div>
 
<div style="padding: 2px; border: 0px solid rgb(22, 78, 175); border-radius: 5px; width: 31%; min-width: 220px; float: left; margin: 5px;">
 
<h2 class="frontpagesectionheader smw-light-blue">Usage</h2>
 
* '''[[Help:User manual|User manual]]'''
 
* [[SMW reference]]
 
* [[Sandbox tests|Try out SMW online]]
 
* [[Help:Reporting bugs|Reporting bugs and wishes]]
 
</div><div class="visualClear"></div>
 
 
== Download Semantic MediaWiki ==
 
{{#ask:
 
[[Has image collection::getting started tutorial]]
 
[[Has keyword::install]]
 
|?Has description
 
|captionproperty=Has description
 
|overlay=yes
 
|widths=180
 
|heights=160
 
|format=gallery
 
|widget=slideshow
 
|overlay=yes
 
|navigation=auto
 
|delay=3
 
|class=demo-float-right
 
}}
 
This installation should not take longer than five minutes. For a detailed description, see the [[Help:Installation|installation guide]].
 
 
* '''Download''' by employing [[Composer]] to install dependencies or browse the [[tarball]] source for an appropriate download
 
* '''Update''' by running the `update` script from the MediaWiki root directory.
 
* '''Verify''' using [[Special:Version]]
 
<div class="visualClear"></div>
 
 
 
== Introduction ==
 
 
{{#ask:
 
{{#ask:
 
  [[Has image collection::getting started]]
 
  [[Has image collection::getting started]]
Line 61: Line 14:
 
  |class=demo-float-right
 
  |class=demo-float-right
 
}}
 
}}
 +
This "Getting started" page aims to provide an easy to follow introduction on how to install and work with Semantic MediaWiki for users unfamiliar with this MediaWiki extension.
  
A quick introduction to Semantic MediaWiki highlighting:
+
* [[Help:Getting started/Part 0 (Download and install)|Part 0 (Download and install)]]
 +
* [[Help:Getting started/Part 1 (Working with annotations)|Part 1 (Working with annotations)]]
 +
* [[Help:Getting started/Part 2 (Working with templates to add annotations)|Part 2 (Working with templates to add annotations)]]
 +
* [[Help:Getting started/Part 3 (Working with queries)|Part 3 (Working with queries)]]
  
* Creating a statement
+
== "Starter kit" ==
* Displaying facts
 
* Query facts
 
<div class="visualClear"></div>
 
  
== Working with annotations ==
+
If you want to start quickly and run some tests without having to declare all properties by yourself then we suggest you [[Special:Import|import]] the following [https://gist.github.com/mwjames/2f83d3d775cbcc42b4ed XML] into your wiki. After the import you should be able to use properties like [[Property:Has wattage]] (see [https://gist.github.com/mwjames/2f83d3d775cbcc42b4ed#file-smw-sandbox-import-xml-L785-L805 property list]) with content pages such as [[Berlin]].
{{#ask:
 
[[Has image collection::getting started tutorial]]
 
[[Has keyword::editing]]
 
[[Has keyword::annotation]]
 
|?Has description
 
|captionproperty=Has description
 
|overlay=yes
 
|widths=180
 
|heights=160
 
|format=gallery
 
|widget=slideshow
 
|overlay=yes
 
|navigation=auto
 
|delay=3
 
|class=demo-float-right
 
}}
 
  
After the installation and without setting specific custom [[configuration]]s (using the default configuration deployed with the installation) the following images explain how to make [[Help:in-text annotation|in-text annotation]]'s that will establish connections between content within your wiki.
+
== See also ==
 
+
* '''[[Help:User manual|User manual]]'''
* Apply in-text annotations to a free-text
+
* [[SMW reference]]
* Using `Special:Browse` to display available annotations of a page
+
* [[Sandbox tests|Try out SMW online]]
* Type annotation for a user-defined property
+
* [[Help:Introduction to Semantic MediaWiki|Introduction to SMW]]
* Display values that are assigned to a specific property
+
* [[FAQ|Frequently Asked Questions]]
 
 
For further help, see the help pages on [[Help:Editing|editing]], [[Help:Properties and types|properties and types]] as well as on special page [[Help:Special:Browse|"Browse"]].
 
<div class="visualClear"></div>
 
 
 
== Working with templates to add annotations ==
 
{{#ask:
 
[[Has image collection::getting started tutorial]]
 
[[Has keyword::template annotation]]
 
|?Has description
 
|captionproperty=Has description
 
|overlay=yes
 
|widths=180
 
|heights=160
 
|format=gallery
 
|widget=slideshow
 
|overlay=yes
 
|navigation=auto
 
|delay=3
 
|class=demo-float-right
 
}}
 
 
 
A short demonstration on how to use [[mws:Help:Templates|MediaWiki templates]] and [[properties]] to ease the annotation process. It should not take longer than 10 minutes to apply necessary changes. See also the help page on [[Help:Semantic templates|semantic templates]].
 
 
 
* Adding annotation information to a template
 
* Using a template to add information to a text
 
* Using `Special:Browse` to display information after a template was used
 
<div class="visualClear"></div>
 
 
 
== Working with queries ==
 
{{#ask:
 
[[Has image collection::getting started tutorial]]
 
[[Has keyword::query]]
 
|?Has description
 
|captionproperty=Has description
 
|overlay=yes
 
|widths=180
 
|heights=160
 
|format=gallery
 
|widget=slideshow
 
|overlay=yes
 
|navigation=auto
 
|delay=3
 
|class=demo-float-right
 
}}
 
 
 
The final step in the tutorial is to add queries to display requested information about a subject. It should not take longer than five minutes to apply the changes. See also the help pages on [[Help:Selecting pages|selecting pages]] and on [[Help:Semantic search|semantic search]].
 
 
 
* Adding #ask queries to a page
 
* Display information generated by a #ask query
 
* Example of a RDF export generated by a #ask query
 
<div class="visualClear"></div>
 
 
 
== "Starter kit" ==
 
 
 
If you want to start quickly and run some tests without having to declare all properties by yourself then we suggest you [[Special:Import|import]] to following [https://gist.github.com/mwjames/2f83d3d775cbcc42b4ed XML] into your wiki. After the import you should be able to use properties like [[Property:Has wattage]] (see [https://gist.github.com/mwjames/2f83d3d775cbcc42b4ed#file-smw-sandbox-import-xml-L785-L805 property list]) with content pages such as [[Berlin]].
 
  
 
__NOTOC__
 
__NOTOC__

Revision as of 18:01, 21 September 2015

This "Getting started" page aims to provide an easy to follow introduction on how to install and work with Semantic MediaWiki for users unfamiliar with this MediaWiki extension.

"Starter kit"[edit]

If you want to start quickly and run some tests without having to declare all properties by yourself then we suggest you import the following XML into your wiki. After the import you should be able to use properties like Property:Has wattage (see property list) with content pages such as Berlin.

See also[edit]