New Citation Style HowTo

This is a protected page.

Prerequisites

• java SDK 6
• svn
• maven
• jEdit

Preparations

1. $svn co https://zim02.gwdg.de/repos/common/trunk/common_services

2. $cd common_services/citationmanager

3. check whether checkout can be compiled:

   $mvn clean install

4. $cd src/main/resources/CitationStyles

5. $cp rm Default Test; rm -rf Test/.svn

6. add new citation style Test in the src/main/resources/Schemas/explain-styles.xml, define output-formats
7. get nice items-list XML from PubMan live, create src/test/resources/testFiles/Test directory, and save the XML into it under name TestCollection.xml.
8. changes in src/test/java/test/TestCitationManager.java:
   1. define path to the new item list in the itemListsFIleNames hash

      put("Test", "target/test-classes/testFiles/Test/TestCollection.xml");

   2. create new JUnit test new ctation style testCitationStyleTest.
   3. set testCitationStyles to @Ignore

Citation Style specifications

See APA and AJP pages as platform for citation style specifications and discussions.

The test item list XML has two types of publication items, namely Article and Book Chapter, thus Test citation style will have two different layout representations (so-called Citation Style Layout Definitions, CSLDs). Authors and Year blocks will be basic for both CSLDs.

Authors

• family name, initials (blank separated), e.g.: Morfill, G. E.
• if there are two authors, connect them with " and ", e.g.: Morfill, G. E. and Khrapak S. A.
• if there are more than 3 authors: commas separate author names, while the last author name is preceded by ", and ". E.g.: Kernis, M. H., Cornell, D. P., Sun, C. R., Berry, A., and Harlow, T.

Year

issued or published online. issued has higher priority.

Article

Author, A. A., Author, B. B., and Author, C. C. (Year). Title of article. Title of Periodical, volume(issue number), pages.

Book Chapter

Author, A. A. and Author, B. B. (Year). Title of book chapter. In Title of book. Source.Place of Publication: Source.Name of Publisher.

Citation style configuration

Citation style is configured by means of set of XML files, they are located in src/main/resources/CitationStyles/ directory

• global XMLs, i.e. all specified elements can be used overall in citation styles:

  font-styles.xml: list of available font style definitions.

  functions.xml: global function definitions

  variables.xml: global variables

• citation style specific XMLs:

  Test/CitationStyle.xml: main citation style configuration file

  Test/variables.xml: local variables xml, available only in Test citation style

CitationStyle.xml structure

Root Element

<citation-style
   xmlns="http://www.escidoc.de/citationstyle" 
   xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
   xsi:schemaLocation="http://www.escidoc.de/citationstyle ../../Schemas/citation-style.xsd"
   name="Test" 
   read-only="no" 
   element-specific="no" 
   md-xpath="../../mdr:md-records/mdr:md-record" 
   source-placeholder-tag="prop:content-model-specific" 
   citation-placeholder-tag="dcterms:bibliographicCitation" 
   include-global-default-variables="yes" 
   include-default-variables="yes"
>

• md-path is xpath of the publication metadata location, relative to source-placeholder-tag
• citation-placeholder-tag is target tag for the generated snippet citation
• include-global-default-variables, i.e. variables.xml
• include-default-variables, i.e. Test.variables-xml

Debugging procedure

Plain tests

Debugging life circle consists of 3 consequent steps: validation, compilation and output. Compilation should always take place after any changes in citation style configuration file in order to have a correct output.

1. start test with

   $mvn -Dtest=TestCitationManager test

   1. check console output and target/surefire-reports/test.TestCitationManager.txt for errors.
   2. check generated outputs in formats: pdf and escidoc_snippet in target/ directory. The outputs should not be empty and have list of rendered citations.

Substantial tests

make possible to check the citations content. It helps to avoid some by-effects due to changes in the global functions and variables. It makes sense to run the tests after the plain tests.

1. update
2. generate escidoc_snippet output
3. copy
4. update items in testFiles/Test/TestCollection.xml
5. start test with

   $mvn -Dtest=TestCitationStylesSubstantial test

Related links

• CitationStyleConfigurationConcept
• APA and AJP specifications
• XML Schema

Software Development Kit

Extensible Markup Language

Filename Extension for Text Files

Portable Document Format