Difference between revisions of "ESciDoc Services CitationStyleManager"
Jump to navigation
Jump to search
m |
m |
||
Line 23: | Line 23: | ||
!width="300"|'''Description''' | !width="300"|'''Description''' | ||
|- style="height:33px" | |- style="height:33px" | ||
|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, SNIPPET*. | |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<br/> | |getOutput||implemented||String citationStyle<br/> | ||
Line 30: | Line 30: | ||
||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. <br/> | ||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. <br/> | ||
Note: in future it is planned to return a URL from where the temporary file can be downloaded. | 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<br/>String outputFormat||String||The method returns the mime-type for citationStyle and outputFormat | |||
|} | |} | ||
Revision as of 11:35, 7 November 2008
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, PDF or HTML.
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 |
- 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.