Rozšíření:GuidedTour

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

GuidedTour Stav rozšíření: stabilní
Implementace	Speciální stránka , Akce stránky
Popis	Poskytne vyskakovací komentované vyhledávání na stránkách wiki a nebo mikroprůzkumy.
Autoři	Munaf Assaf, Terry Chay, Matt Flaschen, Pau Giner, Ori Livneh, Rob Moen, S Page, Sam Smith, Moiz Syed, Luke Welling
Nejnovější verze	Průběžně aktualizováno
MediaWiki	1.32+
PHP	5.4+
Použité háčky (hooks) BeforePageDisplay MakeGlobalVariablesScript RedirectSpecialArticleRedirectParams ResourceLoaderRegisterModules
Licence	Apache License 2.0
Stáhnout	Stáhněte si rozšíření Git [?]: Procházení úložiště (Phabricator · GitHub) Kontrola kódu Gerrit Zobrazení historie Git Stáhněte si zdrojový soubor tarball
Kompatibilita s Internet Explorerem: žádná pro verzi 6, částečná pro verzi 7.
Přeložte rozšíření GuidedTour, používá-li lokalizaci z translatewiki.net
Problémy	Otevřené úkoly · Nahlásit chybu

Rozšíření za GuidedTour poskytuje rámec pro vytváření "průvodců" neboli interaktivních učebnic pro funkce MediaWiki. Vyhledávání obvykle provedou uživatele nějakým standardním pracovním postupem (jako je úprava článku nebo nahrání obrázku) a jsou implementována jako série dialogových oken, která uživateli sdělují, kam má kliknout a co má dělat dál.

Vyhledávání jsou podporována kódem JavaScript a PHP, který dokáže sledovat pokrok uživatele, kontrolovat jeho porozumění a nabízet rady a povzbuzení. Prohlídky s průvodcem jsou efektivním prostředkem pro rozdělení složitých úkolů do série jednoduchých, samostatných dílčích úkolů a pro poskytnutí uživateli zkušeností a sebevědomí potřebných k opakování pracovního postupu pro podobné úkoly v budoucnu. Prohlídky lze také použít k implementaci interaktivních průzkumů .

GuidedTour vyvinul (bývalý) tým Growth . Je částečně založen na knihovně Optimize.ly's Guiders. Průvodní GuidedTour původně začalo na WMF Tech Days 2012 .

Upozorňujeme, že s používáním tohoto rozšíření existují určité obavy s výkonem.

Nainstalujte a používejte GuidedTour na své wiki

• Otestujte, zda to fungovalo, voláním stránky s připojenou hodnotou tour=test k URL adrese. Například: http://localhost/w/index.php?tour=test
• Stáhněte soubor/y a vložte je do adresáře pojmenovaného GuidedTour 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/GuidedTour
  

• Na konec vašeho souboru LocalSettings.php přidejte následující kód:

  wfLoadExtension( 'GuidedTour' );
  

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

Abyste mohli využít vyhledávání s průvodcem, měli byste...

1. Napište skutečnou prohlídku na stránku ve jmenném prostoru MediaWiki. Musí se jmenovat MediaWiki:Guidedtour-tour-název zájezdu.js, například MediaWiki:Guidedtour-tour-mytour.js
2. Zavolejte požadovanou stránku s připojenou parametrem tour=mytour k URL adrese. Například:

   http://localhost/w/index.php?tour=mytour nebo ?tour=test v příkladu výše.

3. Chcete-li stylovat výstup, upravte soubor CSS v adresáři modulů nebo přidejte přepsání do MediaWiki:Common.css.

Z bezpečnostních důvodů nelze prohlídky spustit na některých stránkách, včetně stránek pro přihlášení, vytvoření účtu, uživatelských nastavení a resetování hesla.

Podklady

Naše komunity se kdysi omezovaly na používání statických wiki stránek, šablon a dalších funkcí k vytváření tutoriálů a prohlídek všeho druhu. Jakkoli bohaté nástroje jako Wikipedia:Tutorial mohou být, ruší uživatele a nutí ho přejít na jinou webovou stránku. Jsou také poměrně dlouhé. Přečtení většiny dokumentace o Wikipedii by trvalo poměrně dlouho.

Uživatelská zkušenost

Interaktivní prohlídky s průvodcem poskytují jednoduchého a podrobného průvodce sadou funkcí, aniž by uživatele přerušovaly. Prohlídky s průvodcem nedominují obrazovce, lze je zavřít a uživatele přímo provedou úkolem. Prohlídky s průvodcem jsou také ideálně něco, k čemu se člověk může vrátit kdykoli, pokud to potřebuje.

Každý krok v prohlídce s průvodcem se nazývá "guider" (průvodce).

Popis prvků průvodce

Titul

Pojmenovává aktuální krok. Pokud je název začátkem prohlídky, můžete jej použít k popisu prohlídky jako celku. Pokud má název vašeho průvodce více než jeden řádek, je příliš dlouhý.

Tělo textu

Popisuje aktuální krok. Pokud uvádíte další body, které jsou zbytečné, aby uživatel pochopil, jak přejít k dalšímu kroku, říkáte příliš mnoho. Prohlídky s průvodcem jsou efektivní nejen proto, že popisky ukazují na věci, ale také proto, že omezují instruktážní text na to, co je bezprostředně nutné, spíše než aby se uživatele najednou zahlcovaly odstavci dokumentace.

Tlačítko

Tlačítka prohlídky slouží k akcím, obvykle přesměrují uživatele k dalšímu kroku. Tlačítka pro prohlídky s průvodcem standardně používají třídu progressive z knihovny mediawiki.ui . It is a poor practice to provide multiple action buttons, e.g. Start tour plus Next. Vyberte jednu akci, kterou má uživatel provést v reakci na krok prohlídky, a zaměřte se na dokončení této akce. Nikdy nepoužívejte tlačítko akce k ukončení prohlídky (pokud uživatel není skutečně na konci), protože to ovlivňuje, zda primární tlačítka akcí slouží k pokračování prohlídky nebo k jejímu ukončení (pozitivní vs. negativní akce). Pokud váš krok průvodce ukazuje na další akci, kterou chcete, aby uživatel provedl (např. Edit nebo View history), není vhodné, aby tlačítko prohlídky tuto akci provedlo za něj. Místo toho ukažte na prvek, který chcete, aby uživatel použil, a povzbuďte ho, aby si ho vyzkoušel, aby se naučil používat funkci tak, jak by ji normálně používal.

Tlačítko Zavřít (X)

Poskytuje zřejmý prvek pro zavření prohlídky, na rozdíl od pouhého zavření jednoho průvodce, což lze provést externím kliknutím nebo stisknutím klávesy Esc. Pokud uživatel klikne na toto tlačítko pro zavření, měla by se prohlídka napříč stránkami ukončit a související prohlídka se vymaže z uživatelových souborů cookie.

Lokace

Vodicí prvky lze umístit buď jako "central overlay" (centrální překrytí), nebo jako "attachment" (příloha). "Přílohy" se umisťují vedle konkrétních prvků stránky (například odkazu nebo karty) pomocí selektorů CSS. Pozice vodítka relevantního pro prvek stránky je určena orientacemi, jako například vlevo nahoře, nahoře, vpravo nahoře, vpravo nahoře atd. (Viz podrobnosti )

Popis chování průvodce

Krátké video z prohlídky 'firstedit', které ukazuje základní chování, jako jsou popisky, animace a další

Mějte na paměti následující výchozí chování pro prohlídky s průvodcem:

• Pokud uživatel průvodce nevidí (tj. nenachází se nad nebo pod ohybem stránky), prohlížeč uživatele přesune na místo, kde se průvodce nachází. Tuto funkci můžete pro jednotlivé kroky zakázat.
• Průvodci se ve výchozím nastavení animují pro zobrazení, pokud k zobrazení není nutné posouvání. Animace lze vypnout, pokud píšete prohlídku.
• Pokud uživatel spustil více prohlídek, v případě konfliktu se vždy zobrazí ta, která byla spuštěna naposledy.
• Prohlídku můžete vynutit, aby se "přilepila" ke konkrétní stránce. Pokud jste toto chování v prohlídce nedefinovali, může se probíhající prohlídka zobrazovat napříč stránkami. Pokud například máte prohlídku, která odkazuje na tlačítko "Uložit", probíhající prohlídka může na tento prvek odkazovat pokaždé, dokud uživatel nepřejde k dalšímu kroku nebo prohlídku nezavře.
• Průvodce se vodorovně otočí doleva nebo doprava, pokud by jinak byl oříznut šířkou prohlížeče uživatele. Tuto funkci můžete také pro každý krok zakázat.

Návrh vyhledávání

Pokud si chcete vytvořit vlastní vyhledávání s průvodcem, zde je několik zásad, které byste měli zvážit.

1. Vyberte si hlavní cíl prohlídky. Co chcete, aby se uživatelé na konci naučili?
2. Než začnete, zjistěte, kdo je vaše publikum a jaké jsou jejich cíle a zkušenosti. Jaké znalosti o daném procesu mají před zahájením vaší ukázky?
3. Naplánujte si nezbytné kroky a zaměřte se na jednu akci nebo klíčové poznatky pro každý krok. Méně je víc. Čím více kroků vaše ukázka obsahuje, tím je pravděpodobnější, že ji uživatel uprostřed opustí.
4. Ukázky lze spustit pomocí odkazu nebo tlačítka na stránce, nebo automaticky pomocí souboru cookie. Způsob, jakým ukázku zahájíte, má velký vliv na to, zda budou ukázky rušit nebo obtěžovat uživatele, proto si ji pečlivě vybírejte.
5. Nechte kroky a s nimi spojené akce vést návrhem ukázky. Například pokud chcete, aby uživatelé upravovali obsah v jednom kroku, je zřejmým a efektivním postupem ukázat přímo na tlačítko pro úpravy. Špatnou alternativou by bylo mít okno zarovnané na střed s obrázkem a popisem karty pro úpravy. Silnou stránkou ukázek založených na popiscích je, že uživatelům můžete ukázat, co mají dělat, místo abyste to jen popisovali.
6. Názvy, text a obrázky vybírejte až poté, co si v ukázce naplánujete všechny kroky.

Seznam tours

GuidedTour

Následující vyhledávání jsou aktuálně součástí rozšíření, a proto jsou dostupné na jakékoli wiki, kde je nainstalován GuidedTour.

• Test - Jednoduchá ukázka, která ukáže, co mohou udělat ukázky (Code, demonstration).
• First edit - Ukázka, která vám ukáže, jak provést první úpravu pomocí editoru Wikitext (Code, demonstration) nebo VisualEditor (Code, demonstration).

Na wiki

• The Wikipedia Adventure - tento projekt je pilotem herního zážitku pro výuku lana, hostovaného na Dobrodružství na Wikipedii na anglické Wikipedii (Kód 1. úrovně).
• WikiMOOC #2, francouzský MOOC o Wikipedii s využitím 17 prohlídek (označeno jako interaktivní tutoriál v obsahu).
  • Seznam všech úvodních stránek: fr:Category:Tutoriel WikiMOOC 2017
  • Seznam všech odpovídajících JS skriptů: fr:Category:Guided tour
• Aide:Wikipédia Pas à Pas, opětovné použití těchto výukových programů v samostatné verzi.

Neváhejte a přidejte si své vlastní ukázky do příslušného seznamu výše.

Další příklady najdete vyhledáním "prefix:MediaWiki:Guidedtour-tour", např. na Enwiki.

Nápady na vyhledávání

Potenciální ukázky zahrnují téměř všechny úkoly, které jsou v současnosti pokryty v nápovědě k projektům Wikimedie. Začínáme s Wikipedií a s úkoly, které jsou nejběžnější nebo nejatraktivnější pro nově registrované editory, protože právě oni jsou skupinou, která s největší pravděpodobností potřebuje ukázku rozhraní nebo aktivity s průvodcem.

• Vytvoření stránky
• 'Vaše uživatelská stránka' – k čemu slouží atd.
• Jak přidat/upravit referenci
• Jak přidat obrázek
• Seznam sledovaných položek – jaké jsou jeho důležité prvky, jak do něj přidat další položky atd.
• Pomocníci v procesu: jak požádat o přesun, jak podat žádost o smazání atd.

„Prosím, přidejte to na seznam!“

Technická dokumentace

Ukázky stavby a spouštění

Ukázku s průvodcem tourname na stránce spustíte přidáním proměnné tour=tourname do řetězce dotazu adresy URL, která na ni odkazuje, nebo voláním funkce mw.guidedTour.setTourCookie( tourName ) pro nastavení souboru cookie pro další načtení stránky. Můžete jej také spustit okamžitě s modulem mw.guidedTour.launcher.launchTour (vyžaduje pouze modul ext.guidedTour.launcher). V případě potřeby můžete nastavit i soubor cookie ze serveru. Díky tomu rozšíření GuidedTour načte jak kód pro zobrazení ukázky, tak i samotnou ukázku.

Ukázku definujete v souboru JavaScript ve vaší příponě nebo v jmenném prostoru MediaWiki (MediaWiki:Guidedtour-tour-tourname.js). Velká část tohoto souboru jednoduše pojmenovává prvky každého kroku ukázky – titlemsg, descriptionmsg, tlačítko 'Další' atd. Jednotlivé wikiny mohou přepsat CSS na MediaWiki:Guidedtour-custom.css.

• Chcete-li přidat ukázku úpravou wiki, podívejte se na stránku Napište ukázku na wiki. To může udělat jakýkoli lokální správce wiki.
• Chcete-li spojit ukázku s vaším rozšířením, podívejte se na článek Napsat ukázku rozšíření. To vyžaduje přístup k repozitáři kódu pro vaši wiki a právo instalovat rozšíření.
• Dokumentaci k API naleznete na stránce https://doc.wikimedia.org/GuidedTour/master/#!/api/mw.guidedTour.