Differences

This shows you the differences between two versions of the page.

3.1.1:bibliographical_reference_editor [2010/06/22 10:56]
Stephan Tittel
3.1.1:bibliographical_reference_editor [2010/09/16 13:13] (current)
Line 1: Line 1:
 +====== Bibliographical References ======
 +
 +docendo uses a data model simliar to [[wp>BibTeX]] to store bibliographical references. Each reference is stored as a seperate resource to enable re-use in different sections and/or courses.
 +
 +<note tip>You can import whole lists of bibliographical references at once (if they are in BibTeX format) using the [[.:bibliographical_reference_editor#importing_bibliographical_references|import function]].</note>
 +
 +===== Creating bibliographical references =====
 +
 +<box 230px right round blue>{{.:screenshots:bibliographical_reference.png?200}}</box|Screenshot: Bibliographical Reference Editor>
 +
 +Starting from the [[.:browser|Resource Browser]], select **Bibliographical reference** from the drop-down in the top-left **New** category and press the **Create** button. On the next page, choose the desired [[.:bibliographical_reference_editor#supported_bibliographical_reference_types|reference type]] - this will open the bibliographical reference editor (see screenshot to the right). Each reference type has a set of mandatory and optional [[.:bibliographical_reference_editor#field_descriptions|fields]].
 +
 +The field //Key// may be left empty - it will automatically be assigned a value based on the given author(s) and year when saving.
 +
 +<html><div style="clear:both"></div></html>
 +
 +==== Importing bibliographical references ====
 +
 +<box 230px right round blue>{{.:screenshots:bibliographical_reference_start.png?200}}</box|Screenshot: Importing bibliographical references>
 +
 +If you already have bibliographical references in BibTeX format exported from other systems, you can import them by selecting **Bibliographical reference** from the drop-down in the top-left **New** category and pressing the **Create** button. From there you can upload a text file (please note, that the file suffix should be **.txt** in order to be accepted) with BibTeX content which will then be parsed. The found entries will be displayed prior to importing.
 +
 +Please see the section below for sample content of a valid text file for import.
 +
 +<box 100% round blue|Sample BibTeX file content for import>
 +<code>
 +@inproceedings{ BSRS09,
 + author = {Doreen B{\"o}hnstedt and Philipp Scholl and Christoph Rensing and Ralf Steinmetz},
 + title = {Modeling Personal Knowledge Networks to Support Resource Based Learning},
 + month = {Sep},
 + year = {2009},
 + publisher = {Verlag der Technischen Universit{\"a}t Graz, Austria, Universiti Malaysia Sarawak, Malaysia, and Know-Center, Austria},
 + booktitle = {Proceedings of 9th International Conference on Knowledge Management and Knowledge Technologies (I-KNOW'09)},
 + pages = {309-316},
 + url = {ftp://ftp.kom.tu-darmstadt.de/pub/papers/DB_i-know_2009.pdf},
 +}
 +@inproceedings{ BSR+09,
 + author = {Doreen B{\"o}hnstedt and Philipp Scholl and Christoph Rensing and Ralf Steinmetz},
 + title = {Collaborative Semantic Tagging of Web Resources on the Basis of Individual Knowledge Networks},
 + month = {Jun},
 + year = {2009},
 + publisher = {Springer-Verlag Berlin Heidelberg 2009},
 + booktitle = {Proceedings of First and Seventeenth International Conference on User Modeling, Adaptation, and Personalization UMAP 2009},
 + number = {Vol. 5535},
 + pages = {379-384},
 + volume = {Lecture Notes in Computer Science  },
 + url = {http://www.springerlink.com/content/h6846r20k71g1247/?p=5aa4691ffdff48de9eefcc16279cad6d\&pi=39}
 +}
 +@inproceedings{ SDB+09-2,
 + author = {Philipp Scholl and Renato Dominguez Garcia and Doreen B{\"o}hnstedt and Christoph Rensing and Ralf Steinmetz},
 + title = {Towards Language–Independent Web Genre Detection},
 + month = {Apr},
 + year = {2009},
 + organization = {ACM},
 + address = {Madrid, Spain},
 + booktitle = {WWW '09: Proceedings of the 18th international conference on World wide web},
 + pages = {1157--1158},
 + url = {http://portal.acm.org/citation.cfm?id=1526709.1526905 http://www.kom.tu-darmstadt.de/\"http://portal.acm.org/citation.cfm?id}
 +}
 +</code>
 +</box>
 +
 +===== Using bibliographical references =====
 +
 +<box 256px right round blue>{{.:screenshots:bibliographical_reference_section_editor.png|Section Editor: Insert bibliographical reference button}}</box|Screenshot: Inserting a bibliogra-phical reference in the Section Editor>
 +
 +Bibliographical references can be added to content pages from within the [[.:section_editor|Section Editor]]. The {{.:icons:book.gif|"Insert bibliographical reference" button}} button (see screenshot to the right) opens a [[.:search|search]] dialog that lets you insert existing bibliographical references at the selected text cursor position. By default, the //key// of the reference will be inserted as text (highlighted in green with the bibliographical reference symbol next to it), but you may edit it to better suit the given context.
 +
 +As soon as a section in a course contains a bibliographical reference, the course export function will generate a page at the end of the course containing all bibliographical references in the order of occurance. This page will also contain a link that when clicked will display all bibliographical references of the course in BibTeX format.
 +
 +===== Supported bibliographical reference types =====
 +
 +<box 100% round blue|Supported bibliographical reference types and their required/optional fields>
 +^ Reference type ^ BibTex type ^ Description ^ Required fields ^ Optional fields ^
 +| **Journal Article** | article | An article from a journal or magazine. | author, title, journal, year | volume, number, pages, month, note, url |
 +| **Book** | book | A book with an explicit publisher. |author, title, publisher, year | volume, number, series, address, edition, month, note, url |
 +| **Booklet** | booklet | A work that is printed and bound, but without a named publisher or sponsoring institution. | title | author, howpublished, address, month, year, note, url |
 +| **Conference** | conference | The same as Conference Paper, included for compatibility reasons. |author, title, booktitle, year | edition, volume, number, series, pages, address, month, organisation, publisher, note, url |
 +| **Chapter in Book** | inbook | A part of a book, usually untitled. May be a chapter (or section or whatever) and/or a range of pages. | author, title, chapter/pages, publisher, year | volume, number, series, type, address, edition, month, note, url |
 +| **Conference Paper** | inproceedings | An article in a conference proceedings. | author, title, booktitle, year | edition, volume, number, series, pages, address, month, organisation, publisher, note, url |
 +| **Manual** | manual | Technical documentation. | title |author, organization, address, edition, month, year, note, url |
 +| **Master Thesis** | mastersthesis | A Master's thesis. | author, title, school, year | type, address, month, note, url |
 +| **PhD Thesis** | phdthesis | A Ph.D. thesis. | author, title, school, year | type, address, month, note, url |
 +| **Proceedings** | proceedings | The proceedings of a conference. | title, year | edition, volume, number, series, address, month, organisation, publisher, note, url |
 +| **Technical Report** | techreport | A report published by a school or other institution, usually numbered within a series. | author, title, institution, year | type, number, address, month, note, url |
 +| **Unpublished** | unpublished | A document having an author and title, but not formally published. | author, title, note | month, year |
 +</box>
 +
 +===== Field descriptions =====
 +
 +<box 700px left round blue|Entry field descriptions>
 +^ Field ^ Description ^
 +| **address** | Publisher's address (usually just the city, but can be the full address for lesser-known publishers) |
 +| **author** | The name(s) of the author(s) (in the case of more than one author, separated by and) |
 +| **booktitle** | The title of the book, if only part of it is being cited |
 +| **chapter** | The chapter number |
 +| **edition** | The edition of a book, long form (such as "first" or "second") |
 +| **howpublished** | How it was published, if the publishing method is nonstandard |
 +| **institution** | The institution that was involved in the publishing, but not necessarily the publisher |
 +| **journal** | The journal or magazine the work was published in |
 +| **month** | The month of publication (or, if unpublished, the month of creation) |
 +| **note** | Miscellaneous extra information |
 +| **number** | The "number" of a journal, magazine, or tech-report, if applicable. (Most publications have a "volume", but no "number" field.) |
 +| **organization** | The conference sponsor |
 +| **pages** | Page numbers, separated either by commas or double-hyphens. For books, the total number of pages. |
 +| **publisher** | The publisher's name |
 +| **school** | The school where the thesis was written |
 +| **series** | The series of books the book was published in (e.g. "The Hardy Boys" or "Lecture Notes in Computer Science") |
 +| **title** | The title of the work |
 +| **type** | The type of tech-report, for example, "Research Note" |
 +| **url** | The WWW address |
 +| **volume** | The volume of a journal or multi-volume book |
 +| **year** | The year of publication (or, if unpublished, the year of creation) |
 +</box>
 +
 +===== External links =====
 +  * [[wp>BibTeX|Wikipedia on BibTeX]]
 +  * [[http://www.fb10.uni-bremen.de/anglistik/langpro/bibliographies/jacobsen-bibtex.html|BibTeX tutorial by Dana Jacobsen]]
 
 
Recent changes RSS feed Creative Commons License Donate Powered by PHP Valid XHTML 1.0 Valid CSS Driven by DokuWiki