View source for Template:Silr/doc

{{Documentation subpage}} 
{{Braces|Silr}}

This provides a simple and convenient parenthetical in-line reference with a link to its bibliographical counterpart {{tl|Silrbib}} placed near the end of the page. Clicking on the blue text moves the page down to the bibliography and clicking on the "back-arrow" of the browser returns the reader to the text.{{silr|short=Try Here}} By using special parameters it can handle author names in the text, and acronyms as well as books, articles, encyclopaedias, dictionaries and the like. It can be used for  "author-title" in-line referencing, but this method is not recommended since it tends to overload the page visually on the screen.

===Syntax (unnamed parameters)===
Unless the appropriate number of blank parameters '||' to compete the total of four last-names, the parameters '''art''' and '''suf(fix)''' must be named.

:{{braces|tt=y|silr | author1-last-name |  author2-last-name |author3-last-name |author4-last-name | ['''at{{=}}'''] page-number or alternative locator | ['''suf'''{{=}}]optional identifier (or title) }} 
::For example: "Some text.{{Silr|Bideawhile| | | |135}} More text"
:The fourth name will generate an "et al." in the text but forms part of the link/anchor.
:'''at''' inserts the page-number or other position-locator within the work cited in the form provided by the editor. To keep the displayed text as short as possible, the recommended practice is to give just the page or pages: e.g. at=123; at=123-131. However, when using the variant form txt= (see [[#"Text"|below]]), editors may want to prefix the page numbers with 'p.' or 'pp.' to improve the visual presentation.
:The optional parameter '''suf(fix)''' allows the inclusion of a letter or other distinguishing symbol to mark the difference between titles by the same author(s). If used here, it must be repeated in the bibliographical reference to establish the link. It can be used to display the title of the work in-line.

===="Author-title" referencing====
This is depreciated, but can be effected by using the title as the suffix.  The identical suffix must then be supplied in the bibliographical reference {{tl|Silrbib}} to establish the anchor.

=== Variants for specific situations ===

==== Short ID's ====
In various cases it may be more convenient to use a short identifier or acronym rather that the authors' or editors' names. For example, ODCC for ''The Oxford Dictionary of the Christian Church'' edited by Cross and Livingstone.  Simply insert the named parameter '''short'''= ....  There is no point in inserting any last names, {{tlf|Silr}} will then ignore all other parameters apart from '''at''' and '''suf(fix)'''.

===="Text"====
Occasionally it is convenient to mention the name(s) of the author(s) in the text itself.  If either of the parameters '''text''' or '''txt''' is supplied with any value (the obvious one is 'y') {{tlf|Silr}} will display the author surnames in black before opening the brackets and the blue link will appear on the page as just the value of '''at''' (or '''suf(fix) + at''').
:Dorama {{Silr|txt=y|Tellers|at=12|suf=LPCC}} brings her hero onto the scene in a raging temper having been disturbed while on a winning streak at poker.  This puts the police inspector into a very bad mood and the investigation suffers as a result even if the exchanges between the two men allow the author to introduce some verbal fireworks.  Only in the sequel do they manage to recover from this ''contretemps''.{{Silr|Tellers|at=21-25|suf=PP}} [Note the use of '''suf''' = LPCC and PP to distinguish between two titles by the same author.]

====Web====
In many cases websites give no indication of the author's name.  The easiest solution is often to set the '''short''' parameter to some sort of [[acronym]] for the name of the site or its owner and if referring to several different pages distinguish them by using '''suf''' as well.
<noinclude>
==="No Brackets"===
{{Template:Silr/nbdoc}}
</noinclude>
{{hr}}

==Bibliography for above examples==
*{{silrbib|Bideawhile|Sloman|The Law's Delays|Barchester|Trollope Press|1875}}
*{{silrbib|Surname|Given Names|Title|||no date|short=Try Here}}
*{{silrbib|Tellers|Dorama|Lord Patrick Changes Course||Whimsical Press|1964|suf=LPCC}}
*{{silrbib|Tellers|Dorama|Patrician's Pride||Whimsical Press|1966|suf=PP}}