The following HTML-style tags can be used to make document meta-data available to Mr. DLib on the webpage of each document.

Required Fields

<mdl_original_document_id>123abc</mdl_original_document_id>

  • Description: A unique identifier for the document in the partner’s system
  • Domain: String
  • MDL supports 1 mdl_original_document_id entity per document

<mdl_title language="en">Example Title</mdl_title>

  • Description: The title of the document
  • Domain: String
  • Attributes:
    • language (optional): Domain is ISO 639-1
  • MDL supports 1 mdl_title entity per document

Optional Fields

Note: There are 3 supported ways of detailing author information, as documented below.  This is to allow for varying levels of structure in author information. They are listed in increasing levels of structure. Only one of these methods is required; the more structured, the better.

<mdl_authors author_id="423" >Unstructured List of Authors, separated by comma or semicolon</mdl_authors>

  • Description: Name of all authors of document.
  • Domain: String – Unstructured list of all authors of document
  • Attributes:
    • author_id (optional): The unique ID of the authors list in the partner’s system
  • MDL supports 1 mdl_authors entity per document

<mdl_author rank="1" author_id="423">John Smith</mdl_author>

  • Description: Name of an author of the document
  • Domain: String – Name of author in unstructured form
  • Attributes:
    • rank: Refers to the order in which authors should appear. Domain is integers
    • author_id (optional): The unique ID of the author in the partner’s system
  • MDL supports many mdl_author entities per document

<mdl_author rank="1" author_id="423" firstname="John" middlename="Middle" lastname="Smith"/>

  • Description: Name of an author of the document
  • Attributes:
    • rank: Refers to the order in which authors should appear. Domain is integers
    • author_id (optional): The unique ID of the author in the partner’s system
    • firstname (optional): String – First name of author
    • middlename (optional): String – Middle name of author
    • lastname (optional): String – Last name of author
  • MDL supports many mdl_author entities per document

<mdl_date_published>2012-12-16</mdl_date_published>

  • Description: The date that the document was published
  • Domain: String in the form: yyyy-mm-dd OR yyyy
  • MDL supports 1 mdl_date_published entity per document

<mdl_abstract language="en">Example abstract content</mdl_abstract>

  • Description: The document abstract where available
  • Domain: String
  • Attributes:
    • language (optional): Domain is ISO 639-1
  • MDL supports many mdl_abstract entities per document

<mdl_document_type>journal_article</mdl_document_type>

  • Description: The type of the document
  • Domain: Currently contains the following elements, but may be expanded:
    • Unknown
    • journal_article
    • conference_article
    • article_unknown
    • book
    • chapter_in_book
    • workshop_article
    • report
    • tech_report
    • review_book
    • thesis_doctoral
    • thesis_master
    • thesis_bachelor
    • thesis_unspecified
    • government_document
    • review_film
    • monograph
    • patent
    • review_software
    • website
    • work_in_progress_paper
    • news_article
    • letter_from_editor
    • comment
    • conference_abstracts
    • insider_insights
    • review_essay
    • dossier
    • seminar_article
  • MDL supports 1 type entity per document

<mdl_ keyword keyword_id="432324" language="en">Example keyword</mdl_keyword>

  • Description: A keyword describing the document
  • Domain: String
  • Attributes:
    • keyword_id (optional): The unique ID of the keyword in the partner’s system
    • language (optional): Domain is ISO 639-1
  • MDL supports many keyword entities per document

<mdl_category category_id="fsf3453">biology </mdl_category>

  • Description: The category of the document’s subject matter
  • Domain: String
  • Attributes:
    • category_id (optional): The unique ID of the category in the partner’s system
  • MDL supports many mdl_category entities per document

<mdl_published_in venue_id="324432">Journal, Book, Conference Name etc.</mdl_published_in>

  • Description: Name of the journal/conference/bookname/etc. that the document was published in
  • Domain: String
  • Attributes:
    • venue_id (optional): The unique ID of the venue in the partner’s system
  • MDL supports 1 mdl_published_in entity per document

<mdl_publisher publisher_id="f423432">Example Publisher</mdl_publisher>

  • Description: The name of the publisher of the document
  • Domain: String
  • Attributes:
    • publisher_id (optional): The unique ID of the publisher in the partner’s system
  • MDL supports 1 mdl_publisher entity per document

<mdl_document_language>en</mdl_document_language>

  • Description: The language of the document
  • Domain: ISO 639-1
  • MDL supports 1 mdl_document_language entity per document

<mdl_date_updated>2013-03-14</mdl_date_updated>

  • Description: The date that the document was last updated
  • Domain: String in the form: yyyy-mm-dd
  • MDL supports 1 mdl_date_updated entity per document

<mdl_external_identifier type:"isbn">12.1234/isbn.123-3-1234</mdl_external_identifier>

  • Description: Identifiers for the same document in external systems
  • Domain: String
  • Attributes:
    • Type: Domain currently includes the following elements but may be expanded:
      • isbn
      • issn
      • mendeley
      • doi
      • pmid
      • sgr
      • scopus
      • arxiv
      • pui
      • pii
      • oai
    • MDL supports many external_identifiers per document

Best-Practice Advice

There are different ways of using the Mr. DLib tags. Assume, your web pages look like this…

… and the HTML code is as follows.

Then you have three options to adjust your web page, of which you only need to pick one (see illustration below).

A) Enclose the Mr. DLib HTML tags in HTML comments <!– … –>. This will give Mr. DLib’s crawler access to the data, but your visitors will not see the data in their browser.

B) Use the CSS display:none attributes. The effect is the same as using the enclosing HTML comment tags (option A).

C) Enclose the existing metadata with the Mr. DLib HTML tags.