Difference between revisions of "Template:Fasti Ecclesiae Anglicanae/doc"

From blackwiki
Jump to navigation Jump to search
imported>PBS
(fettle the wording slightly)
imported>PBS
(update the documentation remove "startpage" and "endpage" start to use standard parameters "page" and "pages")
Line 10: Line 10:
 
                                       or 1300–1541;  
 
                                       or 1300–1541;  
 
                                       or 1541–1857.  
 
                                       or 1541–1857.  
                                       Years must be separated with  with en-dashes ''not'' hyphens!
+
                                       Years must be separated with  with an [[ndashe]] (–) ''not'' [[hyphen]] (-).
  '''volum'''e=''number'' — For 1066–1300, volume numbers are 1 to 9.  
+
  '''volume'''=''number'' — For 1066–1300, volume numbers are 1 to 9.  
 
                     For 1300–1541, volume numbers are 1 to 12.  
 
                     For 1300–1541, volume numbers are 1 to 12.  
 
                     For 1541–1857, volume numbers are 1 to 11.
 
                     For 1541–1857, volume numbers are 1 to 11.
  '''startpage'''=''number'' — (or sole page). This must match the start of a section
+
  '''page'''=''number'' — (for a sole page). This must match the start of a section
 
                                       (as it is used as part of the [[url]]).
 
                                       (as it is used as part of the [[url]]).
   
+
  '''pages'''=''number''–''number'' — this is an alternative to page if there is more than one page (see [[help:CS1]]).
 +
                                    Then page numbers must be numeric and must not have a comma to delineate 1,000
 +
                                    The range should be indicated by a ndash (–) not a hyphen (-)
 +
 
 
;All the other parameters are optional:
 
;All the other parameters are optional:
endpage=''number''
 
 
  pagelink=yes — omit "p" from start – for when the url ends in "59a" or similar.
 
  pagelink=yes — omit "p" from start – for when the url ends in "59a" or similar.
  
Line 35: Line 37:
 
  display-editors=''number or etal — see [[help:CS1]].
 
  display-editors=''number or etal — see [[help:CS1]].
  
  date=''set by default'' — set by period and volume. It can be overwritten with another value.
+
  date=''set by default'' — set by period and volume. It can be overwritten with another value.  
                          See [[help:CS1]].
+
                          See [[help:CS1]].
page=''set by default  — set by the values of startpage and no endpage. Can not be overwritten.
 
pages=''set by default — set by the values of startpage and endpage. Can not be overwritten.
 
 
 
  ref=''harv'' — set by default affected by mode parameter.  
 
  ref=''harv'' — set by default affected by mode parameter.  
 
                 Can be overwritten. See [[help:CS2]] and [[help:CS1]].
 
                 Can be overwritten. See [[help:CS2]] and [[help:CS1]].

Revision as of 16:40, 13 May 2017

Fasti Ecclesiae Anglicanae, or a calendar of the principal ecclesiastical dignitaries in England and Wales, and of the chief officers in the Universities of Oxford and Cambridge... as archived at British History Online

Usage

These three parameters must be present

The following three parameters must be present. If they are not, then an error message is generated. They must be correct or the url will be incorrect:

period=one of three date ranges —   1066–1300; 
                                     or 1300–1541; 
                                     or 1541–1857. 
                                     Years must be separated with  with  an ndashe (–) not hyphen (-).
volume=number — For 1066–1300, volume numbers are 1 to 9. 
                    For 1300–1541, volume numbers are 1 to 12. 
                    For 1541–1857, volume numbers are 1 to 11.
page=number — (for a sole page). This must match the start of a section
                                      (as it is used as part of the url).
pages=numbernumber — this is an alternative to page if there is more than one page (see help:CS1).
                                    Then page numbers must be numeric and must not have a comma to delineate 1,000
                                    The range should be indicated by a ndash (–) not a hyphen (-)
All the other parameters are optional
pagelink=yes — omit "p" from start – for when the url ends in "59a" or similar.

Standard optional parameters:

author=name — see help:CS1.
authors=names — see help:CS1.
first=forename — see help:CS1. Currently restricted to 4 (first4=).
last=surname — see help:CS1. Currently restricted to 4 (last4=).
author-link=Wikipedia article – see help:CS1. Currently restricted to 4 (author4-link=).
display-authors=number or etal – see help:CS1.
editor-first=forename — see help:CS1. Currently restricted to 2 (editor2-first=).
editor-last=surname — see help:CS1. Currently restricted to 2 (editor2-last=).
editor-link=Wikipedia article — see help:CS1. Currently restricted to 2 (editor2-link=).
display-editors=number or etal — see help:CS1.
date=set by default — set by period and volume. It can be overwritten with another value. 
                          See help:CS1.
ref=harv — set by default affected by mode parameter. 
               Can be overwritten. See help:CS2 and help:CS1.
mode=cs2 — set by default, but can be overwritten.
                See help:CS2 and help:CS2.
postscrip=none — set to none (no character), 
                      affected by mode parameter and can be overwritten. 
                      See help:CS2 and help:CS1.
quote= — not set see help:CS1.