diff --git a/documentation/entities/reference_types.md b/documentation/entities/reference_types.md index d49a3f0c..13c20a21 100644 --- a/documentation/entities/reference_types.md +++ b/documentation/entities/reference_types.md @@ -1,12 +1,15 @@ -Current reference types & their field labels / field names (29.09.2024) +# Reference types -As of 29.09.2024 there is no UI to add more entries however you can do it by altering the db itself. +Note: This file is old and should be checked and updated. -In the test_data/sqlfiles/now_test.sql code related to adding reference types is around rows 3665-3700 and the fields for the data types are added around rows 3175-3525. +Current reference types & their field labels / field names -Do concider other options before you try to alter the data by hand. +In the `test_data/sqlfiles/now_test.sql` file, code related to adding reference types is around rows 3665-3700 and the fields for the data types are added around rows 3175-3525. + +Do consider other options before you try to alter the data by hand. ## Existing fields & their ids + title_primary 1 authors_primary 2 date_primary 3 @@ -32,237 +35,238 @@ Do concider other options before you try to alter the data by hand. exact_date 23 "ref_type_id": 1, "ref_type": "Journal"' - Title / title_primary - Authors / authors_primary - Year / date_primary - Journal / journal_id - Volume / volume - Issue / issue - Start Page / start_page - End Page / end_page - Publisher / publisher - City / pub_place - Title of Issue / title_secondary - Editors of Issue / authors_secondary - Series Title / title_series - ISSN/ISBN / issn_isbn - Abstract / ref_abstract - Web/URL / web_url - Notes / gen_notes - Language / printed_language +Title / title_primary +Authors / authors_primary +Year / date_primary +Journal / journal_id +Volume / volume +Issue / issue +Start Page / start_page +End Page / end_page +Publisher / publisher +City / pub_place +Title of Issue / title_secondary +Editors of Issue / authors_secondary +Series Title / title_series +ISSN/ISBN / issn_isbn +Abstract / ref_abstract +Web/URL / web_url +Notes / gen_notes +Language / printed_language Mandatory fields: title_primary OR title_secondary OR title_series OR gen_notes, date_primary, authors_primary OR authors_secondary, journal "ref_type_id": 2, "ref_type": "Book", - Title / title_primary - Authors / authors_primary - Year / date_primary - Edition / volume - Volume / issue - No of Pages / end_page - Publisher / publisher - City / pub_place - Editors / authors_secondary - Series Title / title_series - Series Editors / authors_series - ISBN / issn_isbn - Abstract / ref_abstract - Web/URL / web_url - Notes / gen_notes - Language / printed_language +Title / title_primary +Authors / authors_primary +Year / date_primary +Edition / volume +Volume / issue +No of Pages / end_page +Publisher / publisher +City / pub_place +Editors / authors_secondary +Series Title / title_series +Series Editors / authors_series +ISBN / issn_isbn +Abstract / ref_abstract +Web/URL / web_url +Notes / gen_notes +Language / printed_language Mandatory fields: title_primary OR title_series OR gen_notes, date_primary, authors_primary OR authors_secondary OR authors_series "ref_type_id": 3, "ref_type": Book Chapter' - Title / title_primary - Authors / authors_primary - Year / date_primary - Edition / volume - Chapter No / issue - Start Page / start_page - End Page / end_page - Publisher / publisher - City / pub_place - Book Title / title_secondary - Editors / authors_secondary - Series Title / title_series - Series Editors / authors_series - ISBN / issn_isbn - Abstract / ref_abstract - Web/URL / web_url - Volume / misc_2 - Notes / gen_notes - Language / printed_language +Title / title_primary +Authors / authors_primary +Year / date_primary +Edition / volume +Chapter No / issue +Start Page / start_page +End Page / end_page +Publisher / publisher +City / pub_place +Book Title / title_secondary +Editors / authors_secondary +Series Title / title_series +Series Editors / authors_series +ISBN / issn_isbn +Abstract / ref_abstract +Web/URL / web_url +Volume / misc_2 +Notes / gen_notes +Language / printed_language Mandatory fields: title_primary OR title_secondary OR title_series OR gen_notes, date_primary, authors_primary OR authors_secondary OR authors_series "ref_type_id": 4, "ref_type": Thesis/Dissertation' - Title / title_primary - Authors / authors_primary - Year / date_primary - No of Pages / end_page - Institution / publisher - Abstract / ref_abstract - Web/URL / web_url - Degree / misc_1 - Notes / gen_notes - Language / printed_language +Title / title_primary +Authors / authors_primary +Year / date_primary +No of Pages / end_page +Institution / publisher +Abstract / ref_abstract +Web/URL / web_url +Degree / misc_1 +Notes / gen_notes +Language / printed_language Mandatory fields: title_primary OR gen_notes, date_primary, authors_primary "ref_type_id": 5, "ref_type": Conference Proceeding' - Title / title_primary - Authors / authors_primary - Publication Year / date_primary - Journal / journal_id - Volume / volume - Edition / issue - Start Page / start_page - End Page / end_page - Publisher / publisher - City / pub_place - Title of Conference / title_secondary - Editors / authors_secondary - Year of Conference / date_secondary - Series Title / title_series - Series Editors / authors_series - Abstract / ref_abstract - Web/URL / web_url - Notes / gen_notes - Language / printed_language +Title / title_primary +Authors / authors_primary +Publication Year / date_primary +Journal / journal_id +Volume / volume +Edition / issue +Start Page / start_page +End Page / end_page +Publisher / publisher +City / pub_place +Title of Conference / title_secondary +Editors / authors_secondary +Year of Conference / date_secondary +Series Title / title_series +Series Editors / authors_series +Abstract / ref_abstract +Web/URL / web_url +Notes / gen_notes +Language / printed_language Mandatory fields: title_primary OR title_secondary OR title_series OR gen_notes, date_primary, authors_primary OR authors_secondary OR authors_series, journal "ref_type_id": 6, "ref_type": Electronic Citation' - Title / title_primary - Authors / authors_primary - Last Update (Year) / date_primary - Organisation / title_secondary - Editors / authors_secondary - Abstract / ref_abstract - Web/URL / web_url - Last Update (Day Month) / misc_1 - Notes / gen_notes - Language / printed_language - Access Date / exact_date +Title / title_primary +Authors / authors_primary +Last Update (Year) / date_primary +Organisation / title_secondary +Editors / authors_secondary +Abstract / ref_abstract +Web/URL / web_url +Last Update (Day Month) / misc_1 +Notes / gen_notes +Language / printed_language +Access Date / exact_date Mandatory fields: title_primary OR title_secondary OR gen_notes, date_primary, authors_primary OR authors_secondary, exact_date "ref_type_id": 7, "ref_type": Internet Communication' - Subject / title_primary - Sender / authors_primary - Year / date_primary - Recipient / authors_secondary - Sender's e-mail / misc_1 - Recipient's e-mail / misc_2 - Notes / gen_notes - Language / printed_language - Date of Message / exact_date +Subject / title_primary +Sender / authors_primary +Year / date_primary +Recipient / authors_secondary +Sender's e-mail / misc_1 +Recipient's e-mail / misc_2 +Notes / gen_notes +Language / printed_language +Date of Message / exact_date Mandatory fields: title_primary OR gen_notes, date_primary, authors_primary OR authors_secondary, exact_date "ref_type_id": 8, "ref_type": Report' - Title / title_primary - Authors / authors_primary - Year / date_primary - Report Number / volume - Start Page / start_page - End Page / end_page - Publisher / publisher - Pub Place / pub_place - Report Name / title_secondary - Editors / authors_secondary - Series Title / title_series - Series Editors / authors_series - Abstract / ref_abstract - Web/URL / web_url - Notes / gen_notes - Language / printed_language +Title / title_primary +Authors / authors_primary +Year / date_primary +Report Number / volume +Start Page / start_page +End Page / end_page +Publisher / publisher +Pub Place / pub_place +Report Name / title_secondary +Editors / authors_secondary +Series Title / title_series +Series Editors / authors_series +Abstract / ref_abstract +Web/URL / web_url +Notes / gen_notes +Language / printed_language Mandatory fields: title_primary OR title_secondary OR title_series OR gen_notes, date_primary, authors_primary OR authors_secondary OR authors_series "ref_type_id": 9, "ref_type": Unpublished Work' - Title / title_primary - Authors / authors_primary - Year / date_primary - Organisation / title_secondary - Editors / authors_secondary - Series Title / title_series - Series Editors / authors_series - Abstract / ref_abstract - Web/URL / web_url - Notes / gen_notes - Language / printed_language +Title / title_primary +Authors / authors_primary +Year / date_primary +Organisation / title_secondary +Editors / authors_secondary +Series Title / title_series +Series Editors / authors_series +Abstract / ref_abstract +Web/URL / web_url +Notes / gen_notes +Language / printed_language Mandatory fields: title_primary OR title_secondary OR title_series OR gen_notes, date_primary, authors_primary OR authors_secondary OR authors_series "ref_type_id": 10, "ref_type": Personal Communication' - Authors / authors_primary - Year / date_primary - Recipients / authors_secondary - Type / misc_1 - Notes / gen_notes - Language / printed_language - Date Sent / exact_date +Authors / authors_primary +Year / date_primary +Recipients / authors_secondary +Type / misc_1 +Notes / gen_notes +Language / printed_language +Date Sent / exact_date Mandatory fields: gen_notes, date_primary, authors_primary OR authors_secondary, exact_date "ref_type_id": 11, "ref_type": Manuscript' - Title / title_primary - Authors / authors_primary - Date / date_primary - Organisation / title_secondary - Editors / authors_secondary - Series Title / title_series - Series Editors / authors_series - Notes / gen_notes - Language / printed_language - Date / exact_date +Title / title_primary +Authors / authors_primary +Date / date_primary +Organisation / title_secondary +Editors / authors_secondary +Series Title / title_series +Series Editors / authors_series +Notes / gen_notes +Language / printed_language +Date / exact_date Mandatory fields: title_primary OR title_secondary OR title_series OR gen_notes, date_primary, authors_primary OR authors_secondary OR authors_series, exact_date "ref_type_id": 12, "ref_type": Notes' - Subject / title_primary - Authors / authors_primary - Year / date_primary - Notes / gen_notes - Date / exact_date +Subject / title_primary +Authors / authors_primary +Year / date_primary +Notes / gen_notes +Date / exact_date Mandatory fields: title_primary OR gen_notes, date_primary, authors_primary, exact_date "ref_type_id": 13, "ref_type": Editing' - Title / title_primary - Authors / authors_primary - Year / date_primary - Notes / gen_notes - Date / exact_date +Title / title_primary +Authors / authors_primary +Year / date_primary +Notes / gen_notes +Date / exact_date Mandatory fields: title_primary OR gen_notes, date_primary, authors_primary, exact_date "ref_type_id": 14, "ref_type": Undefined' - title_primary / title_primary - authors_primary / authors_primary - date_primary / date_primary - journal_id / journal_id - volume / volume - issue / issue - start_page / start_page - end_page / end_page - publisher / publisher - pub_place / pub_place - title_secondary / title_secondary - authors_secondary / authors_secondary - date_secondary / date_secondary - title_series / title_series - authors_series / authors_series - issn_isbn / issn_isbn - abstract / abstract - web_url / web_url - misc_1 / misc_1 - misc_2 / misc_2 - gen_notes / gen_notes - language / language - exact_date / exact_date +title_primary / title_primary +authors_primary / authors_primary +date_primary / date_primary +journal_id / journal_id +volume / volume +issue / issue +start_page / start_page +end_page / end_page +publisher / publisher +pub_place / pub_place +title_secondary / title_secondary +authors_secondary / authors_secondary +date_secondary / date_secondary +title_series / title_series +authors_series / authors_series +issn_isbn / issn_isbn +abstract / abstract +web_url / web_url +misc_1 / misc_1 +misc_2 / misc_2 +gen_notes / gen_notes +language / language +exact_date / exact_date Mandatory fields: title_primary OR title_secondary OR title_series OR gen_notes, date_primary, authors_primary OR authors_secondary OR authors_series, exact_date, journal -* In old php test version instead of journal, journal_id had to be defined. That seems odd, since when creating a new journal, journal_id will not initally be defined. So that will not be done here. \ No newline at end of file + +- In old php test version instead of journal, journal_id had to be defined. That seems odd, since when creating a new journal, journal_id will not initially be defined. So that will not be done here. diff --git a/documentation/entities/species.md b/documentation/entities/species.md index bcd34fdd..e7c78287 100644 --- a/documentation/entities/species.md +++ b/documentation/entities/species.md @@ -1,4 +1,4 @@ -# Localities +# Species ## Required fields diff --git a/documentation/entities/time_bound.md b/documentation/entities/time_bound.md index 74139938..4b781105 100644 --- a/documentation/entities/time_bound.md +++ b/documentation/entities/time_bound.md @@ -1,4 +1,4 @@ -### Time Bound +### Time Bounds A Time Bound can be given the following information: diff --git a/documentation/entities/time_unit.md b/documentation/entities/time_unit.md index 74401e47..bb8cdb1b 100644 --- a/documentation/entities/time_unit.md +++ b/documentation/entities/time_unit.md @@ -1,4 +1,4 @@ -### Time Unit +### Time Units A Time Unit can be given the following information: