Extension:Graph

Příručka k rozšířením MediaWiki

Graph Stav rozšíření: neudržované
Implementace	Značka , ContentHandler
Popis	Grafy založené na datech
Autoři	Yuri Astrakhan (Yurik diskuse), Dan Andreescu, Frédéric Bolduc
MediaWiki	>= 1.43
Licence	Licence MIT
Stáhnout	Stáhněte si rozšíření Git [?]: stáhněte si Git master procházení úložiště (Phabricator · GitHub) zobrazení historie přispěvatelé repozitáře (GitHub) kontrola kódu
Parametry $wgGraphDefaultVegaVer $wgGraphAllowHttp $wgGraphAllowedDomains
Použité háčky (hooks) OutputPageParserOutput ParserFirstCallInit
Čtvrtletní stahování	29 (Ranked 104th)
Veřejné wiki používající rozšíření	884 (Ranked 281st)
Přeložte rozšíření Graph, používá-li lokalizaci z translatewiki.net
Problémy	Otevřené úkoly · Nahlásit chybu

Rozšířeníení Graph umožňuje značku ‎<graph> popisující vizualizace dat, jako jsou sloupcové grafy, koláčové grafy, časové osy a histogramy (demo) ve formátu JSON, který vykresluje Vega-základy grafu.

Základní informace

Rozšíření grafu umožňuje přidání výkonných grafů na stránkách wiki založených na Vega. Grafy mohou být interaktivní.

Nejjednodušší způsob, jak přidat graf, je použít připravenou šablonu, jako je {{Graph:Chart}}. Tyto šablony skrývají všechny složitosti Vega. Výkonní uživatelé mohou používat k vývoji grafů pískoviště Graph Sandbox. Sandbox Graph umožňuje kromě JSON syntaxi šablon wiki. Rozšíření se integruje s VisualEditor a poskytuje jednoduchý nástroj/průvodce, který generuje základní grafy, zadáním hodnot přímo do editoru.

Užitečné odkazy

• Dokumentace Vega 2 – obnovené stránky dokumentace Vega 2 na nyurik/vega/wiki.
• Průvodce – obecná doporučení, jak používat grafy ve wiki.
• Interaktivní výukový program – pokyny, jak od začátku, krok za krokem, vytvořit komplexní interaktivní graf
• Ukázková stránka – pro mnoho ukázek a triků k použití.
• TechTalk Video – technická přednáška WMF pojednávající o rozšíření Graph, včetně skvělé ukázky editoru Lyra (také nainstalovaného v laboratořích).
• Také by vás mohly zajímat některé z budoucích schopností Vega [1] (Keynote od Jeffreyho Heera).
• Vega pro vývojáře – nejlepší místo ze všech zdrojů Vega
• Migrace na Vega 2.0
• Úvodní video do interaktivní Vega

Instalace

• Vyžaduje rozšíření JsonConfig
• Stáhněte soubor/y a vložte je do adresáře pojmenovaného Graph ve vaší složce extensions/.
  Vývojáři a přispěvatelé kódu by si místo toho měli nainstalovat rozšíření from Git pomocí:cd extensions/
git clone https://gerrit.wikimedia.org/r/mediawiki/extensions/Graph
• Na konec vašeho souboru LocalSettings.php přidejte následující kód:

  wfLoadExtension( 'Graph' );
  

•  Dokončeno – Přejděte na stránku Special:Version vaší wiki a zkontrolujte, zda bylo rozšíření úspěšně nainstalováno.

Instalace Vagrant:

• Pokud používáte Vagrant , instalujte s těmito parametry vagrant roles enable graph --provision

Další nastavení konfigurace

Pokud chcete replikovat produkční prostředí, jako je en.wiki, budete muset provést následující kroky:

• Nainstalujte Scribunto , Imagemap a TemplateStyles a povolte nahrávání SVG
  • Pokud používáte Vagrant, můžete použít vagrant roles enable --provision scribunto imagemap templatestyles svg
• Importovat Module:Graph, Module:Graph/doc, Template:Nowrap a Template:Nowrap/styles.css z mediawiki.org (export link)
• Importovat Module:Chart a Module:Chart/Default colors enwiki (exportní odkaz)
• Importujte soubor File:Circle_frame.svg

