Difference between revisions of "ESciDoc Services CitationStyleManager"
m (→Output formats) |
m (→Output formats) |
||
Line 91: | Line 91: | ||
</pre> | </pre> | ||
List of the possible class names is available in the [https://zim02.gwdg.de/repos/common/trunk/common_services/citationmanager/src/main/resources/CitationStyles/font-styles.xml global font styles definition XML] or in the [https://zim02.gwdg.de/repos/common/trunk/common_services/citationmanager/src/main/resources/CitationStyles/APA(CJK)/font-styles.xml citation style specific font styles definition XML]. Check <code>@css-class</code> attribute of the <code>font-style</code> element. | List of the possible class names is available in the [https://zim02.gwdg.de/repos/common/trunk/common_services/citationmanager/src/main/resources/CitationStyles/font-styles.xml global font styles definition XML] or in the [https://zim02.gwdg.de/repos/common/trunk/common_services/citationmanager/src/main/resources/CitationStyles/APA(CJK)/font-styles.xml citation style specific font styles definition XML]. Check <code>@css-class</code> attribute of the <code>font-style</code> element. | ||
*<code>html_linked</code> output format is same as <code>html_plain</code> with additional | *<code>html_linked</code> output format is same as <code>html_plain</code> with additional links to the source item itself, attached components and external locators: | ||
<pre> | <pre> | ||
<html> | <html> |
Revision as of 14:05, 6 December 2010
Work in progress
ID (Label)[edit]
CSM
Complete Name[edit]
Citation Style Manager Service
Status[edit]
Implemented.
Description[edit]
This service formats the descriptive metadata of a content item (or a list of content items) in accordance with specific citation style definition for styles such as APA, MLA, Chicago, MPG Yearbook citation style and others and generates a file with specific output format such as RTF, ODT, PDF or HTML. Currently implemented style definitions: APA, AJP
Operations[edit]
Operation | Status | Input | Output | Description |
---|---|---|---|---|
explainStyles | implemented | none | List of styles and supported output formats in accordance with the explain_styles.xsd | This operation retrieves a list of supported citation styles and for each of them supported output format such as RTF, PDF, HTML, ODT, SNIPPET*. |
getOutput | implemented | String citationStyle String outputFormat |
byte [] | The service takes as an input citationStyle identifier, an output format identifier and a list of content items and returns a byte array with metadata formatted in accordance with selected citation style and output format. Note: in future it is planned to return a URL from where the temporary file can be downloaded. |
isCitationStyle | implemented | String citationStyle | boolean | The method returns true if citationStyle is in the list of available citation styles, false otherwise |
getStyles | implemented | none | String[] | The method returns the list of available citation styles |
getOutputFormats | implemented | String citationStyle | String[] | The method returns the list of available output formats for citationStyle |
getMimeType | implemented | String citationStyle String outputFormat |
String | The method returns the mime-type for citationStyle and outputFormat |
Output formats[edit]
SNIPPET
- this is an XML format of the data, defined by the eSciDoc Item.xsd schema. It is enriched with the HTML formatted output of the selected citation style e.g. APA as<dcterms:bibliographicCitation/>
in the<content-model-specific/>
part of the item XML representation.
Example:
<dcterms:bibliographicCitation xmlns:dcterms="http://purl.org/dc/terms/"> <![CDATA[ <span class="Default">Sengbusch, R. v. <span class="DisplayDateStatus"> (1963).</span> </span> <span class="Italic">FISCHE "OHNE GRÄTEN".</span> <span class="Default"><br/></span> ]]> </dcterms:bibliographicCitation>
html_plain
is a list of exported citations in plain HTML format with basic formatting. Any element of the citation is surrounded with classed tag, which can be referenced by css selector later in local CMS system:
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
</head>
<body>
<div class="Pubman">
<p>Eisner, F., Weber, A., & Melinger, A. <span class="DisplayDateStatus">(2010).</span> Generalization of learning in pre-lexical
adjustments to word-final devoicing [Abstract].<span class="Italic"><i> Journal of the Acoustical Society of America</i></span>,
<span class="Italic"><i>128</i></span>, 2323. doi:10.1121/1.3508195.
</p>
<p>Brandmeyer, A., Sadakata, M., Timmers, R., & Desain, P. <span class="DisplayDateStatus">(2010).</span> Learning expressive
percussion performance under different visual feedback conditions.<span class="Italic"><i> Psychological Research. Advance
online publication</i></span>. doi:10.1007/s00426-010-0291-6.
</p>
<p>Abadie, J., Abbott, B., Abbott, R., Accadia, T., Acernese, F., Adhikari, R., Ajith, P., Allen, B., Allen, G., Ceron, E. A.,
Amin, R. S., Anderson, S. B., Anderson, W. G., Antonucci, F., Aoudia, S., Arain, M. A., Araya, M., Arun, K. G., Aso, Y., Aston,
S., et al. <span class="DisplayDateStatus">(2010).</span> Search for gravitational-wave inspiral signals associated with short
Gamma-Ray Bursts during LIGO's fifth and Virgo's first science run.<span class="Italic"><i> Astrophysical Journal</i></span>,
<span class="Italic"><i>715</i></span>(2), 1453-1461. doi:10.1088/0004-637X/715/2/1453.
</p>
<p>Bishop, N. T., Gomez, R., Husa, S., Lehner, L., & Winicour, J. <span class="DisplayDateStatus">(2003).</span> A numerical
relativistic model of a massive particle in orbit near a Schwarzschild black hole.<span class="Italic"><i> Physical Review
D</i></span>, <span class="Italic"><i>68</i></span>.
</p>
</div>
</body>
</html>
List of the possible class names is available in the global font styles definition XML or in the citation style specific font styles definition XML. Check @css-class
attribute of the font-style
element.
html_linked
output format is same ashtml_plain
with additional links to the source item itself, attached components and external locators:
<html> <head> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> </head> <body> <div class="Pubman"> <p>Eisner, F., Weber, A., & Melinger, A. <span class="DisplayDateStatus">(2010).</span> Generalization of learning in pre-lexical adjustments to word-final devoicing [Abstract].<span class="Italic"><i> Journal of the Acoustical Society of America</i></span>, <span class="Italic"><i>128</i></span>, 2323. doi:10.1121/1.3508195.<br><a href="http://pubman.mpdl.mpg.de/pubman/item/escidoc:550547:6" class="Item">[Item] </a></p> <p>Brandmeyer, A., Sadakata, M., Timmers, R., & Desain, P. <span class="DisplayDateStatus">(2010).</span> Learning expressive percussion performance under different visual feedback conditions.<span class="Italic"><i> Psychological Research. Advance online publication</i></span>. doi:10.1007/s00426-010-0291-6.<br><a href="http://pubman.mpdl.mpg.de/pubman/item/escidoc:458242:4" class="Item">[Item] </a><a href="http://pubman.mpdl.mpg.de/pubman/item/escidoc:458242:4/component/escidoc:551571/Brandmeyer_Learning expressive percussion_Psych_Res_advance_online.pdf" class="File">[File 1]</a></p> <p>Bishop, N. T., Gomez, R., Husa, S., Lehner, L., & Winicour, J. <span class="DisplayDateStatus">(2003).</span> A numerical relativistic model of a massive particle in orbit near a Schwarzschild black hole.<span class="Italic"><i> Physical Review D</i></span>, <span class="Italic"><i>68</i></span>.<br><a href="http://pubman.mpdl.mpg.de/pubman/item/escidoc:151751:2" class="Item">[Item] </a><a href="http://pubman.mpdl.mpg.de/pubman/item/escidoc:151751:2/component/escidoc:151750/50946.pdf" class="File">[File 1]</a></p> </div> </body> </html>
Service interfaces[edit]
- export manager
Download[edit]
- SVN link
Future Development[edit]
- new citation styles (AJP, etc.)
- creation of the more sophisticated semantic JUnit tests
- command-line based workflow for creation and testing of the new citation styles
- Citation Manager Library WEB Interface, further development