search

MalcolmK / dmp-references

MIT License
2 stars 0 forks source link

readme

Documark References

npm version dependency status

Documark plugin for listing references.

Usage

  1. Load the references plugin in your document configuration:

    plugins:
  - dmp-references

  2. Add a reference-list element to your document:

    h1 References
reference-list

  3. Use references throughout your document as explained below.

    They will be collected and added as to a ordered list (ol) that is appended to the reference-list element.

NOTE: Jade allows for dot and pipe syntax. References do not render properly when using the Jade dot syntax. So instead of using the following syntax, which does not render properly:

p.
    hello world!
    reference(reference-type="internet", ...)

You should use:

p
    | hello world!
    reference(reference-type="internet", ...)

APA rules

You can find the rules of the apa style guide here: https://owl.english.purdue.edu/owl/resource/560/02/. If someone believes to have found a better one, feel free to contact me!

Clicking on a title of a reference type, will lead you to the online style guide about that kind of reference type.

Reference types

The following types of references are supported:

Source

There are different types of references. As of now not all types of references are supported yet. Below there is a list with all the supported types and how they should be used.

General structure

First of all, the general structure of a reference. A reference to a source has the following structure:

reference(
    reference-type="[reference-type]"
    [optional attributes])

The "optional attributes" are relative to the specific reference types. These types are below. There is no specific sequence needed when defining the optional attributes. For some optional attributes, there are also shorthands available.

Internet

Full example
reference(
    reference-type="internet"
    date-of-consultancy="13 februari 2015"
    document-title="Aandachtsgebieden"
    date-of-publishment="2013, september"
    author="Kindermans, M."
    url="https://www.tno.nl/nl/aandachtsgebieden/")
Optional attributes
Element Attribute Short Description
Author: author auth Name of the person who wrote this reference.
Date of publishment: date-of-publishment dop Date when this reference was published.
Document title: document-title title The title of the reference.
Date of consultancy: date-of-consultancy doc The date when you consulted this reference.
Location of the reference: url The url to the internet source.

Book

Full example
reference(
    reference-type="book"
    author="Adriaansen, M. & Caris, J."
    date-of-publishment="2011"
    document-title="Elementaire sociale vaardigheden"
    edition="3e druk"
    location="Houten"
    publisher="Bohn Stafleu Van Loghum")
Optional attributes
Element Attribute Short Description
Author: author auth Name of the person who wrote this reference.
When the author and the editor are the same: author-is-editor editor When the author and the editor are the same person, add the title of an editor in the same language as the title of the book to the attributes:
Date of publishment: date-of-publishment dop Date when this reference was published.
Document title: document-title title The title of the reference.
Edition: edition ed It is possible to add the used edition, this will be appended to the title within brackets.
Publisher: publisher pub The name of the publisher of this reference.
Location of publishment: location loc The location where the reference was published.

Magazine

Full example
reference(
    reference-type="magazine-article"
    author="Ouwekerk, D. van, & Grinten, J. van der."
    date-of-publishment="2014"
    article-title="De kracht van zacht: Wat mannen over vrouwelijke vergaderstijlen kunnen leren"
    document-title="Interne Communicatie"
    volume="3"
    edition="4"
    page-numbers="11-13")
Optional attributes
Element Attribute Short Description
Author: author auth Name of the person who wrote this reference.
Date of publishment: date-of-publishment dop Year when this reference was published.
Name of the magazine: document-title doc-title The title of the magazine itself.
Title of this specific article: article-title art-title The title of the article that is used.
Volume: volume vol Volume of the magazine. In general this is the number of the year it is published.
Edition: edition ed The edition of the magazine. In general this is the number of the edition in this volume (this year).
Page numbers: page-numbers p Generally you are not using the whole magazine. So use this attribute to tell which pages are used.

Newspaper article

Full example
reference(
    reference-type="newspaper-article"
    author="Havelaar, R."
    date-of-publishment="2006, 13 december"
    article-title="Student leert minder uren omdat hij werkt"
    document-title="De Volkskrant"
    page-numbers="13")
Optional attributes
Element Attribute Short Description
Author: author auth Name of the person who wrote this reference.
Date of publishment: date-of-publishment dop Year when this reference was published.
Name of the newspaper: document-title doc-title The title of the magazine itself.
Title of this specific article: article-title art-title The title of the article that is used.
Page numbers: page-numbers p Generally you are not using the whole magazine. So use this attribute to tell which pages are used.

Not published reference

Full example
reference(
        reference-type="not-published"
        author="Drogendijk, A. N., et al."
        date-of-publishment="2004"
        document-title="Leidende en misleidende verwachtingen: Een kwalitatief onderzoek onder Turkse getroffenen van de vuurwerkramp Enschede omtrent de psychosociale nazorg"
        publisher="Instituut voor Psychotrauma")
Optional attributes
Element Attribute Short Description
Author: author auth Name of the person who wrote this reference.
Date of publishment: date-of-publishment dop Year when this reference was published.
Name of the document: document-title title The title of the publication.
Publisher: publisher pub The name of the publisher of this reference.
Location of publishment: location title The location where the reference was published.
Description of the document: description descr Provide a description of the reference.

Online image

Full example
reference(
        reference-type="online-image"
        author="HAN."
        date-of-publishment="2011, 24 februari"
        document-title="Studenten vragen Pieter van den Hoogenband hemd van het lijf bij Topsportuur"
        date-of-consultancy="25 februari 2011"
        url="http://www.han.nl/gebied/sport-beweging/nieuws/nieuws/studenten-vragen-pieter-v/_images/hoogenband.jpg/large")
Optional attributes
Element Attribute Short Description
Author: author auth Name of the person who wrote this reference.
Date of publishment: date-of-publishment dop Date when this reference was published.
Document title: document-title title The title of the reference.
Date of consultancy: date-of-consultancy doc The date when you consulted this reference.
Location of the reference: url url The url to the internet source.

Output

The final HTML structure will look something like this:

At the place where the reference was made, so in your text, the following will be placed:

<sup>
    <a href="#reference-entry-[index]">[index]</a>
</sup>

At the place of the [index], there will be the index. So when e.g. this is the reference for the second index, it will look like this:

<sup>
    <a href="#reference-entry-2">2</a>
</sup>

At the place with the list of references, the final html will look something like this:

<reference-list>
    <ol>
        <li>
            <a class="reference-entry-style" name="reference-entry-1">[Reference 1 text]</a>
        </li>
        <li>
            <a class="reference-entry-style" name="reference-entry-2">[Reference 2 text]</a>
        </li>
        <li>
            <a class="reference-entry-style" name="reference-entry-3">[Reference 3 text]</a>
        </li>
    </ol>
</reference-list>