From 08b88597052dfdf17e947289d79510fdadad51e3 Mon Sep 17 00:00:00 2001 From: Markus Heiser Date: Sun, 18 Sep 2022 14:52:54 +0200 Subject: [PATCH] [doc] paper.html result template Signed-off-by: Markus Heiser --- docs/dev/engine_overview.rst | 89 ++++++++++++++++++++++++++++++++++++ 1 file changed, 89 insertions(+) diff --git a/docs/dev/engine_overview.rst b/docs/dev/engine_overview.rst index e950ae667..731e2f86a 100644 --- a/docs/dev/engine_overview.rst +++ b/docs/dev/engine_overview.rst @@ -311,3 +311,92 @@ the parameter ``template`` must be set to the desired type. address.postcode postcode of object address.country country of object ========================= ===================================================== + +.. _BibTeX format: https://www.bibtex.com/g/bibtex-format/ +.. _BibTeX field types: https://en.wikipedia.org/wiki/BibTeX#Field_types + +.. list-table:: Parameter of the **paper** media type / + see `BibTeX field types`_ and `BibTeX format`_ + :header-rows: 2 + :width: 100% + + * - result-parameter + - Python type + - information + + * - template + - :py:class:`str` + - is set to ``paper.html`` + + * - title + - :py:class:`str` + - title of the result + + * - content + - :py:class:`str` + - abstract + + * - comments + - :py:class:`str` + - free text display in italic below the content + + * - tags + - :py:class:`List `\ [\ :py:class:`str`\ ] + - free tag list + + * - publishedDate + - :py:class:`datetime ` + - last publication date + + * - authors + - :py:class:`List `\ [\ :py:class:`str`\ ] + - list of authors of the work (authors with a "s") + + * - editor + - :py:class:`str` + - list of editors of a book + + * - publisher + - :py:class:`str` + - name of the publisher + + * - journal + - :py:class:`str` + - name of the journal or magazine the article was + published in + + * - volume + - :py:class:`str` + - volume number + + * - start_page + - :py:class:`int` + - page number where the article starts + + * - end_page + - :py:class:`int` + - page number where the article ends + + * - number + - :py:class:`str` + - number of the report or the issue number for a journal article + + * - doi + - :py:class:`str` + - DOI number (like ``10.1038/d41586-018-07848-2``) + + * - issn + - :py:class:`str` + - ISSN number like ``1476-4687`` + + * - isbn + - :py:class:`str` + - ISBN number like ``9780201896831`` + + * - pdf_url + - :py:class:`str` + - URL to the full article, the PDF version + + * - html_url + - :py:class:`str` + - URL to full article, HTML version