Benutzerhandbuch: Difference between revisions
(Created page with "Die MediaWiki Erweiterung "BibManager" ermöglicht das Verwalten von bibliographischen Daten im Wiki. Diese Dokumentation beschreibt den Umgang mit der Erweiterung. Sie behandelt...") |
No edit summary |
||
| (6 intermediate revisions by 4 users not shown) | |||
| Line 1: | Line 1: | ||
Die MediaWiki Erweiterung "BibManager" ermöglicht das Verwalten von bibliographischen Daten im Wiki. Diese Dokumentation beschreibt den Umgang mit der Erweiterung. Sie behandelt auch die "SaltWiki" Erweiterung, welche den "BibManager" für die Ansprüche des Hornemann | Die MediaWiki Erweiterung "BibManager" ermöglicht das Verwalten von bibliographischen Daten im Wiki. Diese Dokumentation beschreibt den Umgang mit der Erweiterung. Sie behandelt auch die "SaltWiki" Erweiterung, welche den "BibManager" für die Ansprüche des Hornemann Instituts modifiziert, sowie die "SaltWikiUpload" Erweiterung welche die Spezialseite "Hochladen" um Felder für die Eingabe von Metadaten erweitert. | ||
==== | == BibManager und SaltWiki == | ||
Folgende | Der folgende Abschnitt befasst sich mit der Bedienung der "BibManager" Erweiterung. | ||
=== Spezialseiten === | |||
Unter [[Special:SpecialPages|Spezial:Spezialseiten]] finden Sie einen Abschnitt "BibManager", der Sie zu den verschiedenen Oberflächen bringt: | |||
[[Image:BibManager_SpecialPagesGroup.png|border|Eintrag auf [[Special:SpecialPages|Spezial:Spezialseiten]]. Englische Version.]] | |||
=== Einträge anlegen === | |||
Auf der Spezialseite "Bibliographieeintrag anlegen" (Englisch "Add new entry") können Sie aus einer Liste von Referenztypen auswählen und werden anschließend auf ein Formular weitergeleitet, in dem Sie Angaben zu dem bibliographischen Eintrag machen können. | |||
[[Image:BibManager_CreateEntry.png|border|Englische Version.]] | |||
=== Einträge importieren === | |||
Alternativ zum Einfügen über ein Formular können auch Sie dem Link auf die Spezialseite "Bibliographien importieren" (Englisch: "Import BibTeX") folgen und dort eine dem BibTeX-Format entsprechende Zeichenkette eingeben. Fügen Sie in das Textfeld die zu importierende BibTeX Zeichenkette ein. Auf diese Weise können auch mehrere Einträge gleichzeitig angelegt werden. | |||
[[Image:BibManager_Import.png|border|Englische Version.]] | |||
HINWEIS: Durch die "SaltWiki" Erweiterung wird das Format '''Autorenkürzel:Jahr''' für das Zitatkürzel vorgegeben! | |||
Folgende Felder sind zulässig: | |||
{| class="contenttable" | |||
| valign="top" | | |||
* <code>address</code> | * <code>address</code> | ||
* <code>annote</code> | * <code>annote</code> | ||
| Line 35: | Line 37: | ||
* <code>editor</code> | * <code>editor</code> | ||
* <code>eprint</code> | * <code>eprint</code> | ||
| valign="top" | | |||
* <code>howpublished</code> | * <code>howpublished</code> | ||
* <code>institution</code> | * <code>institution</code> | ||
| Line 44: | Line 47: | ||
* <code>organization</code> | * <code>organization</code> | ||
* <code>pages</code> | * <code>pages</code> | ||
| valign="top" | | |||
* <code>publisher</code> | * <code>publisher</code> | ||
* <code>school</code> | * <code>school</code> | ||
| Line 52: | Line 56: | ||
* <code>volume</code> | * <code>volume</code> | ||
* <code>year</code> | * <code>year</code> | ||
|} | |||
Durch die "SaltWiki" Erweiterung kommen zudem die Felder <code>doi</code> und <code>fulltext</code> hinzu. | Durch die "SaltWiki" Erweiterung kommen zudem die Felder <code>doi</code> und <code>fulltext</code> hinzu. | ||
===== | ===Einträge verwalten=== | ||
Der "Löschen"-Dialog ermöglicht Ihnen die zu löschenden Daten nochmal zu betrachten und erwartet eine Bestätigung. | Die Spezialseite "Bibliographien anzeigen: Autoren" (Englisch "Overview authors") bietet eine alphabetisch geordnete Übersicht über alle Autoren. Ein Klick auf den Namen eines Autors ruft die Spezialseite "Bibliographien verwalten" (siehe unten) mit voreingestelltem Filter auf. | ||
[[ | [[Image:BibManager_Authors.png|border|Englische Version.]] | ||
Auf der Spezialseite "Bibliographien verwalten" (Englisch "Overview") können Sie sich eine Liste aller im System vorhandenen Einträge ausgeben lassen. Sie können diese Liste auch nach bestimmten Kriterien filtern. Verwenden Sie hierzu das Formular am Anfang der Seite. | |||
Für die Arbeit im Fließtext stellt Ihnen die BibManager Erweiterung verschiedene sogenannte "Tags" zur Verfügung. Diese werden im Folgenden beschrieben. | Wenn Sie die entsprechenden Berechtigungen besitzen können Sie an dieser Stelle über die Schaltflächen in der "Aktionen" Spalte Einträge auch bearbeiten oder löschen. | ||
[[Image:BibManager_Overview.png|border|Englische Version.]] | |||
Außerdem haben Sie auf dieser Spezialseite die Möglichkeit einen oder mehrere Einträge in das BibTeX-Format zu exportieren und diese so in anderen Anwendungen zu nutzen. | |||
[[Image:BibManager_Overview_2.png|border|Englische Version.]] | |||
Um eine Zitation zu platzieren muss das Tag mit dem id Attribut in den Fließtext eingefügt werden. | === Einträge bearbeiten === | ||
(z. B. <code><nowiki><bib id="lin:1973"/></nowiki></code>) | Ob Sie einen Eintrag bearbeiten können hängt von den Berechtigungen ab, die Ihrem Benutzerkonto zugewiesen sind. Die Bearbeitungsansicht stellt Ihnen ein an den Referenztyp angepasstes Formular zur Verfügung. Sie gelangen auf diese Oberfläche, wenn Sie bei einem bestehenden Eintrag auf den "bearbeiten"-Link (Stift-Symbol) klicken. | ||
Existiert ein Zitatschlüssel dabei noch nicht im Repository wird ein Link auf | |||
[[Image:BibManager_EditEntry_2.png|border|Englische Version.]] | |||
[[ | |||
< | === Einträge löschen === | ||
< | Der Zugriff auf den "Löschen"-Dialog ist wie die Bearbeitungsansicht abhängig von Ihren Berechtigungen. Sie ermöglicht Ihnen die zu löschenden Daten nochmal zu betrachten und erwartet eine Bestätigung. Löschen können Sie einen Eintrag über das X-Symbol (siehe oben). | ||
< | [[Image:BibManager_DeleteEntry.png|border|Englische Version.]] | ||
<code><nowiki>< | |||
< | === Arbeiten im Wikiartikel === | ||
Dieses Tag ermöglicht es Abfragen | Für die Arbeit im Fließtext stellt Ihnen die "BibManager" Erweiterung verschiedene sogenannte "Tags" zur Verfügung. Diese werden im Folgenden beschrieben. | ||
< | |||
Es können mehrere Felder mit einem logischen "und" verbunden werden, indem man sie mit Kommas voneinander trennt. Feldname und Wert des Feldes sind über einen ":" voneinander getrennt. Möchte man bestimmte Werte eines Feldes mit einem logischen "oder" verknüpfen kann man das "|" Symbol als Trennzeichen verwenden. | ---- | ||
<nowiki><bib /></nowiki> | |||
Um eine Zitation zu platzieren muss das Tag mit dem <code>id</code> Attribut in den Fließtext eingefügt werden. | |||
(z.B. <code><nowiki><bib id="lin:1973"/></nowiki></code>). | |||
[[Image:BibManager_Edit_3.png|border|Englische Version.]] | |||
Eine Zitation wird im Ansichtsmodus eines Artikels in eckigen Klammern ausgegeben und bietet beim darüberfahren mit der Maus detailliertere Informationen. | |||
Existiert ein Zitatschlüssel dabei noch nicht im Repository wird ein Link auf die "Bibliographieeintrag anlegen" Spezialseite erzeugt. | |||
[[Image:BibManager_View_3.png|border|Englische Version.]] | |||
---- | |||
<nowiki><biblist /></nowiki> | |||
Dieses Tag listet alle in dem Artikel vorkommenden Zitationen (<code><nowiki><bib /></nowiki></code>) auf, gibt die entsprechend formatierten Daten aus (siehe oben) und ermöglicht den schnellen Zugriff auf die Bearbeitungsansicht und Google Scholar. Ist ein Volltext-Link verfügbar wird auch dieser angezeigt. | |||
Es besitzt keine Attribute. | |||
---- | |||
<nowiki><bibprint /></nowiki> | |||
Dieses Tag ermöglicht es Abfragen an das Repository zu stellen. Das verwendete Attribut heißt <code>filter</code> und erwartet Werte in folgendem Format: <code>feldname:wert|oderwert,feldname2:wert2</code> | |||
Es können mehrere Felder mit einem logischen "und" verbunden werden, indem man sie mit Kommas voneinander trennt. Feldname und Wert des Feldes sind über einen ":" voneinander getrennt. Möchte man bestimmte Werte eines Feldes mit einem logischen "oder" verknüpfen kann man das "|" Symbol als Trennzeichen verwenden. Mit <code>%</code> ist auch Links- und Rechtstrunkierung bei den Werten möglich. Die möglichen Feldnamen sind weiter oben beschrieben. | |||
Beispiele: | Beispiele: | ||
Zitate von | Zitate die im Feld <code>year</code> entweder den Wert 2011 oder 1989 haben. => <code>feldname:wert|oderwert</code> | ||
<bibprint filter= | <nowiki><bibprint filter="year:2011|1989" /></nowiki> | ||
Zitate von Autoren deren Name die Zeichenkette "Steiger" enthält => <code>feldname:wert</code> | |||
<nowiki><bibprint filter=“author:%Steiger%“ /></nowiki> | |||
Zitate von Autoren deren Name die Zeichenkette "Arnold" enthält ''und'' die aus dem Jahr "2011" ''oder'' "1989" stammen => <code>feldname:wert|oderwert,feldname2:wert2</code> | |||
<nowiki><bibprint filter=“year:2011|1989,author:%Arnold%“ /></nowiki> | |||
Zusätzlich kann über das <code><nowiki><bibprint /></nowiki></code> Tag durch die Verwendung des <code>citation</code> Attributs eine vollständige Ausgabe eines bestimmten Zitates erwirkt werden. | |||
<nowiki><bibprint citation="Arnold.etal:1989" /> oder <bibprint citation="Arnold:1994" /></nowiki> | |||
< | |||
[[Image:BibManager_Edit.png|border|Englische Version.]] | |||
[[Image:BibManager_View_2.png|border|Englische Version.]] | |||
<bibprint citation="Arnold.etal:1989" /> oder <bibprint citation="Arnold:1994" /> | |||
</ | |||
[[ | |||
== | |||
== SaltWikiUpload == | |||
Die Erweiterung verändert den | === Bedienung === | ||
Die "SaltWikiUpload" Erweiterung verändert den Hochladen-Dialog von MediaWiki. Über spezielle Formularfelder können Sie bereits beim hochladen einer Datei bestimmte Metadaten angegeben. | |||
[[ | |||
Zu den allgemeinen Metadaten gehören | |||
;Beschreibung: Eine kurze Beschreibung der Datei und deren Inhalts. | |||
[[ | ;Quelle: Die Quelle der Datei muss eindeutig nachvollziehbar sein. | ||
;Datum: Das Datum hilft die Aktualität der beinhalteten Daten einzuschätzen. | |||
;Autor(en): Hier können die Autoren der Datei angegeben werden. Mehrere Autoren werden über Kommas voneinander getrennt. Die angegebenen Werte werden auch zur Kategorisierung der Datei verwendet. | |||
;Berechtigung: Es ist wichtig zu erfassen welche Nutzungsrechte für die Datei verfügbar sind. Bitte hinterlegen Sie auch wer diese Rechte hält und wie man diese Person kontaktieren kann. | |||
;Schlagwörter / Kategorien: Über die hier angegebene Werte erfolgt eine Kategorisierung im MediaWiki-Kategoriesystem. Auch hier werden mehrere Werte durch Kommas voneinander getrennt. | |||
;Typ: An dieser Stelle können Sie den die Art des Inhalts der Datei auswählen. Die Auswahl wird auch als Kategorie an die Dateibschreibungsseite übermittelt. | |||
Je nach gewähltem Typ können Sie in den darunter eingeblendeten Formularfeldern weitere Daten angeben. | |||
[[Image:SaltWikiUpload_2.png|border|Englische Version.]] | |||
Auf der Dateibeschreibungsseite werden die angegebenen Informationen dann automatisch über MediaWiki Vorlagen eingebunden. | |||
[[Image:SaltWikiUpload_3.png|border|Englische Version.]] | |||
[[category:Help]] | |||
Latest revision as of 14:32, 27 August 2012
Die MediaWiki Erweiterung "BibManager" ermöglicht das Verwalten von bibliographischen Daten im Wiki. Diese Dokumentation beschreibt den Umgang mit der Erweiterung. Sie behandelt auch die "SaltWiki" Erweiterung, welche den "BibManager" für die Ansprüche des Hornemann Instituts modifiziert, sowie die "SaltWikiUpload" Erweiterung welche die Spezialseite "Hochladen" um Felder für die Eingabe von Metadaten erweitert.
BibManager und SaltWiki
Der folgende Abschnitt befasst sich mit der Bedienung der "BibManager" Erweiterung.
Spezialseiten
Unter Spezial:Spezialseiten finden Sie einen Abschnitt "BibManager", der Sie zu den verschiedenen Oberflächen bringt:
Einträge anlegen
Auf der Spezialseite "Bibliographieeintrag anlegen" (Englisch "Add new entry") können Sie aus einer Liste von Referenztypen auswählen und werden anschließend auf ein Formular weitergeleitet, in dem Sie Angaben zu dem bibliographischen Eintrag machen können.
Einträge importieren
Alternativ zum Einfügen über ein Formular können auch Sie dem Link auf die Spezialseite "Bibliographien importieren" (Englisch: "Import BibTeX") folgen und dort eine dem BibTeX-Format entsprechende Zeichenkette eingeben. Fügen Sie in das Textfeld die zu importierende BibTeX Zeichenkette ein. Auf diese Weise können auch mehrere Einträge gleichzeitig angelegt werden.
HINWEIS: Durch die "SaltWiki" Erweiterung wird das Format Autorenkürzel:Jahr für das Zitatkürzel vorgegeben!
Folgende Felder sind zulässig:
|
|
|
Durch die "SaltWiki" Erweiterung kommen zudem die Felder doi und fulltext hinzu.
Einträge verwalten
Die Spezialseite "Bibliographien anzeigen: Autoren" (Englisch "Overview authors") bietet eine alphabetisch geordnete Übersicht über alle Autoren. Ein Klick auf den Namen eines Autors ruft die Spezialseite "Bibliographien verwalten" (siehe unten) mit voreingestelltem Filter auf.
Auf der Spezialseite "Bibliographien verwalten" (Englisch "Overview") können Sie sich eine Liste aller im System vorhandenen Einträge ausgeben lassen. Sie können diese Liste auch nach bestimmten Kriterien filtern. Verwenden Sie hierzu das Formular am Anfang der Seite.
Wenn Sie die entsprechenden Berechtigungen besitzen können Sie an dieser Stelle über die Schaltflächen in der "Aktionen" Spalte Einträge auch bearbeiten oder löschen.
Außerdem haben Sie auf dieser Spezialseite die Möglichkeit einen oder mehrere Einträge in das BibTeX-Format zu exportieren und diese so in anderen Anwendungen zu nutzen.
Einträge bearbeiten
Ob Sie einen Eintrag bearbeiten können hängt von den Berechtigungen ab, die Ihrem Benutzerkonto zugewiesen sind. Die Bearbeitungsansicht stellt Ihnen ein an den Referenztyp angepasstes Formular zur Verfügung. Sie gelangen auf diese Oberfläche, wenn Sie bei einem bestehenden Eintrag auf den "bearbeiten"-Link (Stift-Symbol) klicken.
Einträge löschen
Der Zugriff auf den "Löschen"-Dialog ist wie die Bearbeitungsansicht abhängig von Ihren Berechtigungen. Sie ermöglicht Ihnen die zu löschenden Daten nochmal zu betrachten und erwartet eine Bestätigung. Löschen können Sie einen Eintrag über das X-Symbol (siehe oben).
Arbeiten im Wikiartikel
Für die Arbeit im Fließtext stellt Ihnen die "BibManager" Erweiterung verschiedene sogenannte "Tags" zur Verfügung. Diese werden im Folgenden beschrieben.
<bib />
Um eine Zitation zu platzieren muss das Tag mit dem id Attribut in den Fließtext eingefügt werden.
(z.B. <bib id="lin:1973"/>).
Eine Zitation wird im Ansichtsmodus eines Artikels in eckigen Klammern ausgegeben und bietet beim darüberfahren mit der Maus detailliertere Informationen. Existiert ein Zitatschlüssel dabei noch nicht im Repository wird ein Link auf die "Bibliographieeintrag anlegen" Spezialseite erzeugt.
<biblist />
Dieses Tag listet alle in dem Artikel vorkommenden Zitationen (<bib />) auf, gibt die entsprechend formatierten Daten aus (siehe oben) und ermöglicht den schnellen Zugriff auf die Bearbeitungsansicht und Google Scholar. Ist ein Volltext-Link verfügbar wird auch dieser angezeigt.
Es besitzt keine Attribute.
<bibprint />
Dieses Tag ermöglicht es Abfragen an das Repository zu stellen. Das verwendete Attribut heißt filter und erwartet Werte in folgendem Format: feldname:wert|oderwert,feldname2:wert2
Es können mehrere Felder mit einem logischen "und" verbunden werden, indem man sie mit Kommas voneinander trennt. Feldname und Wert des Feldes sind über einen ":" voneinander getrennt. Möchte man bestimmte Werte eines Feldes mit einem logischen "oder" verknüpfen kann man das "|" Symbol als Trennzeichen verwenden. Mit % ist auch Links- und Rechtstrunkierung bei den Werten möglich. Die möglichen Feldnamen sind weiter oben beschrieben.
Beispiele:
Zitate die im Feld year entweder den Wert 2011 oder 1989 haben. => feldname:wert|oderwert
<bibprint filter="year:2011|1989" />
Zitate von Autoren deren Name die Zeichenkette "Steiger" enthält => feldname:wert
<bibprint filter=“author:%Steiger%“ />
Zitate von Autoren deren Name die Zeichenkette "Arnold" enthält und die aus dem Jahr "2011" oder "1989" stammen => feldname:wert|oderwert,feldname2:wert2
<bibprint filter=“year:2011|1989,author:%Arnold%“ />
Zusätzlich kann über das <bibprint /> Tag durch die Verwendung des citation Attributs eine vollständige Ausgabe eines bestimmten Zitates erwirkt werden.
<bibprint citation="Arnold.etal:1989" /> oder <bibprint citation="Arnold:1994" />
SaltWikiUpload
Bedienung
Die "SaltWikiUpload" Erweiterung verändert den Hochladen-Dialog von MediaWiki. Über spezielle Formularfelder können Sie bereits beim hochladen einer Datei bestimmte Metadaten angegeben.
Zu den allgemeinen Metadaten gehören
- Beschreibung
- Eine kurze Beschreibung der Datei und deren Inhalts.
- Quelle
- Die Quelle der Datei muss eindeutig nachvollziehbar sein.
- Datum
- Das Datum hilft die Aktualität der beinhalteten Daten einzuschätzen.
- Autor(en)
- Hier können die Autoren der Datei angegeben werden. Mehrere Autoren werden über Kommas voneinander getrennt. Die angegebenen Werte werden auch zur Kategorisierung der Datei verwendet.
- Berechtigung
- Es ist wichtig zu erfassen welche Nutzungsrechte für die Datei verfügbar sind. Bitte hinterlegen Sie auch wer diese Rechte hält und wie man diese Person kontaktieren kann.
- Schlagwörter / Kategorien
- Über die hier angegebene Werte erfolgt eine Kategorisierung im MediaWiki-Kategoriesystem. Auch hier werden mehrere Werte durch Kommas voneinander getrennt.
- Typ
- An dieser Stelle können Sie den die Art des Inhalts der Datei auswählen. Die Auswahl wird auch als Kategorie an die Dateibschreibungsseite übermittelt.
Je nach gewähltem Typ können Sie in den darunter eingeblendeten Formularfeldern weitere Daten angeben.
Auf der Dateibeschreibungsseite werden die angegebenen Informationen dann automatisch über MediaWiki Vorlagen eingebunden.