Ladění grafů a portování grafů z Vega 2 do Vega 5

Sandbox je poskytován na Special:GraphSandbox, který funguje podobně jako Grafický editor Vega. Nástroj MediaWiki obsahuje kód kompatibility, který mapuje starší schémata Vega na aktuálně povolenou verzi. Vložením starého schématu do hlavní textové oblasti se pod graf, kde je to možné, vytiskne upravené a modernizované schéma.

Podobně jako vega.github.io/editor lze objekt Vega kontrolovat prostřednictvím globálního JavaScriptu VEGA_DEBUG. Podívejte se na průvodce laděním společnosti Vega, jak jej používat.

Migrace schémat ze starších verzí Vega

Dříve Graph podporoval Vega 2. JSON grafů můžete vložit do http://vega.github.io/vega-editor/?mode=vega, abyste viděli, jak se dříve vykreslovaly pro srovnání s Vega 5.

Special:GraphSandbox (nejnovější kód viz beta clusterová verze pískoviště) lze použít k mapování starších schémat na nová schémata. Zkopírujte staré schéma do hlavní textové oblasti a aktualizované schéma se objeví v textové oblasti pod grafem. Zkopírujte nové schéma do svého kódu.

Příklady grafů

Viz Stránka ukázek - pro mnoho ukázek a triků k použití.

Uživatelsky definované záložní řešení

Při použití vykreslování na straně klienta je možné použít Wikimedia Commons k poskytnutí statického záložního obrázku uživatelům noscript. Toto je dočasné řešení, dokud nebude zavedena nová služba poskytující vykreslování na straně serveru.

Uživatel musí nejprve nahrát statický graf na Wikimedia Commons.

Záložní obrázky mají dvě proměnné fallback a fallbackWidth.

fallback se vztahuje k souboru Wikimedia Commons.

fallbackWidth je šířka záložních obrázků v pixelech.

Tyto proměnné se zadávají do grafu následujícím způsobem:

<graph fallback="Graph test seddon.png" fallbackWidth=450>

Tam, kde se používají moduly Lua, jako je Module:Graph, lze tyto proměnné poskytnout pomocí funkce značky. Pokud by byl upraven Template:Graph:Chart , vypadalo by to takto:

