Vorlage:CRef/Doku

Diese Seite ist die Dokumentations-Unterseite der Vorlage:CRef.

Eigenschaften der Vorlage
„CRef“

Projekt	[[{{{projekt}}}]]
Vorlagentyp	Textauszeichnung‎
Namensraum	keine Einschränkung
automat. Kategorie	keine
abhängig von	[[Vorlage:{{{braucht}}}|{{{braucht}}}]]
alternativ	Ref
Bitte binde diese Vorlage nur mit Substitution ein.
Bitte vor Änderung dieser vielfach verwendeten Vorlage die Zustimmung der Gemeinschaft im Skriptorium einholen!

CRef erzeugt Fuß- oder Endnoten, die an der gewünschten Stelle mithilfe der Vorlage {{References}} zusammengefasst werden. Das C im Namen der Vorlage deutet auf die MediaWiki-Erweiterung Cite hin und ist zur Unterscheidung von der Vorlage {{Ref}} notwendig.

Parameter und Kopiervorlagen

Mit (m) gekennzeichnete Parameter sind erforderlich (mandatory). Mit (o) markierte Parameter können entfallen (optional).

Benannte Parameter müssen in der Form name=wert angegeben werden.
Dies gilt auch für unbenannte Parameter, wenn der Wert ein Gleichheitszeichen enthält: 1=we=rt

Einige Zeichen wie = | {{ }} kollidieren mit der Vorlagensyntax. Damit sie angezeigt werden, müssen sie in die Tags <nowiki>…</nowiki> gesetzt werden.

• Parameter 1 (o): Der Eintrag gibt den Namen der Endnotengruppe an, in der die Anmerkung aufgelistet werden soll. Er darf Leerzeichen enthalten. Wird der Parameter weggelassen oder bleibt er leer, wird die Anmerkung der namenlosen Standardgruppe zugeordnet. Die Gruppennamen unterscheiden sich bei unterschiedlicher Groß- und Kleinschreibung. Daher wird die Festlegung in den jeweiligen Projekt-Editionsrichtlinien ausdrücklich empfohlen. Im Sinne einer einheitlichen Handhabung innerhalb der deutschen Wikisource ist die Großschreibung für die Gruppennamen vorzuziehen. Deshalb wird der Gruppenname automatisch in Großschreibung umgewandelt. Soll der Gruppenname exakt so verwendet werden, wie er angegeben ist, muss ihm der Schalter EXA/ vorangestellt werden.

In der Vorlage {{References}} sind einige gebräuchliche Gruppennamen vorbelegt. Diese werden als Kennung für vorgegebene Überschriften gewertet. Bei Verwendung von CRef zusammen mit References sind daher folgende Werte für Parameter 1 bedeutsam:

Kennung	Überschriftstext	Kopiervorlage
(leer)	Anmerkungen	{{CRef||text|}}
WS	Anmerkungen (Wikisource)	{{CRef|WS|text|}}
VL	Anmerkungen der Vorlage	{{CRef|VL|text|}}
AU	Anmerkungen des Autors	{{CRef|AU|text|}}
UE	Anmerkungen des Übersetzers	{{CRef|UE|text|}}
TK	Textkritische Anmerkungen	{{CRef|TK|text|}}
ER	Errata	{{CRef|ER|text|}}
name	Anmerkungen (name)	{{CRef|EXA/name|text|}}

• Parameter 2 (m): Der Text der Anmerkung wird mit diesem Parameter übergeben. Es besteht im Prinzip keine Längenbegrenzung. Soll das Pipe-Zeichen „|“ enthalten sein, muss es mithilfe von {{!}} eingefügt werden.

• Parameter 3 (o): Hiermit kann der Fußnote ein eigener Name zugeordnet werden, der nicht mit dem Gruppennamen zu verwechseln ist. Durch diesen Namen kann wiederholt auf dieselbe Fußnote verwiesen werden. Fußnotennamen gelten nur innerhalb der gleichen Gruppe. Näheres erläutert die Hilfe zu Cite.php (de)/(en).

