wiki:cs/SablonaStrankyProjektu

Version 3 (modified by Zuzana Nevěřilová, 6 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.

Bezpečná stránka

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.

Povinné součásti stránky projektu

Stránka projektu může být v češtině, slovenštině nebo angličtině, angličtinu preferujeme. 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
  • 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

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>
<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>

Attachments (2)

Download all attachments as: .zip