{{safesubst:#tag:graph|{{safesubst:#invoke:Graph|chartWrapper}} | fallback = {{{fallback|''}}} |  fallbackWidth= {{{fallbackWidth|''}}} }}

Poté by byl použit v šabloně následujícím způsobem:

{{Graph:Chart|width=400|height=100|xAxisTitle=X|yAxisTitle=Y
 |type=rect|x=1,2,3,4,5,6,7,8|y=10,12,6,14,2,10,7,9|fallback=Graph test seddon.png|fallbackWidth=450}}

Pokud není zadán fallbackWidth, ale je definován obrázek, rozšíření odvodí šířku z poskytnuté šířky grafu. Důvodem je často rozdíl v šířce vykresleného obrazu a skutečné šířce obrazu.

{{Graph:Chart|width=400|height=100|xAxisTitle=X|yAxisTitle=Y
 |type=rect|x=1,2,3,4,5,6,7,8|y=10,12,6,14,2,10,7,9|fallback=Graph test seddon.png}}

Externí data

Protokol HTTP(S) nelze použít k získání dat pro graf. Místo toho použijte jeden z vlastních protokolů wiki jako wikiraw:, wikiapi: a další.

Rozšíření Graph používá nastavení GraphAllowedDomains k ovládání způsobu řešení těchto protokolů: Všimněte si, že vzhledem k závislosti dotazů na struktuře položek wikibase, mohou náhle přestat fungovat, pokud jsou podkladová data upravena a změněna, protože mohou poskytnout neúplná, prázdná nebo neplatná data, která nelze použít k vytvoření grafu. V těchto případech bude graf prázdný (viz phab:T168601).

$wgGraphAllowedDomains = [
    # Klíče http + https uvádí všechny domény povolené pro externí přístup k datům.
    # Jakákoli zde uvedená doména automaticky povoluje také všechny subdomény.
    # Vlastní protokoly jako 'wikiraw' jej používají k určení, který protokol použít.
    # Tímto způsobem bude wikiraw://en.wikipedia.org/Page požadavkem API na https://en.wikipedia.org/w/api.php?action=query&titles=Page&...
    'https' => [ 'wikipedia.org', 'wikimedia.org', ... ],
    'http' => [ 'wmflabs.org', ... ],
    
    # Seznam domén povolených pro wikirawupload: Protokolový přístup.
    # Pouze přesná shoda, žádné subdomény.
    'wikirawupload' => [ 'upload.wikimedia.org' ],
    
    # Stejné jako wikirawupload, ale pro dotazy Wikidata Sparql
    'wikidatasparql' => [ 'query.wikidata.org' ],
];

Vnitřní části

Při analýze rozšiřuje rozšíření Graph všechny parametry/výrazy šablony a ukládá úplné definice grafu do ParserOutput pomocí hash grafů pro ID.

Rozšíření Graph přidá HTML na stránku, kde by měly být grafy, ‎<div> s graph-id jako atributem. Ukázka:

<div class="mw-graph" data-graph-id="72edc224f0a10b343c1e84f63dbfc97cac9bc957">
</div>

Rozšíření Graph přidá na stránku modul JavaScriptu ext.graph ResourceLoader, který obsahuje knihovnu Vega, a vloží JSON definic grafů do proměnné JavaScriptu mediawiki.config s názvem wgGraphSpecs. Jakmile klient nahraje tento modul, knihovna Vega JavaScript naplní každý ‎<div> plátnem HTML a nakreslí do něj graf, čímž nahradí statický obrázek.

Bezpečnostní prvky

‎<graph> lze nakonfigurovat tak, aby zakázal odkazování na nedůvěryhodné zdroje dat (např. Wikimedie povoluje pouze data ze stránek Wikimedie).

Licence

Knihovna Vega je distribuována pod licencí upravené licence BSD, která je pro nás přijatelná k použití.

“	Zdá se, že se jedná o kopii BSD licence s některými menšími (přijatelnými) úpravami. Není pro nás problém toto použít, i když v ideálním případě bychom takové změny v licenci neprováděli. Je lepší, když lidé tyto změny ve své licenci neprovádějí, aby se předešlo nejasnostem (jako je tato), zda je licence bezpečná pro použití s otevřeným zdrojovým kódem.	”
—Stephen LaPorte

Konfigurace

wgGraphAllowedDomains

Viz část o externích datech.

Modul VisualEditoru

Od léta 2015 přichází rozšíření Graph také s modulem (ext.graph.VisualEditor), který umožňuje editaci grafů v rámci VisualEditoru.

Tento modul byl výsledkem projektu Google Summer of Code 2015. Další podrobnosti najdete na stránce phab:T89287.

Tento modul umožňuje uživatelům vidět grafy ve VisualEditoru, na rozdíl od cizích uzlů rozšíření. Kromě toho mohou uživatelé otevřít dialog pro úpravu typu grafu, dat a výplně. Uživatelské rozhraní také nabízí způsob, jak upravit nezpracovanou specifikaci JSON grafu v rámci VE, aniž byste museli přepínat do klasického editoru wikitextu, v případě, že by pokročilejší uživatelé chtěli upravit nastavení, která uživatelské rozhraní nepodporuje.

Tento první krok slouží jako odrazový můstek pro mnoho možností úprav grafů v rámci VisualEditoru a existuje mnoho způsobů, jak modul vylepšit a rozšířit.

Odstraňování problémů s nefunkčními grafy

Chyby s grafy budou zaznamenány do vývojářské konzoly.

Chyba: Chybné argumenty konstruktoru (phab:T277906)

Oprava: Nahraďte filepath:Earthmap1000x500compac.jpg za filepath:Earthmap1000x500.jpg

příklad.

TypeError: undefined is not an object (evaluating 'datum.firstYear.value')

Oprava: Ujistěte se, že jste nenastavili výchozí hodnotu null

Příklad.

Související odkazy

• Diagram extensions
• Plotly — grafická knihovna JavaScriptu Open source (s možností 3D grafů)
• D3 — dokumenty řízené daty