mirror of
				https://github.com/searxng/searxng
				synced 2024-01-01 19:24:07 +01:00 
			
		
		
		
	[doc] paper.html result template
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
This commit is contained in:
		
							parent
							
								
									fe43b6e821
								
							
						
					
					
						commit
						08b8859705
					
				
					 1 changed files with 89 additions and 0 deletions
				
			
		| 
						 | 
				
			
			@ -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 <list>`\ [\ :py:class:`str`\ ]
 | 
			
		||||
     - free tag list
 | 
			
		||||
 | 
			
		||||
   * - publishedDate
 | 
			
		||||
     - :py:class:`datetime <datetime.datetime>`
 | 
			
		||||
     - last publication date
 | 
			
		||||
 | 
			
		||||
   * - authors
 | 
			
		||||
     - :py:class:`List <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
 | 
			
		||||
| 
						 | 
				
			
			
 | 
			
		|||
		Loading…
	
	Add table
		
		Reference in a new issue