wiki:cs/SablonaStrankyProjektu

Version 7 (modified by Zuzana Nevěřilová, 5 years ago) (diff)

--

Šablona stránky projektu

Tato stránka slouží k tomu, aby bylo pro členy CZPJ snadné dodržovat pravidla provozu CZPJ. Každý projekt má mít stránku, která je veřejně přístupná a informuje aktuálně o stavu projektu.

Veřejně přístupná stránka

V adresáři projektu /nlp/projekty/OZNACENI_PROJEKTU vytvořte adresář public_html. V tomto adresáře vytvořte soubor .htaccess, kterým nastavíte přístup ke stránkám projektu.

Aspoň základní informace o projektu by měly být veřejné, .htaccess tedy bude obsahovat řádek:

Allow from all

Pokud chcete mít další části projektu neveřejné, dejte je do podadresáře /nlp/projekty/OZNACENI_PROJEKTU/public_html/NEVEREJNA_DATA a opět pomocí .htaccess nastavte přístup do tohoto neveřejného adresáře.

Standardní nastavení (tj. bez .htaccess) je bez hesla z domény fi.muni.cz, odjinud po přihlášení s heslem na stroje CZPJ.

Bezpečná data

Do adresáře /nlp/projekty/OZNACENI_PROJEKTU zkopírujte všechna data potřebná k fungování projektu: zdrojové kódy, konfigurační soubory, případně data (pokud nejsou moc velká). Oproti tomu do adresáře /nlp/projekty/OZNACENI_PROJEKTU/public_html nekopírujte nic, co nechcete, aby někdo zvenku viděl. Typicky v tomto adresáři nesmí být konfigurační soubory obsahující hesla.

Webové demo

Kromě popisu projektu je dobré ukázat prostřednictvím webové aplikace, co program dělá. Součástí webového dema by mělo být omezení přístupu (TODO:jak na omezení přístupu). Webové demo je typicky "obálkou" programu spustitelného z příkazové řádky (TODO: jak na demo).

Povinné součásti stránky projektu

Pro vytvoření stránky projektu můžete použít šablonu stránky a šablonu stylu.

Stránka projektu může být v češtině, slovenštině nebo angličtině, angličtinu preferujeme.

<html lang="en">

Nemusíte vytvářet jazykové mutace, ale když to uděláte, budeme rádi. V následujícím výčtu jsou povinné součásti stránky projektu.

  • Název projektu
  • Klíčová slova
  • Stručný popis projektu
  • Příklad použití (případně screenshot, screencast)
  • Popis, jak aplikaci spustit (popis instalace, popis spuštění z příkazové řádky...)
  • Pokud dáváte k dispozici aplikaci ke stažení a instalaci, můžete poskytnout vzorek dat
  • Nejlepší publikace, které se k aplikaci vztahují (ano, i bakalářská práce je publikace)
  • Changelog
  • Acknowledgement, pokud projekt vzniká v rámci grantového projektu
  • Licence

Klíčová slova

Do hlavičky stránky uveďte klíčová slova:

 <meta name="keywords" content="visualization, visualisation, rdf, semantic web, owl, lexicon"/>

Publikace

Vyberte max. 5 publikací, které jsou k projektu relevantní. Citační záznam zkopírujte z IS MU. Ke každému záznamu uveďte i BibTeX, ať usnadníte lidem práci.

Pokud použijete jQuery, můžete přidat do stránky následující skript, který zobrazí BibTeX podobně jako na stránkách.

Do hlavičky stránky:

<script src="https://ajax.googleapis.com/ajax/libs/jquery/1.9.1/jquery.min.js" type="text/javascript"></script>

Následující kód zobrazí odkaz "show BibTeX" a po kliknutí na něj zobrazí BibTeXový záznam.

<script>
  jQuery(document).ready(function() {
    var bibtexElements = document.getElementsByClassName("bibtex");
    var showBib = "show BibTeX";
    var hideBib = "hide BibTeX";
    for (var i = 0; i<bibtexElements.length; i++) {
       var element = bibtexElements[i];
       var parent = element.parentNode;
       var wrapper = document.createElement("div");
                        wrapper.className = "bibtex-element";
       var heading = document.createElement("div");
       heading.className = "bibtex-heading";
       heading.innerHTML = showBib;
       parent.replaceChild(wrapper, element);
       wrapper.appendChild(heading);
       wrapper.appendChild(element);
       element.style.display = 'none';
    }

    // drop-down bibtex box
    jQuery(".bibtex-heading").click(function(){
       Query(this).next(".bibtex").slideToggle(500);
       if (this.innerHTML == showBib) {
           this.innerHTML = hideBib;
       } else {
           this.innerHTML = showBib;
       }
    });
 });
</script>

Je potřeba, aby záznam byl uvnitř třídy bibtex, například takto:

HORÁK, Aleš, Karel PALA a Adam RAMBOUSEK. Tools for Managing Multilingual Lexical Resources. In <em>Procedings of the 16th International Conference Intel
ligent Information Systems</em>. Zakopane, Poland: Polish Academy of Sciences, 2008. s. 451-460, 10 s. ISBN 978-83-60434-44-4.
<div class="bibtex">
@inproceedings{770979,
   author = {Horák, Aleš and Pala, Karel and Rambousek, Adam},
   address = {Zakopane, Poland},
   booktitle = {Procedings of the 16th International Conference Intelligent Information Systems},
   keywords = {DEB platform; dictionary editor and browser; dictionary writing systems},
   language = {eng},
   location = {Zakopane, Poland},
   isbn = {978-83-60434-44-4},
   pages = {451-460},
   publisher = {Polish Academy of Sciences},
   title = {Tools for Managing Multilingual Lexical Resources},
   url = {http://iis.ipipan.waw.pl/2008/proceedings/iis08-45.pdf},
   year = {2008}
}
</div>

Do kaskádového stylu přidejte:

.bibtex{
        background: rgba(222, 222, 222, 0.51);
        padding: 13px 13px 0px 15px;
        display: none;
        white-space: pre;
        font-family: monospace;
        overflow: scroll;
}

Changelog

Měli byste popsat, v jaké fázi projekt je. Začněte začátkem projektu, v průběhu pište, co jste dělali. Changelog může a nemusí odpovídat měsíčním zprávám. U dlouhodobých projektů nechte jen relevantní změny.

Licence

Webové aplikace můžete licencovat pod licencí NLPC. Pokud jsou zdrojové kódy otevřené, uveďte některou otevřenou licenci (například GPL).

Pro inspiraci

Pokud chcete vidět, jak může vypadat stránka projektu a jak můžete svoji stránku upravit, podívejte se na stránku projektu VisualBrowser.

Ke stažení

Šablony:

Attachments (2)

Download all attachments as: .zip