Template:Index: Difference between revisions

From Greyhawk Wiki
Jump to navigation Jump to search
Ari5av (talk | contribs)
Add an optional argument called exact, which if nonempty restricts the topic to the exact title rather than all topics which contain the title
Ari5av (talk | contribs)
Documenting the exact=1 argument
Line 53: Line 53:
| Battle of Karndred's Meadows || <code><nowiki>{{index|title=Karndred%' AND Topic LIKE '%Meadow}}</nowiki></code>
| Battle of Karndred's Meadows || <code><nowiki>{{index|title=Karndred%' AND Topic LIKE '%Meadow}}</nowiki></code>


|}</noinclude><includeonly><h3>Encyclopedia Greyhawkania Index</h3>
|}
 
=== Exact results only ===
If you wish to show only exact title results, omitting entries ''containing'' the title, add the <code>|exact=1</code> argument, as in <code><nowiki>{{index|title=Barrier Peaks|exact=1}}</nowiki></code>.  This example would return only entries where the title is exactly "Barrier Peaks", instead of also including other miscellaneous entries containing that phrase.
 
</noinclude><includeonly><h3>Encyclopedia Greyhawkania Index</h3>
The Index is based on previous work of Jason Zavoda through '08, and his work as continued and updated by Eric Johnson, [[Richard DiIoia]], [[User:PupickDad|Jason "PupickDad" Jacobson]], a French fan group, and numerous other fans over the years.  The wiki page for the [[Encyclopedia Greyhawkania Index|EGI]] has a list of sources, full product names, abbreviations, and a link to the full, downloadable index.  
The Index is based on previous work of Jason Zavoda through '08, and his work as continued and updated by Eric Johnson, [[Richard DiIoia]], [[User:PupickDad|Jason "PupickDad" Jacobson]], a French fan group, and numerous other fans over the years.  The wiki page for the [[Encyclopedia Greyhawkania Index|EGI]] has a list of sources, full product names, abbreviations, and a link to the full, downloadable index.  
{{#get_db_data:  
{{#get_db_data:  

Revision as of 00:03, 17 July 2024

About this template

This template should be included at the bottom of all pages, in the "References" after the last line of the bibliography. It will automatically generate a table including data from the Encyclopedia Grehawkania Index based upon the title (Topic) of the page on which it is included.

If there are no entries currently in the EGIndex database for the Topic, a blank table with no entries will be displayed, similar to that shown below at the end of this page.

If you find a page with a blank table with data missing in the table, information from officially published sources can be added to the EGI to produce new lines on the table. Preview the Types and full Product names in the Encyclopedia Greyhawkania Index in order to keep entries uniform.

Please visit the Edit Encyclopedia Index page to contribute to the wiki database.

Usage

Full References Section

This template is typically included in the "References" section of most pages. It is usually placed after all other References, so that it populates at the bottom of the page.
Other than when the Index entry needs special function to include or exclude other words in its database search, it usually looks like this:

==References==
===Citations===
<references />
===Bibliography===
{{index}}

[[Categories:INSERT CATEGORY NAME]]

When included by itself, the template should typically be added as the last line under the '''Bibliography''' heading near the end of a wiki page, just above categories. This usage is simply:

{{index}}

Errors

If there are syntax errors due to the Encyclopedia Greyhawkania Index listing the Topic in an unusual way (e.g. "Magical Arts, University of"), the title should be altered to get proper EGI results. This method can also be used to include results relating to the Topic if other Topics include the same word; e.g. using Thrommel instead of Thrommel IV will give results including all the rulers named Thrommel.

{{index|title=}}

Errors may also result from punctuation or unusual characters in the Topic's name. This template can be used to eliminate these errors on pages with titles such as "Kuroth's Quill" or "Johydee's Mask". Use only the words of the Topic, without the unusual punctuation.

{{index|title=TOPICWORD%' AND Topic LIKE '%ANOTHERWORD}}

Examples

Page Name Code Example
Thrommel IV {{index|title=Thrommel}}
Brother Milerjoi {{index|title=Milerjoi}}
Royal Guild of Navigators {{index|title=Navigators, Royal Guild of}}
Knights of Holy Shielding {{index|title=Holy Shielding, Knights of}} or just {{index|title=Holy Shielding}}
Dar-Kesh-Anam {{index|title=Dar%' AND Topic LIKE '%Anam}}
Kuroth's Quill {{index|title=Kuroth%' AND Topic LIKE '%Quill}}
Johydee's Mask {{index|title=Johydee%' AND Topic LIKE '%Mask}}
Battle of Karndred's Meadows {{index|title=Karndred%' AND Topic LIKE '%Meadow}}

Exact results only

If you wish to show only exact title results, omitting entries containing the title, add the |exact=1 argument, as in {{index|title=Barrier Peaks|exact=1}}. This example would return only entries where the title is exactly "Barrier Peaks", instead of also including other miscellaneous entries containing that phrase.