Difference between revisions of "Template:Librivox book/doc"

From blackwiki
Jump to navigation Jump to search
imported>GreenC
imported>GreenC
Line 6: Line 6:
  
 
== Usage ==
 
== Usage ==
<nowiki>{{Librivox book |title=<book title> |author=<author name>}}</nowiki>
 
  
If no "title" is provided it will default to the title of the page.
+
In most cases the template takes two parameters, the title of the book and the author name.  
 +
::<nowiki>{{Librivox book |title=<book title> |author=<author name>}}</nowiki>
  
If no "author" is provided it will default to "" and may not give good results. Note that LibriVox requires only the last name of an author. You may use the full author name (recommended for future compatibility) but at the moment the template only uses the last word.
+
Parameter options:
 +
 
 +
*'''title''' = the title of the book. This will be the search term at LibriVox, and the display name at Wikipedia. If no title is given it defaults to the article name (not normally recommended in case the article is renamed in the future).
 +
*'''stitle''' = the title used when searching LibriVox.org
 +
*'''dtitle''' = the display title on Wikipedia.
 +
::Example for [[The Federalist Papers]]:
 +
::::<nowiki>{{Librivox book |stitle=The Federalist Papers |dtitle=''The Federalist'' Papers}}</nowiki>
 +
::Will produce:
 +
::::{{Librivox book |title=The Federalist Papers |dtitle=''The Federalist'' Papers}}
 +
::Note the use of ''italics'' and no author field.
 +
*'''author''' = the name of the author. Usually this only needs to be the last name of the author. You may use the full name for future compatibility (recommended) but for now the template extracts the last word in the name only. If no author is given (such as the federalist paper example above) it will be result in a broader search.
  
 
==Examples==
 
==Examples==

Revision as of 15:04, 18 March 2015

This template is for linking books at LibriVox. For linking authors see {{Librivox author}}

Usage

In most cases the template takes two parameters, the title of the book and the author name.

{{Librivox book |title=<book title> |author=<author name>}}

Parameter options:

  • title = the title of the book. This will be the search term at LibriVox, and the display name at Wikipedia. If no title is given it defaults to the article name (not normally recommended in case the article is renamed in the future).
  • stitle = the title used when searching LibriVox.org
  • dtitle = the display title on Wikipedia.
Example for The Federalist Papers:
{{Librivox book |stitle=The Federalist Papers |dtitle=''The Federalist'' Papers}}
Will produce:
The Federalist Papers public domain audiobook at LibriVox
Note the use of italics and no author field.
  • author = the name of the author. Usually this only needs to be the last name of the author. You may use the full name for future compatibility (recommended) but for now the template extracts the last word in the name only. If no author is given (such as the federalist paper example above) it will be result in a broader search.

Examples

{{Librivox book |title=The Time Machine | author=H. G. Wells}}

Will produce:

The Time Machine public domain audiobook at LibriVox