Module:SST/shards/G
| This module is rated as alpha. It is ready for limited use and third-party feedback. It may be used on a small number of pages, but should be monitored closely. Suggestions for new features or adjustments to input and output are welcome. |
- Note: This is part of the WP:SSTS system see that page for complete documentation
This page contains the data configurations for Module:SST ("Single-source templates") for all book keys starting with the letter "G".
Create a new shard entry
[edit]All book metadata is stored in "shards" which are Lua Modules that contain simple tables.
There are two types of shards:
- Single - A single book. They share shard files. For example, all single books that start with "A" are in Module:SST/shards/A
- Sets - Works that have multiple volumes or editions e.g. an Encyclopedia or a 3-edition book. Each one has their own private shard file stored in
Module:SST/shards/setsfor example Module:SST/shards/sets/THE_CAMBRIDGE_HISTORY_OF_IRAN.
To add a new book, navigate to the correct shard and add a new table. The template documentation page will show where the shard is located.
Naming the book key
[edit]When creating a new table, use a unique, recognizable book key in ALL CAPS, with spaces converted to underscores. For single shards it must start with the letter of the shard it is placed in. Generally a good idea to start with the author's last name then a short version of the title.
- Example:
library['IMBER_THE_OTTOMAN_EMPIRE'] = { ... }
When creating a multi-edition or volume set of books, name each book followed by a number for volumes e.g. _1 and _2 .. or by a year of publication e.g. _1990 and _2002 for editions.
- BOWEN_THE_LIFE_AND_TIMES_OF_AL_IBN_ISA
- IMBER_THE_OTTOMAN_EMPIRE_2002
- IMBER_THE_OTTOMAN_EMPIRE_2009
- BYZANTINE_SEALS_1
- BYZANTINE_SEALS_2
Host
[edit]The |host= sets which digital library the citation will link to.
Example: Host
|
|---|
library['IMBER_THE_OTTOMAN_EMPIRE'] = {
['host'] = "ia",
['cite_params'] = {
.....
}
|
Valid values for |host= are "ia", "guten", "hathi", "wikisrc", "gbook", "web" and "physical" (not online). These map to a corresponding |id= in the |hosts= entry (see below). Improper values or lack of a host will default to "physical" (no external links).
If a |host= is changed (e.g. from "hathi" to "ia") this will impact the Leaf page designations for every template on Wikipedia. For example Hathi uses 42@s54 while IA uses 42@n34. A change of |host= is disruptive, causing URLs to land on the wrong page. Tools will be in development to make |host= changes easier by automating the update of templates. Until then, it is better to consider the host "locked".
Citation Parameters
[edit]- A table of CS1 parameters displayed by default. (Users can override these within the invoking templates.)
|_template=: Optional. Defaults tocite book, can also be set tocite encyclopedia(more template support in future).|last=,|first=,|quote=,|ref=, etc. = Standard CS1 parameters.
Example: Citation Parameters
|
|---|
['host'] = "ia",
['cite_params'] = {
['_template'] = 'cite book',
['last'] = "Birtchnell",
['first'] = "Percy Charles",
['author-link'] = "Percy Birtchnell",
['title'] = "A Short History of Berkhamsted",
['year'] = "1972",
['edition'] = "Revised",
['publisher'] = "Privately printed",
['place'] = "Berkhamsted",
['oclc'] = "737328"
},
|
Hosts
[edit]- A nested table defining where the book can be found online and how the routing engines should handle it. Supported host keys are
|ia=(Internet Archive),|hathi=(HathiTrust),|guten=(Project Gutenberg),|wikisrc=(Wikisource),|gbook=(Google Books),|web=(Other website), and|physical=(No digital host). You can add multiple hosts for each book, which one is used is defined by|host=(see above).
- A nested table defining where the book can be found online and how the routing engines should handle it. Supported host keys are
|id== The host-specific identifier.- IA: The ID from the URL. Multiple IDs for the same edition can be defined see Example setup.
- Hathi: The handle ID
- GBook: The 12-character ID
- Wikisource: The full Page namespace name, including extension
- Web: For a web host, omit id. See Example setup.
- Physical: A physical copy only - for books without a digital host. See Example setup.
Example: Host Configurations
|
|---|
['hosts'] = {
['ia'] = {
['id'] = "encyclopaediabrit01chisrich",
}
}
['hosts'] = {
['ia'] = {
['id'] = {
"nebraskaplacenam00fitz",
"nebraskaplacenam0000fitz"
}
}
}
['hosts'] = {
['hathi'] = {
['id'] = "iau.31858015245842",
}
}
['hosts'] = {
['gbook'] = {
['id'] = "-CNkywAACAAJ",
}
}
['hosts'] = {
['wikisrc'] = {
['id'] = "Page:The Fun of It.pdf",
}
}
['hosts'] = {
['web'] = {
['url'] = "http://www.uscoldwar.com/overview.htm",
}
}
['hosts'] = {
['physical'] = {}
}
|
- Internet Archive Options:
- query = (Internet Archive only). Optional. Use instead of `id` for multi-volume works. Links the main title to an IA search page. Page linking will output as unlinked plain text. (ex. `query = 'title:"Encyclopaedia Britannica" AND date:1911'`)
- iadisplay = "full screen" (Internet Archive only). Optional. Opens the book in full-screen mode instead of the default 2-up view.
- iasearch = "none" or "pagenum" (Internet Archive only). Optional. Set to "none" to disable the dummy search for PD books.
Example: Internet Archive Options
|
|---|
['hosts'] = {
['ia'] = {
['query'] = "title:Britannica AND year:1911",
}
}
['hosts'] = {
['ia'] = {
['id'] = "encyclopaediabrit01chisrich",
['iasearch'] = "none",
['iadisplay'] = "full screen"
}
}
|
Multiple IDs
[edit]Some hosts have multiple copies of the same book+edition. This can be useful to mitigate viewing limits. Many hosts only allow X number of views per day per book. By including multiple IDs, you can spread the load across multiple IDs. Because the template randomly chooses real-time, it is important each book be identical ie. published in the same year, same publisher, each open to the same page 42 etc.. How to add multiple identical books:
['hosts'] = {
['ia'] = {
['id'] = {
"nebraskaplacenam00fitz",
"nebraskaplacenam0000fitz"
}
}
}
Load sharing is not available across hosts (inter-host), only within hosts (intra-host).
local library = {}
-- Genoa and the Genoese, 958–1528 by University of North Carolina Press
-- Template:Genoa and the Genoese
library['GENOA_AND_THE_GENOESE'] = {
host = 'ia', -- WARNING: Changing host breaks page numbers in Wikipedia articles. See WP:SSTS#changehost
['cite_params'] = {
['_template'] = 'cite book',
['first'] = "Steven A.",
['last'] = "Epstein",
['author-link'] = "",
['title'] = "Genoa and the Genoese, 958–1528",
['year'] = "1996",
['publisher'] = "University of North Carolina Press",
['location'] = "Chapel Hill, N.C.",
['isbn'] = "978-0-8078-4992-7",
},
['hosts'] = {
['ia'] = {
['id'] = "epstein-genoa-and-the-genoese"
}
}
}
-- Ghost Towns of California by Pruett Publishing Company
-- Template:Ghost Towns of California
library['GHOST_TOWNS_OF_CALIFORNIA'] = {
host = 'ia', -- WARNING: Changing host breaks page numbers in Wikipedia articles. See WP:SSTS#changehost
['cite_params'] = {
['_template'] = 'cite book',
['last'] = "Miller",
['first'] = "Donald C.",
['title'] = "Ghost Towns of California",
['publisher'] = "Pruett Publishing Company",
['location'] = "Boulder, Colorado",
['date'] = "1978",
['isbn'] = "0871085178",
},
['hosts'] = {
['ia'] = {
['id'] = "ghosttownsofcali00mill"
}
}
}
-- Ghost Towns of Northern California: Your Guide to Ghost Towns & Historic Mining Camps by Voyageur Press
-- Template:Ghost Towns of Northern California
library['GHOST_TOWNS_OF_NORTHERN_CALIFORNIA'] = {
host = 'ia', -- WARNING: Changing host breaks page numbers in Wikipedia articles. See WP:SSTS#changehost
['cite_params'] = {
['_template'] = 'cite book',
['last'] = "Varney",
['first'] = "Philip",
['author2'] = "Drew, John and Susan",
['title'] = "Ghost Towns of Northern California: Your Guide to Ghost Towns & Historic Mining Camps",
['publisher'] = "Voyageur Press",
['location'] = "Stillwater, Minnesota",
['date'] = "2001",
['isbn'] = "0896584445",
},
['hosts'] = {
['ia'] = {
['id'] = "ghosttownsofnort0000varn"
}
}
}
-- A History of Palestine, 634–1099 by Cambridge University Press
-- Template:A History of Palestine, 634–1099
library['GIL_A_HISTORY_OF_PALESTINE'] = {
host = 'gbook', -- WARNING: Changing host breaks page numbers in Wikipedia articles. See WP:SSTS#changehost
['cite_params'] = {
['_template'] = 'cite book',
['title'] = "A History of Palestine, 634–1099",
['last'] = "Gil",
['first'] = "Moshe",
['author-link'] = "Moshe Gil",
['translator'] = "Ethel Broido",
['orig-date'] = "1983",
['year'] = "1997",
['isbn'] = "0-521-59984-9",
['location'] = "Cambridge",
['publisher'] = "Cambridge University Press",
},
['hosts'] = {
['gbook'] = {
['id'] = "M0wUKoMJeccC",
}
}
}
-- The Arab Conquests in Central Asia by The Royal Asiatic Society
-- Template:The Arab Conquests in Central Asia
library['GIBB_THE_ARAB_CONQUESTS_IN_CENTRAL_ASIA'] = {
host = 'ia', -- WARNING: Changing host breaks page numbers in Wikipedia articles. See WP:SSTS#changehost
['cite_params'] = {
['_template'] = 'cite book',
['title'] = "The Arab Conquests in Central Asia",
['first'] = "H. A. R.",
['last'] = "Gibb",
['author-link'] = "H. A. R. Gibb",
['location'] = "London",
['publisher'] = "[[Royal Asiatic Society of Great Britain and Ireland|The Royal Asiatic Society]]",
['year'] = "1923",
},
['hosts'] = {
['ia'] = {
['id'] = "arabconquestsinc00gibbuoft",
['iasearch'] = "none",
}
}
}
-- NSU: Fahrzeuge, Prototypen und Eigenbauten by Gerhard Geiling
-- Template:Geiling: NSU: Fahrzeuge
library['GEILING_NSU_FAHRZEUGE'] = {
['host'] = 'physical', -- WARNING: Changing host breaks page numbers in Wikipedia articles. See WP:SSTS#changehost
['cite_params'] = {
['_template'] = 'cite book',
['last'] = "Geiling",
['first'] = "Gerhard",
['year'] = "2009",
['title'] = "NSU: Fahrzeuge, Prototypen und Eigenbauten",
['trans-title'] = "NSU: Vehicles, Prototypes and Modifieds",
['location'] = "Eschborn, Germany",
['publisher'] = "Christian Rieck Verlag",
['isbn'] = "9783924043377",
['language'] = "de",
},
['hosts'] = {
['physical'] = {}
}
}
-- Das grosse Mercedes-SL-Buch by Dieter Günther ''et al.''
-- Template:Günther: Das grosse Mercedes-SL-Buch
library['GUNTHER_DAS_GROSSE_MERCEDES_SL_BUCH'] = {
['host'] = 'physical', -- WARNING: Changing host breaks page numbers in Wikipedia articles. See WP:SSTS#changehost
['cite_params'] = {
['_template'] = 'cite book',
['last1'] = "Günther",
['first1'] = "Dieter",
['last2'] = "Hübner",
['first2'] = "Johannes",
['year'] = "1990",
['title'] = "Das grosse Mercedes-SL-Buch",
['trans-title'] = "The Big Mercedes SL Book",
['location'] = "Königswinter, Germany",
['publisher'] = "Heel Verlag",
['isbn'] = "3-89365-218-3",
['language'] = "de",
['edition'] = "2nd",
},
['hosts'] = {
['physical'] = {}
}
}
-- Pacific Graveyard by Jim Gibbs
-- Template:Gibbs: Pacific Graveyard
library['GIBBS_PACIFIC_GRAVEYARD'] = {
['host'] = 'ia', -- WARNING: Changing host breaks page numbers in Wikipedia articles. See WP:SSTS#changehost
['cite_params'] = {
['_template'] = 'cite book',
['last1'] = "Gibbs",
['first1'] = "Jim",
['author1-link'] = "James A. Gibbs",
['title'] = "Pacific Graveyard",
['location'] = "Portland, Oregon",
['publisher'] = "[[Binford & Mort]]",
['year'] = "1992",
['orig-year'] = "1950",
},
['hosts'] = {
['ia'] = {
['id'] = {
"pacificgraveyard0000gibb_g3v0",
"pacificgraveyard0000gibb",
"pacificgraveyard0000gibb_q6k3",
}
}
}
}
-- Some comparisons of impact craters on Mercury and the Moon by D. E. Gault ''et al.''
-- Template:Gault et al 1975
library['GAULT_ET_AL_1975'] = {
['host'] = 'physical', -- WARNING: Changing host breaks page numbers in Wikipedia articles. See WP:SSTS#changehost
['cite_params'] = {
['_template'] = 'cite journal',
['last1'] = "Gault",
['first1'] = "D. E.",
['last2'] = "Guest",
['first2'] = "J. E.",
['last3'] = "Murray",
['first3'] = "J. B.",
['last4'] = "Dzurisin",
['first4'] = "D.",
['last5'] = "Malin",
['first5'] = "M. C.",
['year'] = "1975",
['title'] = "Some comparisons of impact craters on Mercury and the Moon",
['journal'] = "Journal of Geophysical Research",
['volume'] = "80",
['issue'] = "17",
['pages'] = "2444–2460",
['doi'] = "10.1029/jb080i017p02444",
},
['hosts'] = {
['physical'] = {}
}
}
return library