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

New citation style configuration

• Structure:
  • src/main/resources/CitationStyles/Test/CitationStyle.xml: main citation style configuration file.
  • src/main/resources/CitationStyles/font-styles.xml: list of available font style definitions, the font styles can be used in any citation style.
  • src/main/resources/CitationStyles/functions.xml: global function definitions, can be used in any citation style
  • src/main/resources/CitationStyles/variables.xml: global variables xml, can be used in any citation style configuration
  • src/main/resources/CitationStyles/Test/variables.xml: local variables xml, the variables can be used only in Test citation style

Citation Style Configuration XMLs

• Location:

Debugging of citation style configuration

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.

Software Development Kit

Extensible Markup Language

Filename Extension for Text Files

Portable Document Format