Pathfinder Wiki:API/Database/Layout - Honors

From Pathfinder Wiki

This table will hold all the basic information about an honor.

Template to save the data

The template that will save all of the information about an honor into the database, will be the Template:HonorLanding. This template is being used on each landing page of the honor to display the information and to enable the navigation to the subpages.

Example

Layout details

Column description

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

_pageID (unique)

Each page in the wiki get's a unique ID from mediawiki. That is the pageID of the landing page of the honor. We'll be using this ID to identify the honor in all the other tables, like for example the Honor Requirements Table. It is being filled in automatically by the cargo_store call, because the template is being called on the landing page.

honorname (String - unique & mandatory)

The honorname in english. It is being used to the get the translated honorname out of the localization tables.

category (String)

The category the honor belongs to. This string is also in english and will be used to translate it.

year (Integer)

The year in which the honor was released first. How do we handle that with variants?

authority (String)

The authority that released an honor. How do we handle that with variants?

skill (Integer)

The skill level an honor has. It is a number between 1 and 3. If there is no skill level defined for an honor, the cell can be left empty. How do we handle that with variants?

insignia (File?)

The image of the page for the honor. The question is if we need to store the whole path or if it would be better to only store the file name because of translation purposes? How do we handle that with variants?

field_trip (String - allowed values)

Defines if a field trip is needed to achieve this honor. If no field trip is necessary the field should be empty. How do we handle that with variants?

Allowed values:

  • required
  • optional

instructor (String - allowed values)

Defines if a instructor is needed to achieve this honor. If no instructor is necessary the field should be empty. How do we handle that with variants?

Allowed values:

  • licensed
  • certified
  • skilled
  • qualified

complete_course (Boolean)

Defines if a course is needed to achieve this honor.

state (String - allowed values)

A honor can be in different states of development and due to that show up in different lists. In this field the state of an honor is being stored.

Allowed values:

  • piloting
  • released

pilotAuthor (String)

The wiki username of the Author of the honor that is being piloted. It is being used to display a contact button on the wiki, so clubs that want to get in contact with the author to get a page or something similar are able to do so.

has_variants (string - allowed values)

As there can be several variants the information about the variants will be stored in a separate table. That is why we only store if there are any variants or not. That way it is possible to reduce the amount of needed queries, because then we only need to query the variants if there are some.

Allowed values:

  • no
  • answer_variants
  • requirement_variants
  • both