m (Hide section edit links)
m (Moves a sentence to the next section)
 
(3 intermediate revisions by the same user not shown)
Line 1: Line 1:
== General requirement for adding records ==
== General requirement for adding records ==


*as default, one has to be logged in to edit an record. This default can be changed from the admin
* By default, one has to be logged in to edit a record. This default can be changed by the admin.
*the ''add record''-page has to be opened. This can be easily done at with the link at the header of every page
*some browsers (e.g. firefox) have problems with pasting in text with line breaks. So please remove line breaks before pasting the text in these cases.


== General description of the ''Add Record'' page ==
== General description of the ''Add Record'' page ==


*you will see several input-fields, which are grouped. Groups are indicated by color-coding (colors may vary with used browser, used stylesheets etc.)
Open the ''Add record'' page by clicking the link at the top of every page.
#grey fields:
 
#*such as ''author'', ''title'', ''year'' and ''publication''
* The ''Add record'' page has several input fields, which are grouped. Groups are indicated by color coding:
#*these are mandatory fields, which are necessary for correct citation of references
# Grey fields:
#white fields:
#* e.g. ''author'', ''title'', ''year'' and ''publication''
#*such as ''abstract'', ''keywords'' and ''ISBN''
#* these are mandatory fields, which are necessary for correct citation of references
#*these are facultative fields, which are not necessary for correct citation
# White fields:
#*but these fields will give a additional benifit to your database, for searching abstracts etc.
#* e.g. ''abstract'', ''keywords'' and ''ISBN''
#yellow fields:
#* these are facultative fields, which are not necessary for correct citation
#*such as ''marked'', ''user keys'' and ''related''
#* however, filling these fields will be beneficial for your database users, e.g. when searching abstracts
#*these fields are facultative fields, which are '''only visible for the logged in user'''
# Yellow fields:
#*this allows a personalization of a common used references
#* e.g. ''marked'', ''user keys'' and ''related''
#* these fields are facultative fields, which are '''only visible for the logged in user'''
#* this allows a personalization of a common used references


== Filling the fields ==
== Filling the fields ==
Line 28: Line 28:
==== Author ====
==== Author ====


the author(s) of the publication
The author(s) of the publication.
*several authors separated by semicolon (;)
* Separate multiple authors by a semicolon (<code>;</code>)
*surname and '''forename(s)''' or forename-initials separated by comma (,)
* Separate  surname and forename(s) ( or forename initials) by a comma (<code>,</code>)
*no points and no space character between forename-initials
* No space character between forename initials
 
Note that you should decide whether you'd like to use fully written forenames or initials and apply this rule to all of your database records. When citing records, correct sorting of records is only possible if ''all'' cited records have either fully written forenames or just initials.


Note that you should decide whether you'd like to use fully written fornames or initials and apply this rule to all of your database records. When citing records, correct sorting of records is only possible if ''all'' cited records have either fully written forenames or just initials.
Example:


  example: Granskog,MA; Virkanen, J
  Granskog,MA; Virkanen, J


==== is Editor ====
==== is Editor ====


'''Yes''' if author is Editor
'''Yes''' if author is editor.
*please activate, if persons, entered in ''author''-field are editors of the publication
* Mark this field if persons entered in the ''author'' field are actually editors of the publication.
*only relevant for books (Type: "''book whole''")
* Only relevant for books (type "''book whole''").


==== Title ====
==== Title ====


the title of the publication
The title of the publication.
*no dot at the end
* No dot at the end.
*species-names can be set as '''italic''' by surrounding by underscore
* Species or ship name(s) can be set in ''italics'' by surrounding the name(s) with underscores.
*use "[super:...]" to impose words
* Wrapping superscript letters with <code>[super:...]</code> will cause them to appear above the normal text baseline.
*use "[sub:...]" to lower words
* Wrapping subscript letters with <code>[sub:...]</code> will cause them to appear below the normal text baseline.
examples:
 
Examples:
 
  Feeding of _Sprattus sprattus_ in the Baltic Sea
  Feeding of _Sprattus sprattus_ in the Baltic Sea
  Decomposition of [super:14]C-labelled glucose
  Decomposition of [super:14]C-labelled glucose
Line 57: Line 61:
==== Type ====
==== Type ====


