(c) 2009-10-23 Dan Forsberg

README: 3GPP and IETF Specs to Zotero
=====================================

   I.    Intro
   II.   Data
   III.  Zotero Style
   IV.   Links


I.    INTRO 
-----------

  (Web) -> (BibTeX) -> (Zotero) -> (Doc)

  What: Generate .bib files from standard specification indexes to be
  imported for Zotero so that 3GPP specs can be referenced with like
  '[33.401]', RFCs like '[RFC3344]', Internet Drafts like
  '[draft-ietf-pana-pana-03]', books and articles like '[J. Smith,
  2007]'.

  Zotero style treats book entries with Series Number and Series
  fields non-empty as special cases. The Series Number (mapped to
  collection-number in CSL style sheet) is used in the citation and
  the bibliography is sorted based on the Series Number as primary
  key. Also, these special entries are displayed differently in the
  bibliography compared to normal Harward style entries.


II.   DATA
----------

  0. Run (if you need fresh .bib files):
      % ./3gpp2bib-zotero.tcl
      % wget http://www.ietf.org/rfc/rfc-index.xml
      % xsltproc -o rfc-zot.bib rfcxmlindex2bibtex.xslt rfc-index.xml
      % ./id2bib-zotero.tcl
  
  1. Import bib files in Zotero:
      3gpp-zot.bib 
      I-D-zot_test.bib
      rfc-zot.bib

  2. Import bookStyle.csl into Zotero by drag and dropping the file
  over Firefox (once Zotero plug-in is installed in Firefox).


  NOTES: The tcl scripts are slightly modified Miguel A. Garcia's
  scripts. The xslt file is slightly modified Roland Bless' xslt file.


III.  ZOTERO STYLE
------------------

  3GPP citation: [TS33.401]
  RFC citation: [RFC3344]
  I-D citation: [draft-ietf-pana-mobopts-00]


  3GPP TSs/TRs, RFCs and I-Ds are of type "book" and the style file
  checks whether the entry has 'Series' and 'Series Number' fields
  filled up, and if yes, it will use the 'Series Number' field instead
  of the author fields in citation. The result is '[RFC3344]' or
  '[TS33.401]'.

  In short:
   --> use @book type entry in .bib file
   --> this becomes book type in Zotero
   --> Series number and Series available 
   --> book type collection-number and collection-title can be used to
       "distinguish" from other entries (I'm not adding a new item
       type as it is not encouraged on Zotero developers community)
   --> all 3gpp TS/TRs, IETF RFCs, and IETF I-Ds can be handled the
       same way

  The main point in the CSL style we add a conditional that checks
  whether the type is book and the entries Series Number and Series
  are non-empty.

	<choose>
	<if type="book" variable="collection-number collection-title" match="all">
	  ...
	</if>
	<else-if>
	  ...
	</else-if>
        <else>
	  ...
	</else>
	</choose>


  For citation data, we use collection-number as the way to add
  citations into the text (collection-number is the same as "Series
  Number", and "Series" is the same as "collection-title"):

	<choose>
	<if type="book" variable="collection-number collection-title" match="all">
	  <text variable="collection-number"/>
	</if>
	<else>
	  <text macro="author-short" suffix=" "/>
 	  <text macro="year-date"/>
	</else>
	</choose>

  Bibliography sort is based on Series Number for our special books:

      <sort>
         <key variable="collection-number"/>
         <key macro="author"/>
         <key variable="title"/>
      </sort>
  
  Bibliography layout is also different for our special books:

      <choose>
      <if type="book" variable="collection-number collection-title" match="all">
	<text variable="collection-number" suffix=", "/>
        <text macro="author" suffix=","/>
      </if>
      <else>
        <text macro="author" suffix=","/>
        <date variable="issued" prefix=" " suffix=".">
  	  <date-part name="year"/>
      </date>
      </else>
      </choose>
 
  Bibliography data is different for our special books, i.e., date is later:

        <if type="book" variable="collection-number collection-title" match="all">
	  <group prefix=" " delimiter=" " suffix=",">
	    <text macro="title" />
	    <text macro="edition"/>
	    <text macro="editor"/>
	  </group>
          <text variable="note" suffix=", " prefix=" "/>
	    <date variable="issued" >
	      <date-part name="month" form="short" suffix=". "/>
	      <date-part name="year" suffix=", "/>
	    </date>
	  <text prefix=" " suffix="." macro="publisher"/>
	</if>


IV.   LINKS
-----------

  IETF RFC index: http://www.ietf.org/rfc/rfc-index.xml

  IETF I-D index: http://www.ietf.org/id/1id-index.txt 

  3GPP TS/TR index:
  http://www.3gpp.org/ftp/Specs/html-info/2003-04-10_webexp11a_status-report_special_select.txt

  Miguel A. Garcia: http://sites.google.com/site/ea1dof/bibtex

  Roland Bless: http://www.tm.uka.de/~bless/bibrfcindex.html

  Zotero: http://www.zotero.org/

  Zotero style edit/test: chrome://zotero/content/tools/csledit.xul