Seznam a popis shortcodes

Z Manuály FFUK
Verze z 19. 10. 2015, 13:46, kterou vytvořil TICHO1AF (diskuse | příspěvky) (Založena nová stránka s textem „Pomocí vložení tzv. shortcode můžeme na stránku čerpat informace z externích systémů (např. osobní údaje, rozvrh nebo publikace osoby/součás…“)
(rozdíl) ← Starší verze | zobrazit aktuální verzi (rozdíl) | Novější verze → (rozdíl)
Skočit na navigaci Skočit na vyhledávání

Pomocí vložení tzv. shortcode můžeme na stránku čerpat informace z externích systémů (např. osobní údaje, rozvrh nebo publikace osoby/součásti). Informace se na stránce vypíší přesně v místě, kde je shortcode vložen, lze tedy volně kombinovat vlastní obsah a informace z externích systémů (např. úvodní text následovaný seznamem publikací). Shortcode má formu několika nastavitelných parametrů v hranatých závorkách a je vhodné ho nijak neformátovat.

Osobní číslo

Klíčovým parametrem pro informace čerpané z externích systémů o konrétní osobě je osobní číslo "ukid". Jedná se o číslo vytištěné na průkazu zaměstnance/studenta a lze ho také zjistit podle přihlašovacího jména ve webové aplikace ldap.cuni.cz nebo v osobních údajích v SIS. Tento parametr lze buď přidat do konkrétního shortcode nebo ho přidat jako uživatelské pole pro konkrétní stránku webu - všechny shortcodes zadané na této stránce bez specifického ukid pak budou čerpat informace o tomto ukid.

Nadpis

Volitelným parametrem všech typů shortcodes kromě osobních a kontaktních informací je "header". Hodnota parametru určuje nadpis pro daný blok čerpaných informací (např. header="Co jsem napsal"). Pokud parametr není uveden, použije se výchozí hodnota, např "Publikace". Chcete-li nadpis úplně vypnout, použijte parametr s prázdnou hodnout: header="".

Osobní a kontaktní informace

Osobní a kontaktní informace se čerpají z univerzitního systému WhoIS (za jejich správnost zodpovídají katederní správci WhoIS a osobní oddělení) a ze SIS. Jedná se o následující typy informací:

  • funkce (např. vedoucí)
  • členství (např. člen oborové rady)
  • email
  • telefon
  • osobní web stránka
  • školní adresa
  • konzultační hodiny (lze čerpat z WhoIS nebo ze SIS)

Formát shorctcode je:

[ffuk-whois display="funkce;clensvi;email;telefon;www;adresa;hodiny" hodiny="sis" ukid="12345678"]

  • Jednotlivé typy informací oddělené středníkem v hodnotě parametru display lze libovolně mazat, pokud se nemají zobrazovat.
  • Parametr hodiny určuje, odkud se čerpá informace o konzultačních hodinách a může mít buď hodnotu "sis" jako v příkladu výše, nebo "whois" (pokud není stanoven, výchozí hodnotou je "whois").
  • Hodnota parametru "ukid" odpovídá osobnímu číslu a nemusí být uveden, pokud je výchozí osobní číslo zadáno pomocí uživatelského pole. Viz výše.
  • Hodnota volitelného parametru "header" určuje nadpis pro daný blok čerpaných informací (např. header="Co jsem napsal"). Pokud parametr není uveden, použije se výchozí hodnota, např "Publikace". Chcete-li nadpis úplně vynpout, použijte parametr s prázdnou hodnout: header="". Viz výše.


Publikace

Publikace se čerpají z OBD formou jednoduchého výpisu. Připravuje se parametrizovatelná verze, ve které půjde nastavit např. formát výstupu, rozsah let a typy publikací.

Formát shorctcode je:

[ffuk-obd ukid="12345678"]

  • Hodnota parametru "ukid" odpovídá osobnímu číslu a nemusí být uveden, pokud je výchozí osobní číslo zadáno pomocí uživatelského pole. Viz výše.
  • Hodnota volitelného parametru "header" určuje nadpis pro daný blok čerpaných informací (např. header="Co jsem napsal"). Pokud parametr není uveden, použije se výchozí hodnota, např "Publikace". Chcete-li nadpis úplně vynpout, použijte parametr s prázdnou hodnout: header="". Viz výše.


Závěrečné práce

Závěrečné práce se čerpají ze SIS. Lze je čerpat pro osobu (školitele/vedoucího/oponenta), nebo za celou součást.

Formát shorctcode pro osobu je:

[ffuk-zaverecne ukid="12345678"]

  • Hodnota parametru "ukid" odpovídá osobnímu číslu a nemusí být uveden, pokud je výchozí osobní číslo zadáno pomocí uživatelského pole. Viz výše.
  • Hodnota volitelného parametru "header" určuje nadpis pro daný blok čerpaných informací (např. header="Co jsem napsal"). Pokud parametr není uveden, použije se výchozí hodnota, např "Publikace". Chcete-li nadpis úplně vynpout, použijte parametr s prázdnou hodnout: header="". Viz výše.

Formát shorctcode pro součást je: [ffuk-zaverecne ustav="21-XYZ"]

  • Hodnota parametru "ustav" odpovídá zkratce součásti s předčíslím "21" (pro FF) a pomlčkou, např. "21-UAJD".
  • Hodnota volitelného parametru "header" určuje nadpis pro daný blok čerpaných informací (např. header="Co jsem napsal"). Pokud parametr není uveden, použije se výchozí hodnota, např "Publikace". Chcete-li nadpis úplně vynpout, použijte parametr s prázdnou hodnout: header="". Viz výše.

Závěrečné práce=

Rozvrh se čerpá ze SIS.

Formát shorctcode je:

[ffuk-rozvrh ukid="12345678"]

  • Hodnota parametru "ukid" odpovídá osobnímu číslu a nemusí být uveden, pokud je výchozí osobní číslo zadáno pomocí uživatelského pole. Viz výše.
  • Hodnota volitelného parametru "header" určuje nadpis pro daný blok čerpaných informací (např. header="Co jsem napsal"). Pokud parametr není uveden, použije se výchozí hodnota, např "Publikace". Chcete-li nadpis úplně vynpout, použijte parametr s prázdnou hodnout: header="". Viz výše.

Rozvrh za celou součást je vhodné vytvářet pomocí rozvrhové aplikace rozvrhy.ff.cuni.cz a ze stránek na ně odkazovat. Vložit rozvrh ze SIS za celou součást přes shortcode je možné pomocí kalendářového pluginu (na dotaz LVT).

Vyučované předměty=

Vyučované předměty se čerpají ze SIS.

Formát shorctcode je:

[ffuk-predmety stav="V" neverejny="0" ukid="12345678"]

  • Hodnota parametrů "stav" a "neverejny" určuje, zda se mají vypisovat i nevyučované předněty (stav="N") a neveřejné předměty (neverejny="1").
  • Hodnota parametru "ukid" odpovídá osobnímu číslu a nemusí být uveden, pokud je výchozí osobní číslo zadáno pomocí uživatelského pole. Viz výše.
  • Hodnota volitelného parametru "header" určuje nadpis pro daný blok čerpaných informací (např. header="Co jsem napsal"). Pokud parametr není uveden, použije se výchozí hodnota, např "Publikace". Chcete-li nadpis úplně vynpout, použijte parametr s prázdnou hodnout: header="". Viz výše.

Konzultace=

Konzultační hodiny je možné zobrazit i jako samostatný blok mimo Osobní a kontaktní informace (výše). V tomto případě se čerpají ze SIS a je možné je zobrazit pro osobu nebo pro celou součást.

Formát shorctcode pro osobu je:

[ffuk-konzultace ukid="12345678"]

  • Hodnota parametru "ukid" odpovídá osobnímu číslu a nemusí být uveden, pokud je výchozí osobní číslo zadáno pomocí uživatelského pole. Viz výše.
  • Hodnota volitelného parametru "header" určuje nadpis pro daný blok čerpaných informací (např. header="Co jsem napsal"). Pokud parametr není uveden, použije se výchozí hodnota, např "Publikace". Chcete-li nadpis úplně vynpout, použijte parametr s prázdnou hodnout: header="". Viz výše.

Formát shorctcode pro součást je:

[ffuk-konzultace ustav="21-XYZ"]

  • Hodnota volitelného parametru "header" určuje nadpis pro daný blok čerpaných informací (např. header="Co jsem napsal"). Pokud parametr není uveden, použije se výchozí hodnota, např "Publikace". Chcete-li nadpis úplně vynpout, použijte parametr s prázdnou hodnout: header="". Viz výše.
  • Hodnota volitelného parametru "header" určuje nadpis pro daný blok čerpaných informací (např. header="Co jsem napsal"). Pokud parametr není uveden, použije se výchozí hodnota, např "Publikace". Chcete-li nadpis úplně vynpout, použijte parametr s prázdnou hodnout: header="". Viz výše.