Skip to content
This repository has been archived by the owner on Dec 3, 2018. It is now read-only.

Resource field formats

Jump to bottom
Nicolas Thouvenin edited this page Dec 22, 2016 · 8 revisions

With Lodex, it is possible to choose the display format of field value. A field value is the "Object" for a triple (subject-predicate-object). The format directly depends of the export format.

There are usually 2 different cases, for HTML export et for all others cases. In the prototype, HTML transformation is made by a dedicated web component.

"raw"

no transformation

"markdown"

for HTML output transform syntax to HTML

for all others cases, no transformation

"moment"

for HTML output transform ISODate to Human and locale date

for all others cases, no transformation

Note : Could be renamed

"chart" (experimental)

For output HTML generate graphics from an API REST giving access to MongoDB operators as is done in ezvis for all others cases, REST API URL

"picture"

for HTML output transform url to image view with some features (like lightbox2)

for all others cases, no transformation

"uri"

for HTML output transform uri to href link with icon and text label

"embeduri"

for HTML output transform uri to a frame with title, link and description

"istex"

for HTML output transform elastic query to small result interface with pagination and filter

for all RDF formats transform elastic query to triplets with ISTEX identifiers

"bag"

for HTML output transform a string with separtors to unodered list (

    )

    "sparql"

    for HTML output transform SPARQL query to small result interface with pagination and filter

    Code source references :

    **Field characteristics : **

    All fields are calculated on the fly, unless they are published. To do this, the JSON structure is interpreted as a JBJ stylesheet with the inject method. So the content of each field is computed by the crossing (the association) of the mongoDB document structure and the JBJ code.

    Code source references :

    Required characteristics :

    • "label"

    a free title for the field

    • "scheme"

    the URI of a property (maybe found on the LoV with the search API http://lov.okfn.org/dataset/lov/api#searchVocabsv2)

    • "type" the URI of an XML Schema type (string, boolean, decimal, float, double, duration, dateTime, time, date, ...)

    • "content"

    the content of the field

    • "cover" (Could be improved andor renamed)

    dataset : the field is shared by all dataset resources collection : the field is present in all dataset resources document : the field exists only in just one resource

    Optional characteristics :

    • "format"

    choose an display format (see output resource format)

    • "formatOptions"

    Specifies particular options for the display format

    • "displayAreas" (Could be improved)

    indicates if the field should be displayed in a dedicated area

    • "settings" (Could be improved)

    Directives (ex: 'noindex', 'private', etc. ) to configure the search engine, the storage engine. It’s like the HTML meta tag “robots”

    • "complete" (Could be renamed)

    A field identifier that indicates that this field completes or specifies another field

    • "composedOf" (Could be renamed)

    An array of field identifiers indicates that this field is composed by the calculation of all the fields specified in the array

    • "position" (Could be improved and renamed)

    Indicate the position of the field in the list

    Code source references :

    Operations on the dataset :

    TODO

    Code source references :

    Configuration options for an instance :

    *required *

    • baseURL

    optionnal

    • piwikTrackerID

    • databaseName

    • ark

      • naan

      • subpublisher

    • itemsPerPage

    • prints :

    • "access": {

    • "login": "apa",

    • "sha1": "e41550151e3c09a174b499a9379417e498a3d7c0"

    • },

    States of the contributions

    • blank

    • validated

    • rejected

Clone this wiki locally