summaryrefslogtreecommitdiffstats
path: root/data/doc/sisu/markup-samples/manual/en/sisu_markup.sst
diff options
context:
space:
mode:
Diffstat (limited to 'data/doc/sisu/markup-samples/manual/en/sisu_markup.sst')
-rw-r--r--data/doc/sisu/markup-samples/manual/en/sisu_markup.sst95
1 files changed, 95 insertions, 0 deletions
diff --git a/data/doc/sisu/markup-samples/manual/en/sisu_markup.sst b/data/doc/sisu/markup-samples/manual/en/sisu_markup.sst
index 3a8ae57..43c161d 100644
--- a/data/doc/sisu/markup-samples/manual/en/sisu_markup.sst
+++ b/data/doc/sisu/markup-samples/manual/en/sisu_markup.sst
@@ -1335,6 +1335,101 @@ code{
}code
+2~ Bibliography / References
+={ SiSU markup:references|bibliography|citations;references;book index }
+
+There are three ways to prepare a bibliography using sisu: (i) manually preparing and marking up as regular text in sisu a list of references; (ii) (tagging citations for inclusion) using a restricted form for citations and marking them up to identify them as such (which sisu then parses and attempts to build a bibliography from), or; (iii) preparing a bibliography, using metadata tags for author: title: year: and the like, including an id: and shortname: the id can be inserted in footnotes in place of the citation, and it will be substituted there by the short title for the work.
+
+For the heading/section sequence: endnotes, bibliography then book index to occur, the name biblio or bibliography must be given to the bibliography section, like so:
+
+code{
+
+1~biblio Bibliography
+
+}code
+
+3~ a markup tagged metadata bibliography section
+
+Here instead of writing your full citations directly in footnotes, each time you have new material to cite, you add it to your bibliography section (if it has not been added yet) providing the information you need against an available list of tags. At the time of writing, for articles: au|author; ti|title; lng|language; jo|journal; vo|volume; edr|editor; yr|year; pst|publisher_state; url; note; sn|shortname; id; and \\ for books: au|author; ti|title; st|subtitle; lng|language; pb|publisher; edn|edition; yr|year; pst|publisher_state; url; note; sn|shortname; id.
+
+The required tags are au: ti: and year: ~{for which you may alternatively use the full form author: title: and year: }~ an short quick example might be as follows:
+
+code{
+
+1~biblio Bibliography
+
+au: von Hippel, E.
+ti: Perspective: User Toolkits for Innovation
+lng: (language)
+jo: Journal of Product Innovation Management
+vo: 18
+edr: (editor)
+yr: 2001
+note:
+sn: Hippel, /{User Toolkits}/ (2001)
+id: vHippel_2001
+% form:
+
+au: Benkler, Yochai
+ti: The Wealth of Networks
+st: How Social Production Transforms Markets and Freedom
+lng: (language)
+pb: Harvard University Press
+edn: (edition)
+yr: 2006
+pst: U.S.
+url: http://cyber.law.harvard.edu/wealth_of_networks/Main_Page
+note:
+sn: Benkler, /{Wealth of Networks}/ (2006)
+id: Benkler2006
+
+au: Quixote, Don; Panza, Sancho
+ti: Taming Windmills, Keeping True
+jo: Imaginary Journal
+yr: 1605
+url: https://en.wikipedia.org/wiki/Don_Quixote
+note: made up to provide an example of author markup for an article with two authors
+sn: Quixote and Panza, /{Taming Windmills}/ (1605)
+id: quixote1605
+
+}code
+
+Note that the section name biblio (or bibliography) is required for the bibliography to be recognized as such, parsed correctly, and placed after the auto-generated endnote section.
+
+Using this method, work goes into preparing the bibliography, which will be automatically sorted by surname and presented, under the References or Bibliography section using the format for books:
+
+_1 number, author (firstname & initials, surname), fulltitle, publisher, year, url (if any)
+
+and for articles:
+
+_1 number, author (firstname & initials, surname), title, journal, volume, year, url (if any)
+
+The metadata tags may include shortname and id, if provided, every time the given id is found within the text it will be replaced by the given short title of the work (it is for this reason the short title has sisu markup to italicize the title), it should work with any page numbers to be added, the short title should be one that can easily be used to look up the full description in the bibliography.
+
+code{
+
+The following footnote~{ quixote1605, pp 1000 - 1001, also Benkler2006 p 1. }~
+
+}code
+
+would be presented as:
+
+Quixote and Panza, /{Taming Windmills}/ (1605), pp 1000 - 1001 also, Benkler, /{Wealth of Networks}/, (2006) p 1 or rather~{ Quixote and Panza, /{Taming Windmills}/ (1605), pp 1000 - 1001 also, Benkler, /{Wealth of Networks}/ (2006), p 1 }~
+
+3~ Tagging citations for inclusion in the Bibliography
+
+Here whenever you make a citation that you wish be included in the bibliography, you tag the citation as such using special delimiters (which are subsequently removed from the final text produced by sisu)
+
+Here you would write something like the following, either in regular text or a footnote
+
+code{
+
+See .: Quixote, Don; Panza, Sancho /{Taming Windmills, Keeping True}/ (1605) :.
+
+}code
+
+SiSU will parse for a number of patterns within the delimiters to try make out the authors, title, date etc. and from that create a Bibliography. This is more limited than the previously described method of preparing a tagged bibliography, and using an id within text to identify the work, which also lends itself to greater consistency.
+
2~ Book index
={ SiSU markup:book index;book index }