Documentation for the Freemarker functions provided ccm-sci-publications

git-svn-id: https://svn.libreccm.org/ccm/trunk@6124 8810af33-2d31-482b-a856-94f89814c4df

ccm-sci-publications/doc/freemarker/ccm-sci-publications/article.md

@@ -0,0 +1,10 @@
+# Freemarker functions for Article In items
+
+Import Path
+: `/ccm-sci-publications/article.ftl`
+
+This functions are for processing items of types `ArticleInCollectedVolume`, `ArticleInJournal` and `InProceedings`.
+
+## `getHref(article: Node): String`
+
+Generates the link to the detail view of the provided article item.

ccm-sci-publications/doc/freemarker/ccm-sci-publications/authors.md

@@ -0,0 +1,37 @@
+# Freemarker functions for processing the authors of a publication item
+
+Import Path
+: `/ccm-sci-publications/authors.ftl`
+
+## `getLink(author: Node, keyId: String): String
+
+Gets the link to the homepage of the author from the contact entries 
+of the author. The key of the contact entry to use is selected using 
+the `keyId` parameter.
+
+## `getId(author: Node): String`
+
+Returns the ID of the author as a string usable as value of the 
+`id` attribute of a HTML element. The returned string consists of
+the ID of the master version of the author item, and the name of the
+author, separated by an underscore.
+
+## `getPosition(author: Node): String`
+
+Returns the position of provided author item in the sequence of authors.
+
+## `isLast(author: Node): boolean
+
+Determines if the provided author is the last author in the sequence of authors.
+
+## `getSurname(author: Node): String`
+
+Gets the surname of the author.
+
+## `getGivenName(author: Node): String`
+
+Gets the given name of the author.
+
+## `isEditor(author: Node): boolean`
+
+Determines if the provided author is an editor.

ccm-sci-publications/doc/freemarker/ccm-sci-publications/collected-volume.md

@@ -0,0 +1,9 @@
+# Freemarker functions for proccessing Collected Volume items
+
+Import Path
+: `/ccm-sci-publications/collected-volume.ftl`
+
+## `getHref(collectedVolume: Node): String`
+
+Returns the link to the detail view of the provided collected volume 
+item.

ccm-sci-publications/doc/freemarker/ccm-sci-publications/export-links.md

@@ -0,0 +1,18 @@
+# Freemarker functions for generating the exportLink links of an publication item
+
+Import Path
+: `/ccm-sci-publications/export-links.ftl`
+
+## `getHref(exportLink: Node): String`
+
+Returns the URL for for the provided export link.
+
+## `getFormatKey(exportLink: Node): String`
+
+Gets the key of the format provided by the export link provided by the
+`exportLink` parameter.
+
+## `getFormatName(exportLink: Node): String`
+
+Gets the name of the format provided by the export link provided by the
+`exportLink` parameter.

ccm-sci-publications/doc/freemarker/ccm-sci-publications/journal.md

@@ -0,0 +1,24 @@
+# Freemarker functions for Journal items
+
+Import Path
+: `/ccm-sci-publications/journal.ftl`
+
+## `getFirstYear(journal: Node): String`
+
+Gets the value of the `firstYear` property of the provided journal.
+
+## `getHref(journal: Node): String`
+
+Returns the link to the detail view of the journal.
+
+## `getIssn(journal: Node): String`
+
+Gets the ISSN of the journal.
+
+## `getIssn(journal: Node): String`
+
+Gets the value of the `lastYear` property of the journal.
+
+## `getTitle(journal: Node): String`
+
+Returns the title of the journal.

ccm-sci-publications/doc/freemarker/ccm-sci-publications/library-signatures.md

@@ -0,0 +1,24 @@
+# Freemarker functions for processing library signatures
+
+Import Path
+: `/ccm-sci-publications/library-signatures.ftl`
+
+A library signature object contains the library signature (usually an
+alpha numeric code) and additional information.
+
+## `getLibrary(signature: Node): String`
+
+Returns the the library of the signature.
+
+## `getSignature(signature: Node): String`
+
+Returns the signature itself.
+
+## `getLibraryLink(signature: Node): String`
+
+Returns the link to the homepage of the library.
+
+## `getMisc(signature: Node): String`
+
+Returns the value of the `misc` property of the signature.
+

ccm-sci-publications/doc/freemarker/ccm-sci-publications/orderer.md

@@ -0,0 +1,8 @@
+# Freemarker functions for processing Orderer objects
+
+Import Path
+: `/ccm-sci-publications/orderer.ftl`
+
+## `getName(orderer: Node): String`
+
+Gets the name of the orderer.

ccm-sci-publications/doc/freemarker/ccm-sci-publications/proceedings.md

@@ -0,0 +1,12 @@
+# Freemarker functions of processing proceedings
+
+Import Path
+: `/ccm-sci-publications/proceedings.ftl`
+
+## `getHref(proceedings: Node): String`
+
+Gets the link to the detail view of the provided proceeedings item.
+
+## `getPaperHref(paper: Node): String`
+
+Returns the link to the detail view of the provided paper.

ccm-sci-publications/web/themes/freemarker/ccm-sci-publications/publications.md

