User:Dapete/vCat

From Meta, a Wikimedia project coordination wiki
Jump to: navigation, search


Contents

Deutsch[edit]

vCat ist ein Tool, um Kategorienstrukturen graphisch darzustellen. Es zeichnet mit Hilfe von Graphviz ein Diagramm (in Form eines Baumes), bei dem unten die angegebene Kategorie oder Seite steht und darüber deren Überkategorien.

vCat ist unter https://tools.wmflabs.org/vcat/render direkt ansprechbar und erwartet alle Informationen in URL-Parametern. Diese sind weiter unten dokumentiert.

Beispiel: https://tools.wmflabs.org/vcat/render?wiki=dewiki&category=Deutschland für die Oberkategorien von Kategorie:Deutschland in der deutschen Wikipedia

Weiterführende Links:

Pflichtparameter
Name Beschreibung Anmerkungen
wiki Wiki-Datenbank/Projektname Beispiele: "dewiki" (deutsche Wikipedia), "enwikisource" (englisches Wikisource)
Liste der verfügbaren Werte (englisch, Spalte "dbname")
category Kategorientitel Kann mehr als einmal angegeben werden (oder mehrere Kategorientitel, durch "|" getrennt enthalten) um mehrere Seiten als Wurzel des Kategorienbaumes zu verwenden.
Kann nicht zusammen mit title benutzt werden.
title Seitentitel Falls ns nicht angegeben ist wird der Namensraum automatisch bestimmt.
Kann mehr als einmal angegeben werden (oder mehrere Seitentitel, durch "|" getrennt enthalten) um mehrere Seiten als Wurzel des Kategorienbaumes zu verwenden.
Kann nicht zusammen mit category benutzt werden.
Weitere Parameter
Name Beschreibung Erlaubte Werte Standardwert Anmerkungen
ns Namensraum eine Namensraum-Nummer Beispiel: Namensräume der deutschen Wikipedia.
Erzwingt für einen angegebenen Seitentitel (title) diesen Namensraum
Kann nicht zusammen mit category benutzt werden.
rel Relation "category" (zeige Oberkategorien)
"subcategory" (zeige Unterkategorien)
"category" Erstelle einen Kategorienbaum mit den Ober- oder Unterkategorien einer Seite.
Letzteres ist nur möglich, wenn die Wurzelknoten Kategorien sind.
depth maximale Tiefe eine Zahl Der Kategorienbaum soll nur die angegebene Zahl an Ebenen umfassen.
limit maximale Anzahl an Knoten/Blättern eine Zahl
Maximum ist 250, außer für format=gv
250 Die maximale Anzahl wird erreicht, indem die maximale Tiefe automatisch begrenzt wird.
Das Maximum ist nötig, da das Rendern von Bildern mit vielen Knoten sehr lange dauert und große Dateien erzeugt. format=gv rendert kein Bild, daher ist in diesem Fall keine Grenze nötig. Nutzer können diese Datei verwenden, um selbst eine Grafikdatei daraus zu erzeugen.
format Ausgabeformat "dot" oder "gv"
"gif"
"pdf"
"png"
"svg"
"png" "dot" oder "gv" erzeugt Textdateien im Eingabeformat von Graphviz, die andern Grafikdateien im angegebenen Format.
Falls links verwendet wird, werden für "png" und "gif" HTML-Seiten with einer Imagemap (<map>-Element) erzeugt. Siehe unten.
showhidden Versteckte Kategorien anzeigen "0"
"1"
"0" Mit __HIDDENCAT__ auf ihrer Beschreibungsseite markierte Kategorien werden normalerweise nicht im Kategorienbaum dargestellt.
algorithm Graphviz-Algorithmus "dot"
"fdp"
"dot" Definiert, welches der Graphviz-Kommandozeilenprogramme den Kategorienbaum umsetzt.
links Links im Kategorienbaum setzen kein Wert
"graph"
"wiki"
kein Wert "graph" erstellt für jeden Artikel/jede Kategorie im Baum einen Link auf einen weiteren Baum, der dort beginnt.
"wiki" erstellt Links auf die entsprechenden Seiten im Wiki.
Falls format=png oder format=gif verwendet werden, wird eine HTML-Seite with einer Imagemap (<map>-Element) erzeugt. Die Bilder werden dort als data:-URI eingebettet.

English[edit]

vCat is a tool to graphically display category structures. Using Graphviz, it creates a diagram (in tree form) with a specified category or page at the bottom and its supercategories above.

vCat can be reached directly at https://tools.wmflabs.org/vcat/render and needs all information as URL parameters. These are documented below.

Example: https://tools.wmflabs.org/vcat/render?wiki=dewiki&category=Deutschland for categories of Kategorie:Deutschland (category for Germany) in German Wikipedia

Links:

Required parameters
Name Description Remarks
wiki Wiki database/project name Examples: "dewiki" (German Wikipedia), "enwikisource" (English Wikisource)
List of available values ("dbname" column)
category Category title Can be specified more than once (or contain several category titles separated by "|") to have multiple pages as roots for the graph.
Cannot be used with title.
title Page title If ns is not specified, the namespace is automatically determined from the page title.
Can be specified more than once (or contain several page titles separated by "|") to have multiple pages as roots for the graph.
Cannot be used with category.
Additional parameters
Name Description Allowed values Default value Remarks
ns Namespace a namespace number Example: namespaces on English Wikipedia.
Forces the namespace for the title specified to this namespace.
Cannot be used with category.
rel Relation "category" (show categories)
"subcategory" (show subcategories)
"category" Shows a graph of a category's or article's categories, or of a category's subcategories.
The latter can only be used if the roots of the graph are categories.
depth Maximum depth a number The graph will only go down the given number of levels.
limit Maximum number of nodes/leaves a number
maximum is 250, except for format=gv
250 The maximum number is achieved by automatically limiting the depth.
The limit is enforced because rendering images with many nodes takes a long time and produces huge files. format=gv does not actually render an image, so the limit is not necessary. Users can then take this file and render an image from it themselves.
format Output format "dot" or "gv"
"gif"
"pdf"
"png"
"svg"
"png" "dot" or "gv" creates a text file in Graphviz' input format, the others create images in the specified format.
If links is used, creates HTML pages with an image map (<map> element) for "png" and "gif". See below.
showhidden Show hidden categories "0"
"1"
"0" Categories marked with __HIDDENCAT__ on their description page are normally not included in the graph.
algorithm Graphviz algorithm "dot"
"fdp"
"dot" Use the specified Graphviz utility to create the graph.
links Include links in graph no value
"graph"
"wiki"
no value "graph" creates links to a graph starting from each article/category in the graph.
"wiki" creates links to the wiki page of each article/category
Creates HTML pages with an image map (<map> element) for format=png and format=gif. The images are embedded in the page as data: URIs.