Difference between revisions of "New Citation Style HowTo"

Revision as of 21:06, 13 May 2010

This is a protected page.

Prerequisites[edit]

java SDK 6
svn
maven
jEdit

Preparations[edit]

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

```
$cd common_services/citationmanager
```
check whether checkout can be compiled:
```
$mvn clean install
```
```
$cd src/main/resources/CitationStyles
```
```
$cp rm Default Test; rm -rf Test/.svn
```
add new citation style Test in the src/main/resources/Schemas/explain-styles.xml, define output-formats
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.
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[edit]

configuration files structure (path prefix src/main/resources/CitationStyles/):
- globals:
  font-styles.xml: list of available font style definitions, the font styles can be used in any citation style.
  
  functions.xml: global function definitions, can be used in any citation style
  
  variables.xml: global variables xml, can be used in any citation style configuration
- citation style specific:
  Test/CitationStyle.xml: main citation style configuration file.
  
  Test/variables.xml: local variables xml, available only in Test citation style

Citation Style specifications[edit]

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[edit]

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

Year[edit]

issued or published online. issued has more priority.

Article[edit]

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

Book Chapter[edit]

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

Debugging of citation style configuration[edit]

Plain tests[edit]

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.

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[edit]

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.

update
generate escidoc_snippet output
copy
update items in testFiles/Test/TestCollection.xml

start test with

$mvn -Dtest=TestCitationStylesSubstantial test

@@ Line 43: / Line 43: @@
 ==== Year ====
-issued or published online.
+issued or published online. issued has more priority.
 ==== Article ====