Difference between revisions of "Pathfinder Wiki:API/Database/Layout - Honor Variants"

Revision as of 16:37, 23 September 2022

This table will holds all the information about honor variants

Template to save the data

The template that saves all of the information about variants into the database, is the HonorLanding template. This template is being used on each landing page of the honor to display the information and to enable the navigation to the subpages and all the variants.

Example

Layout details

Column description

In this part the columns of the honor variants table are described in detail.

landingID (Integer - mandatory)

The ID of the honor the variant belongs to.

type (String - mandatory & allowed values)

Defines if the variant is an answer- or a requirement-variant.

Allowed values:

answer_variants
requirement_variants

number (Integer - mandatory)

The arguments that define a variant of an honor are being enumerated starting with 1, it is used inside the pagenames too. This number need's to be stored, so that the variant's are able to retrieve needed information by their number.

authority (String - mandatory)

The short name of the authority that released the requirements that are being used by the answer-variant or being defined by the requirement-variant.

Maybe we should rename the requirement_n argument of the HonorLanding Template and use the authority argument instead by adding a number to it, where no number-suffix and _1-suffix means the same.

countries (String)

Semicolon separated list of the countries that the answer-variant is relevant too.

srcLanguage (String)

ONLY USED BY ANSWER-VARIANTS Some answers are only relevant to some countries. For example in the Postcards honor the answers will differ from country to country. Those answers are also mostly only relevant for those countries, that is why it is possible to define a source language for answer variants. That way the answers don't need to be written in english and then be translated back to the needed language. Requirements should always be available in English. That is why we decided to not implement the source language for them.

The value in this cell has to be a language code defined on this list. Default is english (en).

@@ Line 17: / Line 17: @@
 The ID of the honor the variant belongs to.
-===type (String - allowed values)===
+===type (String - mandatory & allowed values)===
 Defines if the variant is an answer- or a requirement-variant.
@@ Line 24: / Line 24: @@
 * requirement_variants
-===authority (String)===
+===number (Integer - mandatory)===
+The arguments that define a variant of an honor are being enumerated starting with 1, it is used inside the [[Pathfinder Wiki:Structure|pagenames]] too. This number need's to be stored, so that the variant's are able to retrieve needed information by their number.
+===authority (String - mandatory)===
 The short name of the authority that released the requirements that are being used by the answer-variant or being defined by the requirement-variant.
+'''Maybe we should rename the <code>requirement_n argument</code> of the [[Template:HonorLanding|HonorLanding Template]] and use the authority argument instead by adding a number to it, where no number-suffix and <code>_1</code>-suffix means the same.'''
 ===countries (String)===
@@ Line 34: / Line 39: @@
 Requirements should always be available in English. That is why we decided to not implement the source language for them.
-The value in this cell has to be a language code defined on [https://meta.wikimedia.org/wiki/Template:List_of_language_names_ordered_by_code this list].
+The value in this cell has to be a language code defined on [https://meta.wikimedia.org/wiki/Template:List_of_language_names_ordered_by_code this list]. Default is english (en).