Template:Faction/Doc

The UESPWiki – Your source for The Elder Scrolls since 1995

 ###########
 # Faction #
 ######################################################################
 # This template makes it easier to link NPCs to their faction pages. #
 # Usage:                                                             #
 #    faction = Faction to which to link. *                           #
 #    rank    = rank of NPC within the faction. **                    #
 #    altname = Value to display in the link to the faction           #
 #    namesp  = Alternate namespace for the faction pages if the      #
 #              default is not to be used.  The rank category is      #
 #              omitted in this case.                                 #
 #    nocat   = set to yes to not add category (for example, within   #
 #              tables of NPCs)                                       #
 #    catname = Name to use in the categories used to group the       #
 #              members of the faction.                               #
 #            * The name "faction" is not necessary if used as the    #
 #              first parameter.                                      #
 #           ** The name "rank" is not necessary if used as the       #
 #              second parameter.                                     #
 #                                                                    #
 # The template makes three assumptions:                              #
 #  1) There exists a "faction" page in the specified namespace.      #
 #     (the current one if none is specified)  If there is not, the   #
 #     template will instead look for the Factions_x page in the      #
 #     specified namespace where x is the initial letter of the       #
 #     faction name (eg, Factions_M for Mages Guild).                 #
 #  2) The faction you specify is present on the relevant page        #
 #     exactly as specified - eg if the faction is called "Joe's      #
 #     Faction", you must specify "Joe's Faction" as the name.        #
 #  3) If the rank is used, there exists a page called "Rank" as a    #
 #     subpage of faction (eg Oblivion:Mages Guild/Rank). This page   #
 #     determines how the rank parameter is interpreted.              #
 #                                                                    #
 # Examples:                                                          #
 #   {{Faction|Mages Guild|rank=Evoker}}                              #
 #   {{Faction|faction=Mages Guild|rank=Evoker}}                      #
 #   {{Faction|Fighters Guild|rank=0|namesp=Oblivion}}                #
 #   {{Faction|Mages Guild|Evoker|altname=Guild for Mages}}           #
 #                                                                    #
 # Most of the real "work" in the template is done by the             #
 # [[Template:Faction/Code]] subtemplate.  This split allows parameter#
 # values to be checked and set to alternate/default values just once,#
 # reducing the size of the code by a few characters.  Hopefully this #
 # will improve a few pages that use this template hundreds of times. #
 ######################################################################