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). If your guider step points to an additional action you want the user to take (e.g. Edit or View history), it is a bad idea to have the tour button perform this action for them. 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. The position of the guider relevant to the page element is specified with orientations such as topLeft, top, topRight, rightTop, right, etc. (Viz podrobnosti )

Popis chování průvodce

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. For instance, if you have a tour that points to the "Save" button, a tour that is in progress might point at this element every time until the user moves to the next step or dismisses the tour.
• A guider will flip horizontally to the left or right, if it would otherwise be cut off by the width of the user's browser. You can also disable this for each step.

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. Choose a primary goal for the tour. What do you want users to learn by the end?
2. Know who your audience is before you start, and what their goals and experiences are. What knowledge about a process do they have before starting your tour?
3. Plot the necessary steps, focusing on the one action or key takeaway for each step. Less is more. The more steps in your tour, the more likely a user is to abandon your tour in the middle.
4. Tours can be started via a link or button within a page, or automatically via a cookie. How you start a tour has a big impact on the potential for delivering tours that interrupt or annoy users, so choose carefully.
5. Let the steps and their associated actions guide the design of the tour. For example, if you want users to edit as one step, pointing directly to the edit button is the obvious and efficient thing to do. A poor alternative would be to have a center-aligned window with an image and description of the edit tab. The strength of tooltip-based tours is that you can show users what to do, instead of simply describing it.
6. Choose titles, body text, and images only after you have plotted all steps in your tour.

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 - Simple tour to show what tours can do (Code, demonstration).
• First edit - A tour showing you how to make your first edit using the wikitext (Code, demonstration) editor or VisualEditor (Code, demonstration).

Na wiki

• The Wikipedia Adventure - this project is a pilot of a game-like experience for learning the ropes, hosted at The Wikipedia Adventure on English Wikipedia (Level 1 Code).
• WikiMOOC #2, french MOOC about Wikipedia using 17 tours (marked as interactive tutorial on the table of content).
  • List of all the starting pages: fr:Category:Tutoriel WikiMOOC 2017
  • List of all the corresponding JS scripts: fr:Category:Guided tour
• Aide:Wikipédia Pas à Pas, a re-use of these tutorials in a standalone version.

Feel free to add your own tours to the appropriate list above.

Find more examples by searching for "prefix:MediaWiki:Guidedtour-tour", e.g. at Enwiki.

Building and launching tours

You launch a guided tour on a page by adding tour=tourname to the query string of a URL linking to it, or by calling mw.guidedTour.setTourCookie( tourName ) to set a cookie for the next page load. You can also launch it immediately with mw.guidedTour.launcher.launchTour (requires only the ext.guidedTour.launcher module). You can set the cookie from the server if appropriate too. This will cause the GuidedTour extension to load both the code to display the tour and the tour itself.

You define your tour in a JavaScript file in your extension, or in the MediaWiki namespace (MediaWiki:Guidedtour-tour-tourname.js). Much of this file simply names the elements of each step of the tour — a titlemsg, descriptionmsg, a 'next' button, etc. Individual wikis can override the CSS at MediaWiki:Guidedtour-custom.css.

• To add a tour by editing your wiki, see Write an on-wiki tour. Any local wiki administrator can do this.
• To bundle a tour with your extension, see Write an extension tour. This requires access to the code repository for your wiki and the right to install extensions.
• For API documentation, see https://doc.wikimedia.org/GuidedTour/master/#!/api/mw.guidedTour

Toto rozšíření se používá na jednom nebo více projektech Wikimedia. Pravděpodobně to znamená, že rozšíření je stabilní a funguje dostatečně dobře, aby jej mohly používat weby s tak vysokou návštěvností. Vyhledejte tento název rozšíření v konfiguračních souborech CommonSettings.php a InitialiseSettings.php Wikimedie, abyste viděli, kde je nainstalováno. Úplný seznam rozšíření nainstalovaných na konkrétní wiki lze vidět na stránce wiki Special:Version.

Toto rozšíření je zahrnuto v následujících wiki farmách/hostitelích a/nebo balíčcích: Miraheze Category:Extensions included in Miraheze/cs WikiForgeCategory:Extensions included in WikiForge/cs Toto není autoritativní seznam. Některé wiki farmy/hostitelé a/nebo balíčky mohou toto rozšíření obsahovat, i když zde nejsou uvedeny. Pro potvrzení se vždy obraťte na své wiki farmy/hostitele nebo balíček.