Difference between revisions of "Semantic wiki formatting"

From HCE Wiki - The Human Cognitive Enhancement Wiki
Jump to navigation Jump to search
m (removed sortable css class from the table)
 
(12 intermediate revisions by 2 users not shown)
Line 1: Line 1:
This guide lists and describes all Semantic Wiki categories used on this site. We differentiate between Semantic annotations based on the type of the device or technology they are used to describe.
+
This guide lists and describes all semantic wiki categories used on this site. We differentiate between semantic annotations based on the type of the device or technology they are describing.
  
== Smartglasses and Virtual Reality Devices ==
+
Semantic wiki properties are almost exclusively used in [[Infobox_(HMDs)|Infoboxes]] but they can also be used throughout the text of the article. For an in-depth guide on semantic properties and semantic wiki in general, please see the [https://www.semantic-mediawiki.org/wiki/Help:User_manual Semantic Wiki User Manual].
  
This is a list of properties used on pages categorized as [[Smartglasses]] or [[Virtual Reality Devices]].
+
== Head Mounted Displays Category Semantic Properties ==
 +
 
 +
This is a list of properties used on pages categorised as [[Smartglasses]], [[Virtual Reality Devices]], [[Electrolarynx]], [[Intelligent Personal Assistants]], and [[Brain Stimulation]].
  
 
{| class="wikitable"
 
{| class="wikitable"
 
|-
 
|-
! Property name !! Property value (example value)  
+
! Property Name !! Property Value (example value)  
 +
|-
 +
| [[Property:Announced in|Announced in]] || The date when the device was announced, (e.g., 9 September 2013).
 +
|-
 +
| [[Property:Controls are|Controls are]] || Available means of controlling the device, (e.g., inertial, peripherals, positional tracking).
 
|-
 
|-
| [[Property:Announced in|Announced in]] || The date when the device was announced. (e.g. 9 September 2013)
+
| [[Property:Costs|Costs]] || The cost of the device in USD (e.g., 400). For this value, use only the number. The USD part will be added automatically.
 
|-
 
|-
| [[Property:Controls are|Controls are]] || Available means of controlling the device. (e.g. inertial, peripherals, positional tracking)
+
| [[Property:Developed by|Developed by]] || The developer and/or manufacturer of the device, (e.g., Oculus VR, Facebook, Inc.).
 
|-
 
|-
| [[Property:Costs|Costs]] || The cost of the device in USD. (e.g. 400). For this value, use only the number. The USD part will be added automatically.
+
| [[Property:Has resolution of|Has resolution of]] || The resolution of the device's display in pixels. Combined resolution in case of binocular displays. The ending 'pixels' will be added automatically, (e.g., 2560x1440).
 
|-
 
|-
| [[Property:Developed by|Developed by]] || The developer or/and manufacturer of the device. (e.g. Oculus VR, Facebook, Inc.)
+
| [[Property:Is categorized as|Is categorized as]] || The type of technology we categorize the device as, (e.g., Smartglasses).
 
|-
 
|-
| [[Property:Has resolution of|Has resolution of]] || The resolution of the device's display in pixels. Combined resolution in case of binocular displays. The ending 'pixels' will be added automatically. (e.g. 2560x1440)
+
| [[Property:Operating system is|Operating system is]] || The operating system the device is using or can be used with, (e.g., Microsoft Windows).
 
|-
 
|-
| [[Property:Is categorized as|Is categorized as]] || The type of technology we categorize the device as. (e.g. Smartglasses)
+
| [[Property:Released for consumers|Released for consumers]] || The date the device was released to general consumers. Can be used to indicate a rumoured or announced future release date, (e.g., January 2016).
 
|-
 
|-
| [[Property:Operating system is|Operating system is]] || The operating system the device is using or can be used with. (e.g. Microsoft Windows)
+
| [[Property:Released for developers in|Released for developers in]] || The date the device was made available for developers but has not entered the general market yet. May indicate possible developer release in the future, (e.g. May 2015).
 
|-
 
|-
| [[Property:Released for consumers|Released for consumers]] || The date the device was released to general consumers. Can be used to indicate a rumoured or announced future release date. (e.g. January 2016)
+
| [[Property:Weights|Weights]] || The weight of the device in grams. The unit 'g' will be added automatically, (e.g., 400).
 
|-
 
|-
| [[Property:Released for developers in|Released for developers in]] || The date the device was made available for developers but it has not entered the general market yet. May indicate possible developer release in the future. (e.g. May 2015)
+
| [[Property:Maximal output is|Maximal output is]] || The maximum possible electric current or magnetic field strength. The unit (mA/T) should be added, (e.g., 2 mA).
 
|-
 
|-
| [[Property:Weights|Weights]] || The weight of the device in grams. The unit 'g' will be added automatically. (400)
+
| [[Property:Maximal session duration is|Maximal session duration is]] || The maximum possible duration of one session. The unit 's' should be added, (e.g., 30s).
 +
|-
 +
| [[Property:Scalp location is|Scalp location is]] || The position of the electrodes on the scalp, (e.g., C3).
 +
|-
 +
| [[Property:Needs medical prescription|Needs medical prescription]] || It indicates if the medical prescription is needed, (yes or no).
 
|}
 
|}
  
Click on any property to learn more about it's semantic Type and usage.
+
Click on any property to learn more about its semantic Type and usage.
 +
 
 +
== How to Use Semantic Annotations in Text ==
 +
 
 +
While the creation of new semantic properties is not forbidden, it is highly discouraged to do so without discussing it first with other authors and administrators in order to avoid creating too much of the same semantic categories that serve no real purpose other than to confuse anyone who would want to browse the wiki. If you have an idea to create a new semantic category, please discuss it first!
 +
 
 +
To use a semantic property in the text outside of the infobox, you type <code><nowiki>[[property_name::value]]</nowiki></code> anywhere you want to assign a property to the <code>value</code>. For example, you are writing about the history of a virtual reality device. You want to semantically indicate that the year the device was first manufactured was 2015. You take a look at the raw text, find the number of the year, and from just <code>2015</code> you change it to <code><nowiki>[[Manufactured in::2015]]</nowiki></code>. The text will remain the same, but you successfully assigned the year 2015 a semantic property, and the device is now searchable by the year it was manufactured in.
 +
 
 +
When you are creating a new semantic property, try to make it form a sentence. This is the strength of the semantic search, because you can now search and filter properties by using natural language. Using the above example, you should type <code>Manufactured in:</code> instead of something like <code>Manufacture date:</code>.
 +
 
 +
== Dealing with Multiple Values ==
 +
 
 +
When using semantic properties, be it in the infoboxes or the body of the article itself, you will inevitably encounter a problem: what to do when I have multiple values of the same property? Thankfully, the solution is not complicated. Consider the following case example. You are writing about a device that features three sensors: accelerometer, thermometer, and barometer. You want all three categories to be recognised by the semantic wiki. The correct way is to use the property <code>Has sensors</code> multiple times! Compare the two lines below:
 +
 
 +
<div style="background-color: #FFCCCC; border: 1px solid #FFB2B2; padding: 10px; margin-bottom: 1em;">'''The wrong way:''' <code><nowiki>[[Has sensors::accelerometer, thermometer, barometer]]</nowiki></code>. This will not work correctly because the system will consider this to be just one sensor that is called accelerometer, thermometer, barometer.</div>
 +
 
 +
<div style="background-color: #E9FFE6; border: 1px solid #CEF2E0; padding: 10px;">'''The correct way:''' <code><nowiki>[[Has sensors::accelerometer]], [[Has sensors::thermometer]], [[Has sensors::barometer]]</nowiki></code>. This time around we used the property <code>Has sensors</code> multiple times, individually for each of the sensors. The wiki will now understand that the device you are writing about features three different sensors. Also, notice how the <code>,</code> is outside the semantic wiki tags. This is so the semantic values have only the name of the sensor but not the comma between them, as the comma is not an actual part of the name.</div>
 +
 
 +
As you can see, you can use all of the properties multiple times without any problems; but, before you do so, think about whether making multiple properties like this one actually makes sense. Making multiple properties for multiple different sensors is logical and encouraged, but creating four different properties for the announcement date is nonsensical because there can be only one announcement date (unless there are some very special circumstances which should be explicitly mentioned in the article).
  
 
[[Category:Guides]]
 
[[Category:Guides]]

Latest revision as of 14:28, 13 June 2017

This guide lists and describes all semantic wiki categories used on this site. We differentiate between semantic annotations based on the type of the device or technology they are describing.

Semantic wiki properties are almost exclusively used in Infoboxes but they can also be used throughout the text of the article. For an in-depth guide on semantic properties and semantic wiki in general, please see the Semantic Wiki User Manual.

Head Mounted Displays Category Semantic Properties

This is a list of properties used on pages categorised as Smartglasses, Virtual Reality Devices, Electrolarynx, Intelligent Personal Assistants, and Brain Stimulation.

Property Name Property Value (example value)
Announced in The date when the device was announced, (e.g., 9 September 2013).
Controls are Available means of controlling the device, (e.g., inertial, peripherals, positional tracking).
Costs The cost of the device in USD (e.g., 400). For this value, use only the number. The USD part will be added automatically.
Developed by The developer and/or manufacturer of the device, (e.g., Oculus VR, Facebook, Inc.).
Has resolution of The resolution of the device's display in pixels. Combined resolution in case of binocular displays. The ending 'pixels' will be added automatically, (e.g., 2560x1440).
Is categorized as The type of technology we categorize the device as, (e.g., Smartglasses).
Operating system is The operating system the device is using or can be used with, (e.g., Microsoft Windows).
Released for consumers The date the device was released to general consumers. Can be used to indicate a rumoured or announced future release date, (e.g., January 2016).
Released for developers in The date the device was made available for developers but has not entered the general market yet. May indicate possible developer release in the future, (e.g. May 2015).
Weights The weight of the device in grams. The unit 'g' will be added automatically, (e.g., 400).
Maximal output is The maximum possible electric current or magnetic field strength. The unit (mA/T) should be added, (e.g., 2 mA).
Maximal session duration is The maximum possible duration of one session. The unit 's' should be added, (e.g., 30s).
Scalp location is The position of the electrodes on the scalp, (e.g., C3).
Needs medical prescription It indicates if the medical prescription is needed, (yes or no).

Click on any property to learn more about its semantic Type and usage.

How to Use Semantic Annotations in Text

While the creation of new semantic properties is not forbidden, it is highly discouraged to do so without discussing it first with other authors and administrators in order to avoid creating too much of the same semantic categories that serve no real purpose other than to confuse anyone who would want to browse the wiki. If you have an idea to create a new semantic category, please discuss it first!

To use a semantic property in the text outside of the infobox, you type [[property_name::value]] anywhere you want to assign a property to the value. For example, you are writing about the history of a virtual reality device. You want to semantically indicate that the year the device was first manufactured was 2015. You take a look at the raw text, find the number of the year, and from just 2015 you change it to [[Manufactured in::2015]]. The text will remain the same, but you successfully assigned the year 2015 a semantic property, and the device is now searchable by the year it was manufactured in.

When you are creating a new semantic property, try to make it form a sentence. This is the strength of the semantic search, because you can now search and filter properties by using natural language. Using the above example, you should type Manufactured in: instead of something like Manufacture date:.

Dealing with Multiple Values

When using semantic properties, be it in the infoboxes or the body of the article itself, you will inevitably encounter a problem: what to do when I have multiple values of the same property? Thankfully, the solution is not complicated. Consider the following case example. You are writing about a device that features three sensors: accelerometer, thermometer, and barometer. You want all three categories to be recognised by the semantic wiki. The correct way is to use the property Has sensors multiple times! Compare the two lines below:

The wrong way: [[Has sensors::accelerometer, thermometer, barometer]]. This will not work correctly because the system will consider this to be just one sensor that is called accelerometer, thermometer, barometer.
The correct way: [[Has sensors::accelerometer]], [[Has sensors::thermometer]], [[Has sensors::barometer]]. This time around we used the property Has sensors multiple times, individually for each of the sensors. The wiki will now understand that the device you are writing about features three different sensors. Also, notice how the , is outside the semantic wiki tags. This is so the semantic values have only the name of the sensor but not the comma between them, as the comma is not an actual part of the name.

As you can see, you can use all of the properties multiple times without any problems; but, before you do so, think about whether making multiple properties like this one actually makes sense. Making multiple properties for multiple different sensors is logical and encouraged, but creating four different properties for the announcement date is nonsensical because there can be only one announcement date (unless there are some very special circumstances which should be explicitly mentioned in the article).