@@ -0,0 +1,175 @@
+# Freemarker functions for publication items.
+
+Import Path
+: `/ccm-sci-publications/publications.ftl`
+
+## `getAssignedTermsDomains(item: Node, domain: String): Sequence<Node>`
+
+Returns the categories from the category system with the name provided 
+by the `domain` parameters which are assigned to the publication.
+
+## `getAuthors(item: Node): Sequence<Node>`
+
+Returns the authors of the publication.
+
+## `getPublisher(item: Node): Sequence<Node>`
+
+Returns the publisher of the publication.
+
+## `getYearOfPublication(item: Node): Sequence<Node>`
+
+Returns the year of publication.
+
+## `getNumberOfPages(item: Node): String`
+
+Gets the number of pages of the publication.
+
+## `getNumberOfVolumes(item: Node): String`
+
+Gets the number of volumes of the publication.
+
+## `getVolume(item: Node): String`
+
+Gets the value of the `volume` property of the publication.
+
+## `getEdition(item: Node): String`
+
+Get the edition of the publication.
+
+## `getIsbn(item: Node): String`
+
+Gets the ISBN of the publication.
+
+## `getLanguageOfPublication(item: Node): String`
+
+Gets the language of the publication.
+
+## `getSeries(item: Node): Node`
+
+Gets the series to which the publication is assigned.
+
+## `isReviewed(item: Node): boolean`
+
+Determines if the publication is reviewed.
+
+## `getAbstract(item: Node): String`
+
+Returns the abstract of the publication.
+
+## `getMisc(item: Node): String`
+
+Returns the value of the `misc` property of the publication.
+
+## `getExportLinks(item: Node): Sequence<Node>`
+
+Returns the export links for the publication.
+
+## `getPlace(item: Node): String`
+
+Returns the value of the `place` property of the publication.
+
+## `getPagesFrom(item: Node): String`
+
+Returns the value of the `pagesFrom` property of the publication.
+
+## `getPagesTo(item: Node): String`
+
+Returns the value of the `pagesTo` property of the publication.
+
+## `getNumber(item: Node): String`
+
+Returns the value of the `number` property of the publication.
+
+## `getYearFirstPublished(item: Node): String`
+
+Returns the value of the `yearFirstPublished` property of the 
+publication.
+
+## `getLibrarySignatures(item: Node): Sequence<Node>`
+
+Returns the library signatures assigned to a publication.
+
+## `getOrganization(item: Node): Node`
+
+Gets the organization assigned to a publication.
+
+## `getOrderer(item: Node): Node`
+
+Gets the orderer assigned to a publication.
+
+## `getIssn(item: Node): Node`
+
+Gets the ISSN of a publication.
+
+## `getLastAccessed(item: Node): String`
+
+Gets the value of the `lastAccessed` property of a publication.
+
+## `getUrl(item: Node): String`
+
+Gets the value of the `url` property of a publication.
+
+## `getUrn(item: Node): String`
+
+Gets the value of the `urn` property of a publication.
+
+## `getDoi(item: Node): String`
+
+Gets the value of the `doi` property of a publication.
+
+## `getIssue(item: Node): String`
+
+Gets the issue of a publication.
+
+## `getJournal(item: Node): Node`
+
+Gets the journal to which a publication is assigned.
+
+## `getCollectedVolume(item: Node): Node`
+
+Gets the collected volume to which a publication is assigned.
+
+## `getChapter(item: Node): String`
+
+Gets the value of the `chapter` property of a publication.
+
+## `getNameOfConference(item: Node): String`
+
+Gets the name of the conference.
+
+## `getPlaceOfConference(item: Node): String`
+
+Gets the place of the conference.
+
+## `getDateFromConference(item: Node): DateNode`
+
+Gets the start date of the conference.
+
+## `getDateToConference(item: Node): DateNode`
+
+Gets the end date of the conference.
+
+## `getProceedings(item: Node): Node`
+
+Gets the proceedings to which an publication is assigned.
+
+## `getProceedingsPapers(item: Node): Sequence<Node>`
+
+Gets the papers of a proceedings publication item.
+
+## `getSeriesVolume(item: Node): String`
+
+Gets the volume of the series for a publication.
+
+## `getEvent(item: Node): String`
+
+Gets the value of the `event` property of a publication of the type
+_talk_.
+
+## `getDateOfTask(item: Node): DateNode`
+
+Gets the value of the `date` property of a publication of the type
+_talk_.
+
+
+

ccm-sci-publications/web/themes/freemarker/ccm-sci-publications/publisher.md

@@ -0,0 +1,12 @@
+# Freemarker functions for processing Publishers
+
+Import Path
+: `/ccm-sci-publications/publisher.ftl`
+
+## `getName(publisher: Node): String`
+
+Gets the name of a publisher.
+
+## `getPlace(publisher: Node): String`
+
+Gets the place of a publisher.

ccm-sci-publications/web/themes/freemarker/ccm-sci-publications/series.md

@@ -0,0 +1,27 @@
+# Freemarker functions for Series
+
+Import Path
+: `/ccm-sci-publications/series.ftl`
+
+## `getFilters(series: Node): Sequence<Node>`
+
+Returns the filters for list of publications of the series. The 
+filters can be procesed by the functions provided for object list 
+filters.
+
+## `getLink(series: Node): String`
+
+Returns the link to the detail view of the series.
+
+## `getName(series: Node): String`
+
+Returns the name of a series.
+
+## `getVolume(series: Node): String`
+
+Gets the value of the `volume` property.
+
+## `getVolumeHref(volume: Node): String`
+
+Gets a link to a volume of a series.
+