Vorlage:PFAF/Doku/Tech
Diese Seite ist eine Dokumentations-Unterseite der Vorlage:PFAF/Doku.
Technische Dokumentation
[Quelltext bearbeiten]Die Vorlage PFAF dient der Kapselung eines Weblinks zu PFAF, erzeugt ggf. auch das zugehörige Drumherum wie Linktext etc. Dabei gibt es zwei Typen:
- Eintrag (Daten) zu einem Taxon (i.d.R. Art, aber auch Unterart, Varietät oder Gattung[1])
- Liste der Einträge (i.d.R. Arten, aber auch Unterarten bzw. Varietäten) zu einem Taxon (Familie, Gattung oder ggf. auch Art[2])
In beiden Fällen verwendet PFAF den wissenschaftlichen Namen als Identifikation in der URL (Leerzeichen müssen HTML-codiert werden).
Die Vorlage verwendet den Parameter WissName sowohl für die Generierung der URL als auch für die Darstellung. Er muss ohne HTML-Codierung angegeben werden (da es ja nur eine Parser-Funktion für eine der beiden Richtungen gibt). Die Kursivierung des wiss. Namens fügt die Vorlage hinzu. Diese muss für Familien unterbleiben, dies ist einer der beiden Gründe für die Notwendigkeit des Parameters Rang. Ein Problem sind wiss. Namen, die nicht zu kursivierende Binnenbestandteile enthalten (Varietäten: „var.“). Entgegen vielen anderen Vorlagen darf hier nicht im Parameter WissName eine Binnen-Entkursivierung verwendet werden, da der WissName sonst nicht mehr für die URL zu brauchen ist (von einem Replace als String-Funktion muss man wohl noch ein Weilchen träumen). Die einzige Möglichkeit für eine formal perfekte Darstellung besteht hier in der Nutzung des Parameters Linktext (siehe Beispiel zu Sambucus racemosa var. racemosa in der Endbenutzerdokumentation).
Ein weiterer Nutzen des Parameters Rang besteht darin, dass aus diesem meist abgeleitet werden kann, ob nun die Daten oder die Liste zu einem Taxon darzustellen ist. Bei Arten (da kann der Rang weggelassen werden) werden standardmäßig die Daten angezeigt, bei Gattungen und Familien dagegen standardmäßig die Liste. Bei Familien gibt es keine Daten, aber bei Gattungen und Arten geht beides. Um hier ggf. unterscheiden zu können, existiert der Parameter Liste, der aber nur angegeben werden muss, wenn es sich nicht um den Standardfall handelt (siehe Endbenutzerdok.). Die Ableitung, welche Darstellungsform zu wählen ist aus den Parametern Rang und Liste, erledigt die Untervorlage {{PFAF/IstListe}}.
Die Untervorlage {{PFAF/Weblink}} dient der Aufbereitung des Weblinks. Bei der Listendarstellung wird dabei grundsätzlich folgende Form verwendet:
Es ist etwas überraschend, dass bei family= auch Gattungen oder Arten angegeben werden können, aber es ist praktisch. Für Gattungen und Arten gäbe es eine alternative Form (die sich auch der PFAF-Einstiegsseite für Familien findet)
Also die Verwendung einer Wildcard. Für Gattungen und Arten scheint das zum exakt gleichen Ergebnis zu führen wie die Verwendung von family=, für Familien allerdings kann diese Variante natürlich nicht funktionieren.
Anmerkungen
[Quelltext bearbeiten]- ↑ Es ist gar nicht bekannt, wie man zu einem Link für Daten zu einer Gattung über die Website selbst gelangen kann, aber es scheint für alle Gattungen Daten zu geben.
- ↑ Auch hier ist nicht bekannt, ob und wie man zu seinem Link für die Eintrags-Liste zu einer Art über die Website gelangt, Sinn kann das aber schon machen, wenn Unterarten bzw. Varietäten zu einer Art existieren (siehe Beispiel zu Sambucus racemosa in der Endbenutzerdokumentation)