• Parameter 4 (o): Die Schriftgröße der Fußnotenmarker ist durch die Hochstellung etwas kleiner als der Fließtext. Mit diesem Parameter kann die Fußnotenmarkergröße verändert werden. Erlaubt sind CSS-konforme numerische Angaben, Schlüsselworte oder Prozentwerte. Eine Übersicht stellt SELFHTML zur Verfügung. Die numerischen Angaben bestehen aus einer Zahl und einer absoluten oder relativen Einheit. SELFHTML gibt zu den erlaubten Einheiten eine Beschreibung nebst einer Erläuterung der Vor- und Nachteile. Empfehlenswert ist die Verwendung von Prozentwerten. Diese beziehen sich auf die Schriftgröße des hochgestellten Textes, welche ihrerseits abhängig vom übrigen Text ist, sodass die Fußnotenmarker stets im gleichen Verhältnis zu diesem gesetzt werden. Mit der Angabe 100% behält der Fußnotenmarker seine voreingestellte Größe, kleinere oder größere Werte bewirken eine Verkleinerung oder Vergrößerung. Achtung – durch die Hochstellung werden die Marker immer etwas verkleinert, weshalb zum Erreichen einer bestimmten absoluten Schriftgröße (z. B. die des Fließtextes) eine Vergrößerung um etwa das 1,11-fache einzurechnen ist (z. B. 111% für 100 % der Fließtextgröße).

Beispiele

Im untenstehenden Blindtext sind beispielhafte Anmerkungen mit CRef eingefügt und darunter in verschiedenen Gruppen mit {{References}} zusammengefasst (zur Verwendung siehe dort). Im oberen Teil ist der Quelltext zu sehen, also die Eingabe im Bearbeitungsfenster. Hier wurde der für das Verstehen der Vorlage unwichtige Blindtext in grau gesetzt. Darunter befindet sich, blau unterlegt, das Ausgabe-Ergebnis durch die Mediawiki-Software. Die Fußnoten der verschiedenen Gruppen wurden hier nach folgenden Mustern erzeugt:

namenlose Standardgruppe

{{CRef||text}} bzw. bei 2. und 3. {{CRef||text|name}}

Gruppe „WS“

{{CRef|WS|text}}

Gruppe „Kleine Gruppe“ bei Vergrößerung des Markers

{{CRef|EXA/Kleine Gruppe|text||130%}}

Gruppe „UE“

{{CRef|UE|text}} bzw. bei 1. {{CRef|UE|text|name}}

Lorem{{CRef|ue|Dolorem|fremdsprachlich}} ipsum dolor{{CRef|ue||fremdsprachlich}} sit amet, consectetur adipisicing elit, sed do eiusmod{{CRef||Eiverbesserung}} tempor incididunt ut labore{{CRef|||Werkschau}} et dolore{{CRef|Ue||fremdsprachlich}} magna aliqua. Ut enim ad{{CRef|WS|Keine Werbung, bitte}} minim veniam, quis nostrud exercitation ullamco{{CRef|||re-zitieren}} laboris{{CRef|||Werkschau}} nisi ut aliquip ex{{CRef|UE|und hopp}} ea commodo{{CRef||re am Ende|re-zitieren}} consequat. Duis{{CRef|ws|burg}} aute irure dolor{{CRef|UE||fremdsprachlich}} in reprehenderit in voluptate{{CRef|exa/Kleine Gruppe|there’s a vulture outside||130%}} velit esse cillum dolore{{CRef|uE||fremdsprachlich}} eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non{{CRef||plus ultra}} proident, sunt in culpa qui officia deserunt mollit anim id est laborum{{CRef||sehr arbeitsam|Werkschau}}.
{{References|LIN}}
{{References|TIT|WS}}
{{References|TIT|Kleine Gruppe}}
{{References|TIT|UE}}

Lorem^{[UE 1]} ipsum dolor^{[UE 1]} sit amet, consectetur adipisicing elit, sed do eiusmod^[1] tempor incididunt ut labore^[2] et dolore^{[UE 1]} magna aliqua. Ut enim ad^{[WS 1]} minim veniam, quis nostrud exercitation ullamco^[3] laboris^[2] nisi ut aliquip ex^{[UE 2]} ea commodo^[3] consequat. Duis^{[WS 2]} aute irure dolor^{[UE 1]} in reprehenderit in voluptate^{[Kleine Gruppe 1]} velit esse cillum dolore^{[UE 1]} eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non^[4] proident, sunt in culpa qui officia deserunt mollit anim id est laborum^[2].

---

1. Eiverbesserung
2. sehr arbeitsam
3. re am Ende
4. plus ultra

Anmerkungen (Wikisource)

1. Keine Werbung, bitte
2. burg

Anmerkungen (Kleine Gruppe)

1. there’s a vulture outside

Anmerkungen des Übersetzers

1. Dolorem
2. und hopp