Difference between revisions of "Help:Getting started"

From semantic-mediawiki.org
 
(25 intermediate revisions by 4 users not shown)
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;">
+
{{InfoBox
<h2 class="frontpagesectionheader smw-dark-blue">About</h2>
+
|Name=Getting started
* [[Help:Introduction to Semantic MediaWiki|Introduction to SMW]]
+
|Description=Aims to provide an easy to follow introduction users unfamiliar with Semantic MediaWiki
* [[FAQ|Frequently Asked Questions]]
+
|Keyword=getting started;introduction
* [[Talks and publications]]
+
|Collection=getting started
* [[Testimonials]] / [[Sites using Semantic MediaWiki|SMW-using wikis]]
+
  |Video={{Video
</div>
+
  |provider=YouTube
<div style="padding: 2px; border: 0px solid rgb(22, 78, 175); border-radius: 5px; width: 31%; min-width: 220px; float: left; margin: 5px;">
+
  |description=Semantic MediaWiki for Beginners
<h2 class="frontpagesectionheader smw-dark-blue">Installation</h2>
+
  |id=1CaNJLsAI2A
* [[Help:Administrator manual|Administrator manual]]
+
  |type=Tutorial video
* [[Help:Installation|Installation]]
+
  }}
* [[Help:Configuration|Configuration]]
+
}}{{interlanguage}}{{doc.info
* [[Help:Extensions|Related extensions]]
+
  |master page={{FULLPAGENAME}}
</div>
+
  |status=effective
<div style="padding: 2px; border: 0px solid rgb(22, 78, 175); border-radius: 5px; width: 31%; min-width: 220px; float: left; margin: 5px;">
+
  |progress=99
<h2 class="frontpagesectionheader smw-dark-blue">Usage</h2>
+
  |priority=2
* '''[[Help:User manual|User manual]]'''
+
  |minversion=3.0.0
* [[SMW reference]]
 
* [[Sandbox tests|Try out SMW online]]
 
* [[Help:Reporting bugs|Reporting bugs and wishes]]
 
</div><div class="visualClear"></div>
 
 
 
== Getting 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
+
This "Getting started" page aims to provide an easy to follow introduction on how to install and work with Semantic MediaWiki (aka SMW) for users unfamiliar with this MediaWiki extension.
* '''Update''' by running the `update` script from the MediaWiki root directory.
+
* [[Help:Getting started/Part 0 (Download and install)|Part 0 (Download and install)]]
* '''Verify''' using [[Special:Version]]
+
* [[Help:Getting started/Part 1 (Working with annotations)|Part 1 (Working with annotations)]]
<div class="visualClear"></div>
+
* [[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)]]
  
== Working with annotations ==
+
For a more in-depth description about what SMW can do and where it can help, please read the following [[Help:Introduction to Semantic MediaWiki|introductory]] text. If you are unsure about terms like [[Property]], [[Subject]], or [[RDF]] when reading material related to SMW then the following may help:
{{#ask:
+
* [[Help:Getting started/Part 4 (Understanding the Graph Data Model)|Part 4 (Understanding the Graph Data Model)]]
[[Has image collection::getting started tutorial]]
+
* [[Help:Category vs. property|Part 5 (Understanding the difference between a category and a property)]]
[[Has keyword::editing]]
+
* [[Help:Property naming|Part 6 (Property naming)]]
[[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 [[annotation]]s that will establish connections between content within your wiki.
+
Additional tutorial examples include (which may require additional extensions):
 +
* [[Help:Getting started/Using geographic coordinates|Part X.1 Using geographic coordinates]]  
 +
* [[Help:Getting started/Using mathematical operations|Part X.2 Using mathematical operations]]
  
* Apply in-text annotations to a free-text
+
== Examples ==
* Using `Special:Browse` to display available annotations of a page
+
* TODO
* Type annotation for a user-defined property
 
* Display values that are assigned to a specific property
 
  
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"]].
+
== "Starter kit" ==
<div class="visualClear"></div>
+
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]].
  
== Working with templates to add annotations ==
+
== Step-by-step-tutorial ==
{{#ask:
+
* [[SMWCon Fall 2017/Introduction_to_Semantic_MediaWiki|Introduction to Semantic MediaWiki]] - Shows how to create properties, annotations and queries around an example.
[[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]].
+
== See also ==
 
+
* '''[[Help:User manual|User manual]]'''
* Adding annotation information to a template
+
* [[Help:Maintenance]] summarizes maintenance tasks required by a Semantic MediaWiki instance
* Using a template to add information to a text
+
* [[SMW reference]]
* Using `Special:Browse` to display information after a template was used
+
* [[Sandbox tests|Try out SMW online]]
<div class="visualClear"></div>
+
* [[Help:Introduction to Semantic MediaWiki|Introduction to SMW]]
 
+
* [[FAQ|Frequently Asked Questions]]
== 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>
 
  
 
__NOTOC__
 
__NOTOC__

Latest revision as of 02:15, 7 January 2018

Getting started
Aims to provide an easy to follow introduction users unfamiliar with Semantic MediaWiki
Collection
Keywords
Table of Contents

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

For a more in-depth description about what SMW can do and where it can help, please read the following introductory text. If you are unsure about terms like Property, Subject, or RDF when reading material related to SMW then the following may help:

Additional tutorial examples include (which may require additional extensions):

Examples[edit]

  • TODO

"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.

Step-by-step-tutorial[edit]

See also[edit]