ESciDoc Services CitationStyleManager

From MPDLMediaWiki
Revision as of 15:52, 1 December 2010 by Makarenko (talk | contribs)
Jump to navigation Jump to search
eSciDoc SOA

SOAP and REST style interfaces
Service layers

Core services
Context Handler · Item Handler
Container Handler
Organizational Unit Handler
User Account Handler
Authentication
Content Model Handler
Semantic Store Handler

Intermediate services
Validation Service
Statistics Manager
Technical Metadata extraction
PIDManager
Basket Handler
Duplication detection
ImageHandler(Digilib)

Application services
Depositing
Searching
Search&Export
Control of Named Entities
Citation style Manager
RightsChecking
DataAcquisition
Transformation
Fledged Data
PID Cache
OAI-PMH

SOA Introduction

edit

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
String itemList

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.

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
  • html_linked
  • html_linked

Service interfaces[edit]

  • export manager

Download[edit]

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