Seznam a popis shortcodes

Z Manuály FFUK
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.

Uživatelská pole

V editaci stránky si nejprve kliknutím na "Nastavení zobrazených informací" vpravo nahoře rozbalte seznam zobrazovaných polí a zaklikněte "Uživatelská pole".

Uživatelská pole

Poté dole pod obsahem stránky v sekci "Uživatelská pole" vyberte pod Název "ukid" a do pole Hodnota vyplňte osobní číslo.

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 přes SIS formou jednoduchého výpisu. Připravuje se parametrizovatelná verze čerpající data přímo z OBD, ve které půjde nastavit např. formát výstupu, rozsah let a typy publikací. Viz níže.

Formát shorctcode je:

[ffuk-obd ukid="12345678" header="Publikace"]

  • 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ě vypnout, použijte parametr s prázdnou hodnott: header="". Viz výše.

Nová testovací verze:

Nová testovací verze čerpá data přímo z OBD, umožňuje výstup detailně parametrizovat, nastavit různé citační styly a to jak editorům webové stránky, tak samotným návštěvníkům stránek, návštěvníkům stránek zároveň umožňuje publikace různým způsobem řadit a exportovat bibliografické údaje ve formátu BibTex a JSON-CSL.

Formát shorctcode je:

v minimální verzi: [ffuk-obd2 ukid="12345678"] resp. pokud je parametr UKID nastaven v uživatelském poli (viz výše), stačí jen [ffuk-obd2], doporučené zobrazení je omezeno na běžné druhy publikací: [ffuk-obd2 druh="73,67,57,63,106"]

v maximální verzi (se všemi existujícími parametry):

[ffuk-obd2 ukid="12345678" ustav="ÚAJD" header="Publikace" styl="csn" radit="autor" odrazky="0" odrok="1348" dorok="9999" druh="73,67,57,63,106" nedruh="86,122" idpub="12345,54321" neidpub="98765" ]

  • 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ě vypnout, použijte parametr s prázdnou hodnotu: header="". Viz výše.
  • Parametr "ústav" může obsahovat zkratku ZS velkými písmeny s diakritikou. Pokud je vyplněn v kombinaci s UKID, budou zobrazeny jen publikace autora připsané dané ZS. Pokud je uveden bez parametru UKID, zobrazí se všechny publikace ZS (všech autorů).
  • Parametr "styl" definuje výchozí citační styl (citační styl si může přenastavit i návštěvník stránek). V tuto chvíli je možná nastavit následující citační styly:
    • "apn" - American Psychological Association 6th edition (doporučujeme pro méně obvyklé druhy výsledků, jako nepublikované konferenční příspěvky)
    • "csn" - ČSN (ISO690cs)
    • "chicago" - Chicago Manual of Style 17th edition
    • "mla" - Modern Language Association 8th edition

Pokud vaše ZS, jazyková oblast či váš obor využívá jiný citační styl a tento styl naleznete v Zotero Style Repository , požádejte o jeho přidání LVT.

  • Parametr "radit" určuje výchozí řazení publikací (řazení může změnit návštěvník stránek) a může nabývat hodnot "author", "date-desc" (dle data sestupně) a "date-asc" (dle data vzestupně).
  • Parametr "odrazky" určuje, zda budou automaticky zobrazeny (hodnota 1) nebo nezobrazeny (hodnota 0) odrážky usnadňující orientaci v dlouhém seznamu publikací (zobrazení odrážek může změnit návštěvník stránek).
  • Parametry "odrok" a "dorok" určují mezní roky vydání zobrazených publikací (včetně). Pokud parametr "dorok" nastavíte na hodnotu "NOW", bude horní hranice vždy v aktuálním roce a parametr "odrok" bude chápán relativně. Tedy např. dorok="NOW" odrok="5" zobrazí publikace za posledních 5 let.
  • Parametry "druh" a "nedruh" určují pomocí číselných kódů pozitivní a negativní omezení dle druhu publikace, oba parametry mohou nabývat více hodnot, hodnoty se oddělují čárkou. Např. druh="63,67" zobrazí jen knihy a kapitoly v knihách. Přípustné hodnoty pro nejčastější typy publikací jsou: 73 článek v časopisu; 67 kapitola v knize; 57 příspěvek v konferenčním sborníku; 63 kniha; 106 stať ve sborníku prací (nekonferenčním); 81 přednáška, poster; 109 uspořádání konference, workshopu, výstavy; 121 jiný výsledek; 70 audiovizuální tvorba; 17 akademická práce; 110 abstrakt; 83 software.
  • Parametry "idpub" a "neidpub" určují pomocí ID publikace pozitivní a negativní omezení výpisu na konkrétní publikace, oba parametry mohou nabývat více hodnot, hodnoty se oddělují čárkou. Např. idpub="12345,54321" zobrazí seznam pouze dvou publikací s ID 12345 a 54321. Naopak neidpub="12345,54321" vypíše seznam publikací bez publikací s ID 12345 a 54321. Obecně pro vyřazení publikací, které autoři nechtějí zobrazit na webu, doporučujeme spíše využít modulu "Moje významné publikace" v rámci OBD (poslední položka horního menu), kde si každý autor může odznačit publikace, které nechce vypisovat na web.

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.

Rozvrh

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.

Externí kalendáře (iCal)

Externí kalendáře (odkaz na veřejně přístupný soubor .ics) je třeba nejprve přidat v administraci v sekce Kalendáře. V seznamu kalendářů pak lze najít příslušný shortcode.

Formát shortcode je:

[ffuk-calendar code="harmonogram-akademickeho-roku" display="1"]

  • Hodnotou parametru "code" je kód kalendáře, který lze najít v administraci v sekci Kalendáře. Zobrazit lze najednou více kalendářů pomocí parametrů "code1", "code2" atd.
  • Nepovinný parametr display="1" způsobí výchozí zobrazení grafické části kalendáře nad výpisem událostí.
  • V přípravě je vylepšená verze pro vkládání kalendáře založeného na více ics souborech.

Ukázková stránka

Vyplňte osobní číslo do uživatelského pole "ukid" dle návodu výše a do obsahu stránky vložte následující shortcodes:

[ffuk-whois display="funkce;email;telefon;www;adresa;clenstvi;hodiny" hodiny="whois"]

[ffuk-obd]

[ffuk-zaverecne]

[ffuk-rozvrh]

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

Citováno z „http://manualy.ff.cuni.cz/index.php?title=Seznam_a_popis_shortcodes&oldid=1926“