Widget:Ascii/doc

Z thewoodcraft.org

Toto je dokumentace k widgetu Widget:Ascii.

Vedle návodu k použití obsahuje kategorie, odkazy interwiki a další obsah, který není součástí kódu widgetu.

Tento widget umožňuje vložit do wiki .json soubor se záznamem linuxové konzole, který pořízený přes aplikaci asciinema.

Aktualizace

Widget využívá tzv. standalone JS bundle skript, což je javascriptový skript sestavený ze všech komponent do jednoho svazku. Je nakopírovaný do lokálního adresáře (ze kterého si ho TheWoodcraft.org natahuje) a přejmenovaný podle čísla verze.

Aktualizace widgetu se udělá jednoduše tím, že se stáhne nová verze, přejmenuje a v kódu widgetu se změní cesta tak, aby používala aktualizované soubory.

Použití

V kódu wiki stránky se tento widget aplikuje takto: 

{{#widget:Ascii
|url=https://www.thewoodcraft.org/wiki/images/a/a4/asciicast_v1.json
|theme=solarized-light
}}

URL použité v tomto ukázkovém widgetu vede na asciicastový soubor Soubor:asciicast v1.json, jehož obsah demonstruje také rozdíl mezi asciicasten verze 1 (JSON) a verze 2. Interpretace widgetu pak vypadá takto:

Parametry

Rozměry terminálu přehrávaného okna nejsou rozměry okna přehrávače, ale terminálové konzole. Při přehrávání se používá font typu monotype:

rows
udává počet zobrazených řádků konzole (default 24)
cels
udává počet sloupců konzole (default 80)
url
Je základní parametr, kterým se odkazuje na přehrávaný .json soubor. URL může být absolutní (včetně http://…, nebo absolutní vůči kořeni webu. V našem případě, je záznam uploadován do wiki, proto je cesta /wiki/images/a/a4/asciicast v1.json, ale mohl by být umístěn i do lokálního úložiště wiki, do kterého je cesta /pub/wiki/…

Ostatní parametry již tak důležité nejsou, kromě…

title
Při implementace přehrávače asciinema-player přes rozšíření Widget, lze totiž na jedné wiki stránce umístit pouze v jednu instanci přehrávače. Ve většině případů to nepředstavuje omezení, ovšem pokud chceme přehrávat na jedné stránce záznamů více, je potřeba element, ve kterém widget přehrává záznam pojmenovat jinak. A k tomu slouží právě tento parametr.
size
umožňuje upravit velikost zobrazovaného písma – výchozí je small (medium, big)
speed
mění rychlost přehrávání (výchozí 1)
theme
nastavuje barevné schéma terminálového oknav. Výchozí je asciinema (tango, solarized-dark, solarized-light, monokai)
start
umožňuje posunout začátek přehrávání (výchozí je 0)
autoplay
0/1
preload
0/1 automatický start přehrávání
loop
Udává počet přehrání, pokud chceme záznam pustit ve smyčce. Výchozí hodnota je 1. Pokud chceme nekonečnou smyčku, lze nastavit 0.

Ovládání přehrávače:

  • Pro posun tam i zpět fungují, kromě klávesových zkratek (Ctrl+H Ctrl+L), také šipky
  • Přehrávání lze zapauzovat mezerníkem. Jinak lze použít klávesovou zkratku (Ctrl+P), nebo myš.
  • Fullscreen – klávesou f
  • Číslice 0, 1, 2 … 9 pro skok na 0%, 10%, 20% … 90%
Citováno z „https://www.thewoodcraft.org/wiki/index.php?title=Widget:Ascii/doc&oldid=105858“