defines the type of the publication
Defines the type of the publication.
*simply select an item from drop-down-list
* Simply select an item from the drop-down list.
*'''this entry is used for defining the citation style of the publication'''. Therefore selection should be made carfully
* Note that the publication type will influence the visibility of related files (e.g. .pdf files). By default, for publications of type "''Thesis''", attached files are also visible for not-logged in users.
*this entry defines visibility of related files (e.g. .pdf). As default, for publications of Type="''Thesis''" the files are visible for not logged in users, as well
*see [[Configuring refbase|configuration of refbase]] to learn how to add/remove entries in the list


==== Year ====
==== Year ====


the year of the publication
The year of the publication.
*enter in four-digit-style
* Enter years in four-digit style.
  example: 2003
 
Example:
 
  2003


==== Publication ====
==== Publication ====


complete name of publication
The complete name of the publication.
*insert here the complete (!) name of the Journal (if Type=''Journal Article'') or of the book (if Type=''Book Chapter'')
* Insert here the complete name of the Journal (if type ''Journal Article'') or book (if type ''Book Chapter'').
*abbreviated Jounal-names has to be entered in the field "''Abbrev Jounal''"
* Abbreviated jounal names should be entered in the "''Abbrev Jounal''" field.
*'''a list of journal-names and -abbreviations (related to aquatic sciences) can be found by open ''journals.php'' in the root directory of the refbase URL'''
 
examples:
Examples:
 
  Canadian Journal of Fisheries and Aquatic Sciences
  Canadian Journal of Fisheries and Aquatic Sciences
  The northern North Atlantic: A changing environment
  The northern North Atlantic: A changing environment
Line 81: Line 87:
==== Abbrev Journal ====
==== Abbrev Journal ====


the abbreviated name of the publication
The abbreviated name of the publication.
*enter the abbreviated journal-name without dots
* For a list of journal names and its abbreviations, see e.g. [https://images.webofknowledge.com/images/help/WOS/A_abrvjt.html Web of Science] or [https://ftp.ncbi.nih.gov/pubmed/J_Medline.txt PubMed].
*'''a list of journal-names and -abbreviations (related to aquatic sciences) can be found by open ''journals.php'' in the root directory of the refbase URL'''
 
example:
Example:
 
  Can J Fish Aquat Sci
  Can J Fish Aquat Sci


==== Volume ====
==== Volume ====


the volume of the publication
The volume of the publication.
  example: 245
 
Example:
 
  245


==== Issue ====
==== Issue ====


the issue of a publication within a volume
The issue of a publication within a volume.
*often a ''Volume'' of a journal consist of several issues
* Often, a ''Volume'' of a journal consists of several issues.
*the single booklet is called ''Issue'' and is labelled by a number
* An ''Issue'' is a single booklet and is labelled by a number.
  examples: 3 ''or'' C2
 
 
Examples:
 
  3
C2
 
==== Pages ====
==== Pages ====


defines which pages of the publication are covered with the reference
Defines which pages of the publication are covered by the reference.
*enter '''range of pages''', when using Types "''Journal Articles''" and "''Book Chapter''"
* Enter a '''range of pages''', when using types "''Journal Article''" and "''Book Chapter''".
*enter '''total number of pages''' including "''pp''" (without dot) when using Types"''Book Whole''" and "''Manuscript''"
* Enter the '''total number of pages''' including "''pp''" (without any dots) when using types "''Book Whole''" and "''Manuscript''".
examples:
 
  12 (article has only one page)
Examples:
  35-42 (article or book chapter starts at page 35 and ends at page 42)
 
  620 pp (book has 620 pages in total)
  12     ''-> article has only one page''
  35-42   ''-> article or book chapter starts at page 35 and ends at page 42''
  620 pp ''-> book has 620 pages in total''


=== Facultative fields (white fields) ===
=== Facultative fields (white fields) ===
Line 113: Line 129:
==== Corporate Author ====
==== Corporate Author ====


the institution or society to which so the author is associated
The institution or society associated with the author.
*defines the institution under which the author published his work
* Usually the institution under which the author published his/her work.
*for Diploma- or Phd-thesis this would be the name of the university/department
* For Diploma or Phd theses, this would be the name of the university/department.
  example: Leibniz-Institute for Marine Sciences at the University of Kiel
 
Example:
 
  Leibniz-Institute for Marine Sciences at the University of Kiel


==== Thesis ====
==== Thesis ====


the type of a thesis
The type of a thesis.
*if the publication is a thesis, this field defines the type of academic degree
* If the publication is a thesis, this field defines the type of academic degree.
*see [[Configuring refbase|configuration of refbase]] to learn how to add/remove entries in the list
 
  examples: diploma thesis, Ph.D.thesis, Doctoral thesis, Habilitation thesis
Examples:
 
  diploma thesis
Ph.D.thesis
Doctoral thesis
Habilitation thesis


==== Adress ====
==== Adress ====


the adress of the authors
The address and/or contact information of the author(s).
*contains contact informations, how to contact the authors (in most cases the first author) of the paper (e.g. postal adress, Fax, email et.)
* Any info on how to contact the corresponding author(s) (often the first author of the paper), e.g. postal address of author institution, email address etc.).
example:
 
  Granskog: Department of Geophysics, P.O. Box 64, FIN-00014
