How to use

Properties are semantic annotations that allow a wiki to function as a collaborative database. You use them by adding properties to pages and then perform queries to retrieve them.

Adding property to pages

Go to the page and information you want to use the property for and use the following format:
[[propertyName::info]]
The :: indicate that you are referencing a property. You may use the | just like you would for renaming links to adjust the displayed name on the page.
Examples:

To reduce unnecessary duplication of properties only include the specific unit name for shards in the Has shards for property and only generalize "Shards" as the value for the property Store contains and Has reward. This will let us still search Store contains and Has reward for shards while letting use Has shards for as a global property to look everywhere for specific shards.

For further understanding and help with properties go to Semantic-MediaWiki.org

Getting property from pages

There are two common ways to get properties; ask and show.

• Ask will return a list of results that you can customize and choose fields for.
  • {{#ask: argument 1 | argument 2 | ?fields | options}}
    • {{#ask: = parser function
    • arguments = can be pages/categories to search or properties to search for
    • ?fields = properties, if any, to show
    • options = different ways to display the information
  • {{#ask: [[Category:Event]] [[Has release date::+]] |?Has release date=Release Date |mainlabel=Event |format=table |limit=5 }}

    • Event	Release Date
      Admiral's Maneuver	12 February 2020
      Aggressive Negotiations	2 May 2019
      Artist of War	15 June 2017
      Artist of War Mythic	14 April 2018
      Bespin Omega Battle	18 April 2016
      ... further results

• Show is best for inserting one result into a sentence or page.
  • {{#show: page/category |?property}}
    • {{#show: = parser function
      
    • page/category = page or category to find property on
    • ?property = property to get
  • E.G. The {{#show: Ground War |?Type of event}} Ground War was released on {{#show: Ground War |?Has release date}}.
    • The Assault Battles Ground War was released on 11 February 2017.

ASK Query options

Arguments - Selecting pages

Section in query to indicate which page, category, and/or property to get fields from. Official Semantic MediaWiki documentation.

• Pages: [[Ground War]]
• Category: [[Category:Assault Battle]]
• Property: There are several options to use when searching for properties.
  • Pages with specific property: [[Has shards for::Count Dooku]]
  • Pages that contain property tag: [[Has shards for::+]]
  • Pages that meet property criteria: [[Has release date::>January 1 2019]][[Has release date::<December 31 2019]]
    • Comparators
      • > = Greater than or equal
      • < = Less than or equal
      • >> = Greater than
      • << = Less than
      • ! = not
      • ~ = like
      • ? = Wildcard - Single character
      • * = Wildcard - Any sequence of characters
      • \ = Mask syntax characters (\\ \* \?)
        • Like example: [[Has name::~*Revan]]

Fields - Information to display

Section to indicate the properties you want to show in the printout of the data. ? has to be at the beginning of it and all fields must be separated with a pipe |. Official Semantic MediaWiki documentation.

• Add field and use property name for header: |?Has release date
• Add field and designate header name: |?Has release date=Release Date
• Add field not based on property values |?Category:Assault Battle # ifTrue, ifFalse =changeHeader
  • |?Category:Attacker # Yes, No
• Other options
  • # = Display as plain text (|?Has release date #)
  • #-n = Display just number
  • #-u = Display just unit if on a measurement property
  • Date Options
    • #ISO
    • #MEDIAWIKI
    • #LOCL
    • #-F[d-m-y]

Options - Formatting results

Options are used to organize and format the results. THey are separated with a pipe | and must have an = sign after them. Official Semantic MediaWiki documentation for parameters. Official Semantic MediaWiki documentation for format parameter options.

• limit = Maximum number of results to show, can use with searchlabel
  • |limit=10
• offset = Where to start selecting results if not the first.
  • |offset=2
• sort = Property name(s) separated by , to use for sorting. Blank is used for main result column
  • |sort=Has name, Has release date
• order = Defines how results should be ordered. Ascending is default.
  • asc or ascending
  • desc or descending
  • rand or random
  • reverse
    • |order=asc
• headers = How headers should be displayed. Show is default
  • show = with links
  • plain = as plain text
  • hide = no headers
    • |headers=plain
• mainlabel = Title of the first column containing page titles.
  • |mainlabel= Sets the main column header
  • |mainlabel=- Gets rid of the field completely
• index = Defines which value within a record should be displayed. Only used for properties of type Record.
  • |index=2
• link = Defines which article names in the result are hyperlinked.
  • none
  • subject
  • all
    • |link=all
• default = Sets what will be printed if no results are found.
  • |default= No results were found
• intro = Text that goes before the results
• outro = Text that goes after the reults
• searchlabel = Sets label used with limit. Default is ...further results.
• format = Sets the format the results will be in. Default is table.
  • broadtable = Outputs results in a broad table
  • table = Outputs results in a table
  • count = Just returns the number of results found
  • list = Outputs results in a comma separated list. Induces class attributes for styling.
  • ol = Outputs results as a numbered list.
  • ul = Outputs results as a bulleted list.
  • embedded = Embeds selected articles
  • category = Outputs results in columns with first letters as section headers in the style of category pages.
  • plainlist = Same as list but does not provide class attributes for styling.
  • debug = Outputs debugging information for analyzing problems in query answers.
  • Export Formats
    • csv
    • json
    • feed
    • rdf
    • dsv

Where to use

The following properties are used for characters:

The following properties are used for ships:

The following properties are used for events:

The following properties are used for everything categorized in Holotable:

The following properties are used for shipments:

• Has shards for
• Store contains

The following properties are used for Status Effects:

• Is a buff
• Is a debuff
• Is an other status
• Is exclusive to
• Is dispellable (Text)
• Is preventable (Text)
• Is resistable (Text)
• Is copyable (Text)
• Has name (Text)
• Has description (Text)

The following properties are used for Guides:

• Name of guide

Special Uses

Type of content

This property is used to search multiple categories or content without having to create new categories to hold them in. Grouping content together like this will create fewer queries.

::Battles is used to group

• Cantina Battles
• Fleet Battles
• Dark Side Battles
• Light Side Battles
• Mod Battles

::Exclusive event unit is used to group

• Raids
• Territory Battles
• Legendary Events
• Ancient Journey
• Hero's Journey
• Epic Confrontations
• Fleet Mastery
• Advanced Fleet Mastery

::Standard event is used to group

• Assault Battles
• Resource Events
• Special Events
• Heroic Battles
• Omega Battles
• Territory War

::Game Mode is used to group

• Light Side Battles
• Dark Side Battles
• Cantina Battles
• Fleet Battles
• Mod Battles
• Squad Arena
• Fleet Arena
• Galactic War

::Challenges is used to group

• Challenges
• Fleet Challenges
• Mod Challenges

::Journey Guide Coming Soon is used to group

• Any event that is qualified to be added to the Journey Guide but has not been out long enough to be added to it yet.

::Store is used to group

::Shipment is used to group

::Shop is used to group