Example:
University of Helsinki, Finland, Email: mats@iki.fi;
 
  Meiners: Institute for Polar Ecology, University of Kiel,
  Granskog: Department of Geophysics, P.O. Box 64, FIN-00014 University of Helsinki, Finland, Email: mats@iki.fi;
Wischhofstrasse 1-3, D-24148 Kiel, Germany
  Meiners: Institute for Polar Ecology, University of Kiel, Wischhofstrasse 1-3, D-24148 Kiel, Germany


==== Keywords ====
==== Keywords ====


the keywords given by the author
The keywords given by the author.
*contains keywords, as given in the article
* Contains keywords, as given in the article.
*your personal keywords can be entered under [[Adding Records#User Keys|User Keys]]
* Your personal keywords can be entered under "[[Adding_records#User Keys|User Keys]]".
*multiple items should be seperated by semicolon (";")
* Multiple keywords should be separated by a semicolon (<code>;</code>).
examples:
 
Examples:
 
  Baltic Sea; hydroacoustic; Sprat; Herring; GAM
  Baltic Sea; hydroacoustic; Sprat; Herring; GAM


==== Abstract ====
==== Abstract ====


the abstract for this publication (if any)as given by the author
The abstract of this publication (if any) as given by the author.
*some browsers (e.g. firefox) have problems with pasting in text with line breaks. So please remove line breaks before pasting the text in these cases.


==== Publisher ====
==== Publisher ====
Line 154: Line 179:


==== User Keys ====
==== User Keys ====
==== Marked & Selected ====
* Both fields can be used to permanently "mark" (or "select") records so that one can easily come back to these records later on. It's up to you how you use these fields.
* The "selected" field is meant to indicate your "selected publications". This can be used to easily gather all publications of a particular author that shall be included on the institute's web site. Here's an example:
[http://polaris.ipoe.uni-kiel.de/refs/show.php?author=piepenburg,%20d&userID=4&selected=yes&submit=Cite&showRows=100&citeOrder=year&headerMsg=Publications%20of%20**Dieter%20Piepenburg**: Publications of Dieter Piepenburg]
: In the above URL, note the use of the <code>&selected=yes</code> bit. I.e. the above URL displays all selected records that were authored by "D. Piepenburg" in Citation view (grouped by publication year), and adds a header message above the results list.
: For more info, please see how to setup dynamically updating [[Auto-updating_author/group_bibliographies|author (or group) bibliographies]].


[[Category:Usage]]
[[Category:Usage]]
__NOEDITSECTION__
__NOEDITSECTION__

Latest revision as of 18:49, 20 November 2023

General requirement for adding records

  • By default, one has to be logged in to edit a record. This default can be changed by the admin.

General description of the Add Record page

Open the Add record page by clicking the link at the top of every page.

  • The Add record page has several input fields, which are grouped. Groups are indicated by color coding:
  1. Grey fields:
    • e.g. author, title, year and publication
    • these are mandatory fields, which are necessary for correct citation of references
  2. White fields:
    • e.g. abstract, keywords and ISBN
    • these are facultative fields, which are not necessary for correct citation
    • however, filling these fields will be beneficial for your database users, e.g. when searching abstracts
  3. Yellow fields:
    • e.g. marked, user keys and related
    • these fields are facultative fields, which are only visible for the logged in user
    • this allows a personalization of a common used references

Filling the fields

Hints for filling the fields should be displayed when moving the mouse over a field. More information is given below and at the definition page for the refs MySQL table.

Mandatory fields (grey fields)

Author

The author(s) of the publication.

  • Separate multiple authors by a semicolon (;)
  • Separate surname and forename(s) ( or forename initials) by a comma (,)
  • No space character between forename initials

Note that you should decide whether you'd like to use fully written forenames or initials and apply this rule to all of your database records. When citing records, correct sorting of records is only possible if all cited records have either fully written forenames or just initials.

Example:

Granskog,MA; Virkanen, J

is Editor

Yes if author is editor.

  • Mark this field if persons entered in the author field are actually editors of the publication.
  • Only relevant for books (type "book whole").

Title

The title of the publication.

  • No dot at the end.
  • Species or ship name(s) can be set in italics by surrounding the name(s) with underscores.
  • Wrapping superscript letters with [super:...] will cause them to appear above the normal text baseline.
  • Wrapping subscript letters with [sub:...] will cause them to appear below the normal text baseline.

Examples:

Feeding of _Sprattus sprattus_ in the Baltic Sea
Decomposition of [super:14]C-labelled glucose
Factors controlling CaCO[sub:2] dissolution in the Weddell Sea

Type

Defines the type of the publication.

  • Simply select an item from the drop-down list.
  • Note that the publication type will influence the visibility of related files (e.g. .pdf files). By default, for publications of type "Thesis", attached files are also visible for not-logged in users.

Year

The year of the publication.

  • Enter years in four-digit style.

Example:

2003

Publication

The complete name of the publication.

  • Insert here the complete name of the Journal (if type Journal Article) or book (if type Book Chapter).
  • Abbreviated jounal names should be entered in the "Abbrev Jounal" field.

Examples:

Canadian Journal of Fisheries and Aquatic Sciences
The northern North Atlantic: A changing environment

Abbrev Journal

The abbreviated name of the publication.

Example:

Can J Fish Aquat Sci

Volume

The volume of the publication.

Example:

245

Issue

The issue of a publication within a volume.

  • Often, a Volume of a journal consists of several issues.
  • An Issue is a single booklet and is labelled by a number.

Examples:

3
C2

Pages

Defines which pages of the publication are covered by the reference.

  • Enter a range of pages, when using types "Journal Article" and "Book Chapter".
  • Enter the total number of pages including "pp" (without any dots) when using types "Book Whole" and "Manuscript".

Examples:

12      -> article has only one page
35-42   -> article or book chapter starts at page 35 and ends at page 42
620 pp  -> book has 620 pages in total

Facultative fields (white fields)

Corporate Author

The institution or society associated with the author.

  • Usually the institution under which the author published his/her work.
  • For Diploma or Phd theses, this would be the name of the university/department.

Example:

Leibniz-Institute for Marine Sciences at the University of Kiel

Thesis

The type of a thesis.

  • If the publication is a thesis, this field defines the type of academic degree.

Examples:

diploma thesis
Ph.D.thesis
Doctoral thesis
Habilitation thesis

Adress

The address and/or contact information of the author(s).

  • Any info on how to contact the corresponding author(s) (often the first author of the paper), e.g. postal address of author institution, email address etc.).

Example:

Granskog: Department of Geophysics, P.O. Box 64, FIN-00014 University of Helsinki, Finland, Email: mats@iki.fi;
Meiners: Institute for Polar Ecology, University of Kiel, Wischhofstrasse 1-3, D-24148 Kiel, Germany

Keywords

The keywords given by the author.

  • Contains keywords, as given in the article.
  • Your personal keywords can be entered under "User Keys".
  • Multiple keywords should be separated by a semicolon (;).

Examples:

Baltic Sea; hydroacoustic; Sprat; Herring; GAM

Abstract

The abstract of this publication (if any) as given by the author.

Publisher

User fields (yellow fields)

User Keys

Marked & Selected

  • Both fields can be used to permanently "mark" (or "select") records so that one can easily come back to these records later on. It's up to you how you use these fields.
  • The "selected" field is meant to indicate your "selected publications". This can be used to easily gather all publications of a particular author that shall be included on the institute's web site. Here's an example:
Publications of Dieter Piepenburg
In the above URL, note the use of the &selected=yes bit. I.e. the above URL displays all selected records that were authored by "D. Piepenburg" in Citation view (grouped by publication year), and adds a header message above the results list.
For more info, please see how to setup dynamically updating author (or group) bibliographies.