Redmine

Z Wikiknih
Jump to navigation Jump to search

Cílem této dokumentace je poskytnout návod pro nasazení a rutinní používání Redmine - bezplatného open source webového nástroje pro správu projektů a sledování problémů (bug tracking).
Administrátorská příručka pokrývá oblast instalace, nastavení a údržby systému, uživatelská pak správu projektů a rutinní používání. Text je tedy primárně určen těm, kdo již Redmine používají nebo se jej rozhodli používat. Může však posloužit i jako vodítko při volbě elektronického nástroje pro koordinaci činnosti a vzájemnou komunikaci formální či neformální skupiny lidí.

Pakliže jste se v uvedeném našli, neztrácejme čas a podívejme se Redmine na zoubek.

Funkční rysy[editovat]

Detailní představu o produktu lze získat z tabulky oprávnění [[<doplnit>]].
Demonstrační instalace Redmine je k dispozici na tomto serveru. Oprávnění jsou pochopitelně omezena pouze na správu dílčího projektu a instlaca má i další limity (velikost uploadu, bez vazby na SVN,..).

Technická poznámka:[editovat]

Jedná se o multiplatformní řešení postavené na Ruby on Rails pod licencí GNU General Public License v2. Data mohou být uložena v MySQL, PostgreSQL nebo SQLite. Jako webový server slouží Apache nebo WEBrick (nedoporučuje se pro produkční nasazení).

Více informací jako např. aktuální verzi, plán vydání, diskuzní fórum či bugtracking naleznete na oficiálních stránkách projektu.

Administrace[editovat]

Instalace[editovat]

Softwarové požadavky[editovat]

jsou závislé od verze a jejich seznam (požadavky jsou kladeny na Ruby, Ruby on Rails, Rack, databázový a webový server) je udržován zde.

Získání Redmine[editovat]

Získat Redmine lze těmito způsoby:

Instalační kroky[editovat]

  1. zvolit zdroj a verzi Redmine a v případně potřeby ověřit softwarové požadavky
  2. vytvořit prázdnou databázi a odpovídající uživatelský účet (pojmenovaný např. redmine)
  3. vytvořte kopii souboru <redmineRoot>/config/database.yml.example a pojmenujte ji jako <redmineRoot>/config/database.yml. Soubor upravte tak, aby odpovídal vaší situaci (obvykle nastavujete sekci "production")
  4. vygenerujte úložiště pro důvěrná session data
  5. vytvořte databázovou strukturu spuštěním následujícího příkazu z adresáře <redmineRoot>
  6. výchozí konfigurační data vygenerujete příkazem (stále v <redmineRoot>):
  7. nastavte přístupová práva k následujícím adresářům:
  8. pro otestování instalaci zpřístupněte Redmine spuštěním w:en:WEBrick serveru (pro produkční prostředí je vhodnější [[w:Apache_HTTP_Server|Apache)
  9. přihlaste se pomocí výchozího administračního účtu

Provoz a údržba[editovat]

Administrace webu[editovat]

  • Projekty – zakládání nových projektů, jejich archivace či rušení
  • Uživatelé – registrace uživatelů, přehled o stávajících s možností uzamčení účtu
  • Skupiny – vytváření/rušení skupin
  • Role a práva – vytváření/rušení rolí a nastavení jejich pořadí. Standardně jsou k dispozici role
    • Manažer
    • Vývojář
    • Reportér
    • Non member
    • Anonymous
poslední dvě jmenované jsou fixní tj nelze je odebrat
odkazem „Přehled práv“ se zobrazí tabulka, jejíž výchozí podobu zachycuje obrázek
Přehled práv
  • Fronty – vytváření/rušení front<>. Při zakládání se určuje i dostupnost podle projektů
  • Stavy úkolů – vytváření/rušení dostupných stavů a nastavení jejich pořadí
    Stavy úkolů
  • Průběh práce – umožňuje nastavit možné přechody mezi stavy pro zvolenou roli a frontu
    Workflow
  • Uživatelská pole - vytváření/rušení uživatelských polí a nastavení jejich vlastností
    Uživatelská pole
  • Seznamy – modifikace seznamů dle jednotlivých kategorií
    Seznamy
  • Nastavení – určuje chování Redmine serveru. Volby jsou rozčleněny to osmi karet:
    • Obecné
      • Název aplikace
      • Uvítací text
      • Maximální velikost přílohy
      • Povolené počty řádků na stránce
      • Povoleno více hodnot (oddělěné čárkou).
      • Dny zobrazené v činnosti projektu dny
      • Jméno serveru
      • Protokol (HTTP nebo HTTPS)
      • Formátování textu (textile nebo nic)
      • Ukládat formátovaný text do vyrovnávací paměti
      • Komprese historie Wiki (Gzip nebo nic)
      • Limit obsahu příspěvků
      • Maximální velikost textových souborů zobrazených přímo na stránce
      • Maximální počet zobrazenách řádků rozdílů
    • Zobrazit
      • Téma
      • Výchozí jazyk
      • Začínat kalendáře
      • Formát data
      • Formát času
      • Formát zobrazení uživatele
      • Použít uživatelské ikony Gravatar
      • Výchozí Gravatar
    • Autentifikace
      • Autentifikace vyžadována
      • Automatické přihlašování
      • Povolena automatická registrace
      • Minimální délka hesla
      • Zapomenuté heslo
      • Umožnit přihlašování a registrace s OpenID
      • Zapnout službu REST
    • Projekty
      • Nové projekty nastavovat jako veřejné
      • Výchozí zapnutné moduly pro nový projekt
      • Generovat sekvenční identifikátory projektů
      • Role přiřazená uživateli bez práv administrátora, který projekt vytvořil
    • Sledování úkolů
      • Povolit vazby úkolů napříč projekty
      • Automaticky zobrazit úkoly podprojektu v hlavním projektu
      • Spočítat koeficient dokončení úkolu s
      • Limit pro export úkolů
      • Výchozí sloupce zobrazené v seznamu úkolů
    • Emailová oznámení
      • Odesílat emaily z adresy
      • Příjemci skryté kopie (bcc)
      • pouze prostý text (ne HTML)
      • Vyberte akci při které bude zasláno upozornění emailem
      • Patička emailů
    • Příchozí e-maily
      • Zkrátit e-maily po jednom z těchto řádků
      • Povolit WS pro příchozí e-maily
      • API klíč
    • Repozitáře
      • Automaticky stahovat commity
      • Povolit WS pro správu repozitory
      • API klíč
      • Povolené SCM
      • Kódování
      • Povoleno více hodnot (oddělěné čárkou).
      • Kódování zpráv při commitu
      • Maximální počet revizí zobrazených v logu souboru
      • Odkazování a opravování úkolů ve zprávách commitů
        • Klíčová slova pro odkazy
        • Klíčová slova pro uzavření

Administrace projektu[editovat]

Uživatelská příručka[editovat]

Sled kapitol odráží pomyslný vývoj od uživatele, který se potřebuje v systému zorientovat a najít informaci, přes aktivního účastníka podílejícího se na vzniku a řešení úkolů až po manažera projektu. V závislosti na tom, zda je projekt veřejný či nikoliv, mohou jeho obsah vidět případně do něj přispívat (v závislosti na nastavení práv <+odkaz>) i anonymní uživatelé. Posledně uvedené není příliš obvyklé a pro vytváření obsahu budete potřebovat registraci. Začněte spuštěním internetového prohlížeče<+odkaz> a zadáním URL<+odkaz> adresy, na niž běží Redmine. (Nemáte-li, zkuste to tady<+odkaz>)

registrace[editovat]

Registrace

či chcete-li vytvoření uživatelského účtu se zahajuje kliknutím na odkaz "Registrovat" (v pravé části horní nástrojové lišty), nebo využijete alternativní možnost a přihlásíte se/registrujete pomocí OpenID. V prvém případě vyplněný registrační formulář, kde hvězdičky označují povinné položky, odešlete pomocí tlačítko "Potvrdit". Podle nastaveného způsobu registrace<+odkaz> mohou nastat tyto situace:

  • budete se moci okamžitě přihlásit
  • na zadanou e-mailovou adresu vám bude zaslán URL odkaz pomocí kterého účet aktivujete (s ohledem na ochranu před spamem a administrační nenáročnost je toto obvyklé nastavení)
  • budete muset vyčkat, dokud vaše registrace nebude manuálně potvrzena administrátorem

Pokud vás láká spíše

registrace pomocí OpenID[editovat]

pak vězte, že tato funkce nebývá povolena<+odkaz>, neboť přínos OpenID je při stávající implementaci pro registraci sporný. Proces přihlášení pomocí OpenID sice proběhne, ale s výjimkou OpenID URL nejsou do uživatelského profilu<+odkaz> převzaty žádné údaje, což je při kontrole vyplnění povinných polí poněkud neuspokojivé a matoucí. Každopádně možné scénáře po odkliknutí tlačítka „Potvrdit“ budou stejné, jako v předchozím případě. Pokud vás uvedené od tohoto způsobu registrace neodradilo, pokračujte čtením následující kapitoly, neboť proces splývá s přihlášením.

přihlášení[editovat]

přihlášení

Přihlašovací dialog vyvoláte kliknutím vpravo nahoře na odkaz "Přihlášení". Přihlásíte se zadáním uživatelského jména do kolonky "Přihlášení" a zapsáním hesla. V případě, že jste jej zapomněli, klikněte na "Zapomenuté heslo" (je-li povoleno<+odkaz>) Zvolíte-li si

přihlášení pomocí OpenID[editovat]

obrňte se trpělivostí a počítejte spíše s potížemi, neboť ani tato část podpory OpenID dosud není v dostatečném rozsahu implementována. Dle testování Gmail účet s URL ve tvaru https://www.google.com/accounts/o8/id funguje pouze do ukončení google session, pod kterou jste se registrovali (generuje OpenID URL ukončenou pokaždé jiným čtyřicetiznakovým id řetězcem), pro Google Apps účet tj. https://www.google.com/accounts/o8/site-xrds?hd=vyseDomena.cz nefunguje vůbec (tento zápis by se již neměl používat v důsledku sjednocení účtů Google Apps a Gmail). Bezproblémově se lze přihlásit např. pomocí bezplatné služby myOpenID ve tvaru http://vasUcet.myopenid.com/. V případě podporované služby jsou možné dva scénáře:

  • pokud akci provádíte prvně, budete nejprve přesměrování na zadanou OpenID URL. Po přihlášení ke službě odsouhlaste poskytnutí informací Redmine serveru. Tímto jsou získány potřebné údaje a vy bude přesměrováni zpět na Redmine server, nyní již jako přihlášený uživatel. Nemáte-li OpenID URL dosud uvedenu ve svém účtu, budete vám nejprve zobrazen formulář "Můj účet"<+odkaz>.
  • akci jste již v minulosti prováděli, ale OpenID session není platná. V tomto případě budete přesměrováni na vašeho OpenID poskytovatele. Po ověření budete vráceni zpět na Redmine a přihlášeni.
  • akci jste již prováděli a OpenID session je platná. Tentokrát budete ihned přihlášeni k Redmine serveru (získání přihlašovacích informací od OpenID poskytovatele proběhne skrytě).

Možné poskytovatle OpenID naleznete na tomto seznamu či v jeho stručnější verzi.
Jste-li zaregistrováni, je čas podívat se na rozvržení prostředí, ve kterém se budete pohybovat.

Navigace a ovládací prvky[editovat]

Aktivní prvky jsou z větší části kontextově závislé tj. jejich chování či dostupnost (viditelnost) je dána aktuálně prováděnou činností (otevření modulu, úprava wiki apod.). Jsou seskupeny do následujících oblastí:

Uživatelské rozhraníhorní nástrojová lištazáhlavídolní kontextová lištazobrazovací oblastdolní kontextová lištanavigační panelzápatí
O tomto obrázku

horní nástrojová lišta[editovat]

Je trvale přítomným prvkem, který obsahuje tyto nástroje

  • vlevo
    • Úvodní - zobrazí vstupní stránku společnou pro celý web
    • Moje stránka - odkaz zobrazující úkoly aktuálně přihlášeného uživatele a úkoly jím zadané
    • Projekty - přehled všech projektů které smí uživatel zobrazit
    • Administrace – položka dostupná pouze správcům serveru
    • Nápověda – zobrazí nápovědu ve formě průvodců na serveru www.redmine.org (En)
  • vpravo (viditelnost závisí na přihlášení)
    • Přihlášen jako: - jméno aktuálně přihlášeného uživatele
    • Můj účet - zpřístupní uživatelské předvolby včetně změny hesla
    • Odhlášení
    • Přihlášení
    • Registrovat

záhlaví[editovat]

  • vlevo nahoře
    • název webu nebo aktuálně otevřeného projektu
  • vpravo nahoře
    • vstupní pole fulltextového vyhledávání (ve všech dostupných nebo pouze ve zvoleném projektu)
    • výběr projektu - seznam obsahuje výčet těch, ke kterým je uživatel explicitně přiřazen
  • dole
  • názvy dostupných modulů a odkaz pro založení nového úkolu. Dostupnost modulů závisí na uživatelských právech a aktivaci modulu pro daný projekt

horní kontextová lišta[editovat]

  • v levé části je název modulu nebo aktuálně otevřené položky (úkol, wiki stránky)
  • v pravé části kontextově (dle modulu) dostupné nástroje. Tytéž nástroje často obsahuje dolní kontextová lišta.

zobrazovací oblast[editovat]

  • zobrazuje obsah daného modulu
  • oblast může být rozdělena tak, že vpravo navíc obsahuje kontextový navigační panel

dolní kontextová lišta[editovat]

  • v levé části může být navigace (listování) v rozsáhlých seznamech
  • v pravé části bývají stejné nástroje jako v horní kontextové liště
  • a o řádek níž jsou k dispozici odběry (Atom) či exporty (např. CSV, HTML, PDF, TXT)

zápatí[editovat]

  • informace o produktu

použití modulu úkoly[editovat]

Úkol je srdcem a hnacím motorem celého systému. Umožňuje velmi přímočaře formulovat zadání, termín a řešitele. Ve fázi řešení pak poskytuje prostor pro záznamy o jeho průběhu a zajišťuje informovanost – při každé změně je všem zúčastněným osobám zasláno upozornění. Pokud se při řešení objeví komplikace, lze na ně reagovat vytvořením podúkolů, souvisejících úkolů případně lze změnit nejen řešitele ale i začlenění do projektu. Projekt pak představuje nejvyšší úroveň sdružení úkolů a zároveň nástroj pro řízení přístupu k informacím – správu uživatelů. Nižší úrovně tvoří podprojekty a ještě nižší plán/milník/verze (z vícera zaužívaných termínů se v další textu přidržíme pojmu verze z důvodu orientace Redmine na softwarové projekty a aktuální překlad). Poslední stupeň je již zmíněný úkol s podúkoly (i víceúrovňovými).
Podpůrnými prostředky jsou pak ostatní nástroje jako wikipedie, dokumenty, repozitáře či diskuzní forum - viz. seznam modulů<+odkaz>
Než budete moci svou představu o Redmine konfrontovat s praxí, musíte si nejprve otevřít projekt, v němž nám byla přidělena práva přidávat úkoly. Nejsnáze tak učiníte v pravé části #záhlaví pomocí seznamu „Vyberte projekt“. Vlastní

založení úkolu[editovat]

lze realizovat hned několika způsoby:

  • v záhlaví pomocí odkazu „Nový úkol“
  • z nového úkolu tlačítkem „Vytvořit a pokračovat“
  • z existujícího úkolu kliknutím na odkaz:
    • Duplikát (kontextový pruh) – otevře formulář nového úkolu s předvyplněnými hodnotami
    • Kopírovat (kontextový pruh) – otevře formulář kopírovaní <+obr>. Tlačítko „Kopírovat“ vytvoří nový úkol a zobrazí přehled úkolů, „Kopírovat a následovat“ úkol založí a následně jej zobrazí.
    • Přidat (sekce Podúkol)
    • Přidat (sekce Související úkoly)

Význam položek, které lze u nového úkolu vyplnit, je většinou zřejmý z jejich názvu a ilustruje je obrázek.. <+obrázek>. Detailněji se podívejme na:

  • Fronta - určuje typ workflow tj. do jakého stavu je aktuální uživatel na základě přiřazené role oprávněn úkol přepnout. Lepší představě napomůže obrázek <+obr>
  • Popis – umožňuje nejen zapsat text, ale také jej graficky upravit případně doplnit #odkazy a obrázky. Více informací naleznete v kapitole #grafické a jiné značky. Pro kontrolu výsledku použijte tlačítko „Náhled“.
  • Přiřazeno – osoba, která úkol řeší nebo za něj odpovídá. Vybírat lze pouze z účastníků projektu

Pro dosažení co největší flexibility umožňuje Redmine ovlivnit konkrétní podobu a chování některých položek, proto si uvedeme jen jejich výčet a to dle rozsahu platnosti na úrovni:

  • serveru
    • Fronta - definuje se globálně pro server, ale dostupnost lze nastavit na úrovni projektu
    • Stav - dostupné položky jsou závislé na zvolené frontě
    • Priorita
    • uživatelská pole (na obrázku pojmenováno myField)
    • Soubory – nastavuje se limit pro velikost uploadu (aktuální hodnota je uvedena pod položkou)
  • projektu
    • Fronta
    • Kategorie
    • Verze
    • Přiřazeno a Sledování - výběrem účastníků projektu

Proces zpracování úkolu tedy

workflow[editovat]

pojímá Redmine velmi volně a většinou ponechává na uživateli, které položky vyplní, kdo bude v určité fázi úkolem pověřen a jak budou stanoveny termíny. Je tedy na jednotlivých týmech (projektech), aby si tato pravidla stanovily (např. na projektové wiki). Zejména se jedná o význam stavů a které z nich jsou konečné, zda (ne)ponechávat prázdné pole "Přiřazeno" či "Uzavřít do" a pod., řeší-li se spolupráce na jednom úkolu jeho předáváním nebo rozpadem na podůkoly atd. Takto<+odkaz> může vypadat v praxi.
Nezbytné tři elementární fáze jsou řešeny následovně:

fáze Redmine poznámka
vznik uložení vyplněného formuláře tlačítkem Vytvořit

předvolení výchozího stavu

řešitel může být určen v této či následující fázi

úkolování sebe sama není nesmyslné :-)

průběh modifikace položek, přidávání komentářů, změna řešitele nebo zainteresovaných osob (Sledování), vznik souvisejících úkolů a podůkolů podle potřeb projektu lze více rozčlenit (typicky položkou Stav). Kupříkladu na akceptaci řešitelem, řešení, čekání na reakci druhé strany..
ukončení nastavením stavu, který má příznak „Úkol ukončen“ více než jeden konečný stav umožňuje rozlišit, zda bylo záměru dosaženo či nikoliv

Po úspěšném uložení<+odkaz> je úkol zobrazen v režimu čtení. Vyvstane-li nyní či později potřeba údaje upravit, slouží k tomu první položka z kontextové lišty - Aktualizace.

aktualizace úkolu[editovat]

aktualizace úkolu

Jedná se o patrně nejčastější a nejdůležitější aktivitu v Redmine, která přechodem do editačního režimu umožňuje nejen změnit či doplnit údaje týkající se úkolu, ale zároveň slouží jako komunikační nástroj mezi zainteresovanými osobami, neboť o každé uložené změně jsou účastnici informování e-mailem. Postupně vznikající texty z pole "Poznámka" jsou zobrazovány způsobem obvyklým pro diskuzní fóra - jako samostatné položky s údajem o době vzniku a autorovi Editace má dvě úrovně:

  • první je dostupná po kliknutí na odkaz "Aktualizovat"
  • druhá je poněkud skrytá a zpřístupní se po kliknutí na odkaz "(Více)" (na sousedním obrázku<+obr> červeně zvýrazněno). V tomto režimu je možno změnit i jinak nedostupné položky "Fronta", "Předmět", "Rodičovský úkol" případně "Popis" úkolu. Ještě o stupínek razantnější je
přesunutí úkolu[editovat]

Aktivuje se volbou "Přesunout" a umožňuje převést úkol na jiný projekt pomocí stejnojmenného pole. Přestože zbývající položky mají jako výchozí nastavení "(beze změny)", je jistější je nastavit ručně, neboť nemusí být platné v novém kontextu (typicky "Stav") a operace pak skončí chybou. Totéž platí při přesouvání celé hierarchie tj. rodičovského úkolu a jeho potomků - všechny položky musí být validní i v novém kontextu. Tímto se dostáváme k

definování souvztažnosti úkolů[editovat]

Tato vlastnost, dostupná jen pro uložené úkoly, je užitečná v situacích, kdy splnění jednoho úkolu je podmíněno splněním jiného, když se původní úkol rozpadne na úkoly dílčí apod. V Redmine lze vztahy mezi úkoly rozčlenit na:

  • časové (na ukončení jedjnoho navazuje začátek dalšího)
    • předchází – mezi ukončením aktuálního úkolu a začátkem jiného je stanoven časový odstup x dnů. Změna termínů se projeví v souvisejícím úkolu.
    • následuje – reverzní k předchozímu
  • hierarchické (úkol se rozpadá na několik podúkolů)
  • věcné
    související úkoly
    • související s – vzájemná souvislost
    • duplicity – aktuální úkol duplikuje. Je-li aktuální uzavřen, pak se změna projeví pouze v aktuálním. Je-li uzavřen „primární“ úkol, uzavřou se oba
    • duplikováno od – reverzní k předchozímu
    • bloků – splnění aktuálního úkolu je nutnou podmínkou pro uzavření jiného
    • zablokován – reverzní k předchozímu
  • verze - umožňuje vytvořit kolekci úkolů, jejichž splnění je podmíněno uzavření etapy, vydání čísla časopipisu, verze programu apod. Více viz. <+odkaz>

Časové a věcné vztahy se definují odkazem "Přidat" v sekci "Související úkoly" a následně příslušnou volbou vztahu.
Hierarchické rovněž pomocí "Přidat", ale v sekci "Podúkol". Poněkud nepohodlné, díky nutnosti si zapamatovat číslo úkolu, je ručním vyplnění položky "Rodičovský úkol" při aktualizaci<+odkaz> existujícího. Tato položka je u nových úkolů viditelná, u úkolů existujících se zobrazí až po kliknutí na (Více)<+odkaz>

verze[editovat]

Verze je svým pojetím velmi blízká úkolu, který je rozčleněn na řadu podúkolů. Může jí však definovat<+odkaz> pouze Manažer projektu a jednotlivé úkoly se k verzi přiřazují pomocí pole "Cílová verze". Takto vytvořená logická kolekce úkolů má přiřazen společný termín dokončení. Přehled o průběžném stav plnění je k dispozici v záhlaví pod položkou "Plán". Význam verzí je podtržen i grafické zvýraznění v kalendáři (??ověřit) či uvedením v pravém sloupci (??ověřit název) <+obrázek?>.
Samo pojmenování "verze" svádí k vnímání zúženému na softwarový svět, ale k tomuto nástroji lze přistoupit podstatně obecněji a použít jej jako na milník, plán či etapu. Více naleznete v kapitole o člení projektů<+odkaz>.

uložení změn[editovat]

Před vlastním uložením je dobrým zvykem použít tlačítko "Náhled" a zkontrolovat si výsledek editace. Opravdu to není zbytečný krok. Mějte na paměti, že každé uložení znamená rozeslání e-mailu zainteresovaným osobám..
Pokud jste si opravdu jisti, zapsané nové či upravené údaje uložíte pomocí tlačítek:

  • Vytvořit – po uložení úkolu přejde na seznam všech
  • Vytvořit a pokračovat – uloží aktuální a zobrazí další prázdný formulář
  • Potvrdit - po uložení se zobrazí úkol v režimu čtení (při úpravě existujícího úkolu)

práce s úkoly pomocí e-mailu[editovat]

Vedle již popsaného ovládání pomocí webového prohlížeče existuje i alternativní způsob pomocí e-mailu tj. formou e-mailové konference. Své uplatnění nachází hlavně při komentování úkolu. Stačí pouze odpovědět (Replay) na příchozí oznámení. Redmine na základě předmětu zprávy (proto ji ponechte v podobě navržené poštovní klientem) a v ní obsaženém číslu úkolu zprávu patřičně přiřadí a dle vaší e-mailové adresy doplní autora komentáře. Odpovíte-li z jiné e-mailové adresy, než jakou máte uvedenu ve svém profilu<+odkaz> (např. po přesměrováním na jinou e-mailovou schránku), bude zpráva ignorována.
Pro svou větší pracnost (možno kompenzovat pomocí poštovní šablony) a nutnou znalost některých údajů, je méně využívána možnost zakládat úkoly pomocí e-mailu. Odesílaná zpráva by měla mít tuto podobu:

Komu (To): redmine@vášServer.cz
Kopie (Cc): kolega_1@jehoFirma1.cz, kolega_2@jehoFirma2.cz
Předmět: Založení uživatelského účtu
Text (Body): Popisný text úkolu. Do něj nezapomeňte vložit následující klíčová slova:
   Project: kódProjektu (poslední část URL, máte-li otevřen "Přehled" projektu)
   Tracker: fronta (např. Chyba)
   Priority: priorita (např. Vysoká)
   Status: stav (např. Nový)
  • všichni rozpoznaní adresáti (To a Cc) budou přidáni do položky "Sledování"
  • přílohy budou automaticky připojeny a to bez ohledu na velikost (nastavený limit<+odkaz> je ignorován)

orientace v úkolech[editovat]

Používáním velmi rychle narůstá počet evidovaných úkolů v nejrůznějším stavu rozpracovanosti. K tomu, abyste se v nich beznadějně neztratili, slouží seznamy. Mají většinou podobu tabulek, které vznikly jako výsledek vyhledávací dotazy – filtru, tj. obsahují záznamy, které vyhověly dotazu. Co se rozsahu vyhledání týče, máme k dispozici:

  • lokální dotazy - ty jsou omezeny na projekt, ve kterém se právě nacházíte (a v něm také definovány) a
  • globální dotazy, které se chovají v závislosti na na tom, zda:
    • máte otevřen nějaký projekt<+odkaz>. Pak se chovají jako lokální.
    • nebo nemáte. V tomto případě vyhledávají napříč projekty.

Mezi seznamy předdefinované vývojáři systému patří např. „Mé úkoly“, „Nahlášené úkoly“ či „Celková aktivita“, ale také Novinky nebo Dokumenty. Pakliže tyto nepostačují vašim potřebám, můžete si definovat vlastní uživatelské dotazy včetně podoby výsledné tabulky - jak popisuje následující kapitola.

definování a správa uživatelských dotazů[editovat]
  1. otevřete si nějaký seznam (pravděpodobně s Úkoly)
  2. není-li sekce "Filtry" zobrazena, rozbalíte ji kliknutím na její název (uvozen trojúhelníčkem) a poté vyberte vhodnou položku ze seznam s popisem "Přidat filtr"
  3. klikněte na přidaný filtr a upravte vyhledávací kritéria (každým přidaným filtrem se výběr více zpřesňuje/zužuje)
  4. po rozbalení sekce "Nastavení" můžete změnit výchozí vzhled tabulky<+odkaz>
  5. pro kontrolu výsledku a zároveň provedení dotazu klikněte na tlačítko „Použít“
  6. chcete-li, aby tento ad hoc vytvořený dotaz nebyl opuštěním stránky zapomenut, použijte tlačítko „Uložit“ (viditelné až po provedení úprav)
  7. vyplňte či upravte zobrazeným formulářem <+obr> nabídnuté položky
    • Název – nejlépe krátký a výstižný s nějakým příznakem pro globální
    • Veřejný – určuje, zda je dotaz dostupný pouze vám, nebo všem. Položka je dostupná pouze správcům projektu či serveru
    • Pro všechny projekty – po zaškrtnutí je dostupný ve všech projektech a mimo projekt funguje jako globální dotaz
    • (zbývající položky jsou zřejmé i bez komentáře)
  8. použijte tlačítko Uložit nebo bez uložení opusťte stránku
  9. pakliže jste zvolili Uložit budou vám zobrazeny výsledky vašeho dotazu

Povšimněte si, že v pravém sloupci přibyl v sekci "Uživatelské dotazy" odkaz s názvem vašeho dotazu a vpravo nad tabulkou tlačítka "Upravit" a "Odstranit". Prvé z nich otevře formulář z bodu 7, druhé smaže definici dotazu.

uživatelská nastavení[editovat]

můj účet[editovat]

je místem, kde naleznete uživatelská nastavení jako jméno a příjmení, e-mail a zda má být veřejně dostupný, časové pásmo nebo pořadí, v jakém jsou zobrazovány komentáře. K místním položkám ještě patří:

změna hesla[editovat]

kterou aktivujete vpravo nahoře kliknutím na odkaz "Změnit heslo". Následně zobrazený formulář bude požadovat zadání stávajícího a dvojí vyplnění nového hesla. Změnu potvrdíte tlačítkem "Použít"

nastavení e-mailového oznámení[editovat]

ovlivní, na jaké události budete upozorňováni. Osvědčuje se zatrhnout "Nezasílat informace o mnou vytvořených změnách", která míní vás samé, nikoliv spolupracovníky. Význam tří variant nastavení je zřejmý, případně okomentovaný, proto si uvedeme jenom jejich výčet:

  • Pro všechny události všech mých projektů
  • Pro všechny události vybraných projektů...
  • Pouze pro události které sleduji nebo které se mne týkají (má oblíbená)
obrázek/ikona/fotka[editovat]

Možná jste si u zápisů ostatních všimli obrázku/ikony/fotky a rádi byste ten svůj také nahradili něčím příhodnějším, než máte teď. Toto nastavení však budete v Redmine hledat marně, neboť využívá službu Gravatar a tudíž na základě vašeho e-mailu použije obrázek/fotku, který jste si ve službě nastavili.

moje stránka[editovat]

Zobrazuje uživatelsky volitelné globální<+odkaz> bloky informací, jako jsou výchozí "Mé úkoly" a "Nahlášené úkoly", nebo Kalendář, Strávený čas atd. Dostupná je pod stejnojmenným odkazem v horní nástrojové liště<+odkaz>. Úpravu obsahu provedete:

  1. kliknutím na odkaz "Přizpůsobit tuto stránku"
  2. vyberte si ze seznamu "Bloky na mé stránce“ a potvrďte pomocí „Přidat“
  3. polohu bloku upravte pomocí myši (pro odstranění slouží křížek)
  4. jakékoliv opuštění stránky – třeba odkazem „Zpět“ vede k uložení změn

Časté navštěvování této stránky indikuje její vhodné nastavení. <dohledat plugin>

Formátovací a jiné Redmine značky[editovat]

Podobně jako Wikipedie nepoužívá Redmine WYSIWYG přístup, ale některé znaky či skupiny znaků zapsané přímo do běžného textu interpretuje jako značky např. pro tučné písmo či odkaz. Použitá syntaxe je však od wikiznaček často odlišná. Podobně v Redmine nemůžete použít HTML značky, místo nich však máte k dispozici Textile. Neboť je provázanost a snadná dostupnost informací klíčovou vlastností, věnujme se nejprve odkazům.

odkazy[editovat]

Obecně je lze rozdělit na interní (v rámci Redmine) a externí (mimo Redmine). Namísto interních odkazů lze také použít standardní URL odkazy (a jednoduchost použití k tomu svádí), ale je vhodné dát přednost pracnější Redmine syntaxi, neboť ta zajistí jejich platnost i při změnách jako jsou přesuny úkolů mezi projekty <+odkaz>, úpravě hierarchie Wiki stránek <+odkaz> či změně umístění serveru. Koncová část URL odkazované informace (dostupná např. v adresním řádku webového prohlížeče), je často dobrým vodítkem pro správný zápis. Strukturu dle jednotlivých modulů lze odvodit z následující tabulky.

kategorie syntaxe poznámka
interní odkazy
dokumenty document#17 kód je nahrazen názvem dokumentu s id 17
document:Počítač odkaz na dokument s názvem "Počítač"
document:"Zvuková karta" víceslovné názvy je třeba dát do uvozovek
document:názevProjektu:"Zápisy z porady" meziprojektově
fórum message#12 kód je nahrazen názvem příspěvku s id 12
novinky dosud nezavedeno použijte syntaxi pro externí odkazy
plán version#3 kód je nahrazen názvem plánu s id 3
version:Plán odkaz na plán pojmenovaný "Plán"
version:"Územní plán" víceslovné názvy je třeba dát do uvozovek
version:názevProjektu:"Územní plán" meziprojektově
projekty project#3 kód je nahrazen názvem projektu s id 3
project:Linux odkaz na projekt s identifikátorem <+odkaz> "Linux"
project:"Svobodný software" víceslovné názvy projektů je třeba dát do uvozovek
přílohy attachment:názevSouboru v současnosti lze odkazovat pouze na přílohy k aktuální stránce
repozitáře source:cesta/soubor odkaz na cesta/soubor
source:cesta/soubor@52 odkaz na 52 revizi
source:cesta/soubor#L120 odkaz na 120 řádek
source:cesta/soubor@52#L120 odkaz na 120 řádek v 52 revizi
source:"cesta/nový soubor@52#L120" odkazy obsahující mezery je třeba dát do uvozovek
export:cesta/soubor odkaz, který iniciuje download
úkoly #124 uzavřené <+odkaz> úkoly budou přeškrtnuty
wiki [[Tutoriál]] odkaz na Wiki stránku pojmenovanou "Tutoriál". Odkaz na dosud neexistující stránku bude červeně zvýrazněn
[[Tutoriál|Návod]] odlišný název stránky a text odkazu
[[Tutoriál#Související články|Návod - související]] odkaz směřuji na dílčí část stránky „Tutoriál“
[[názevProjektu:Tutoriál#Související články|Návod - související]] meziprojektově
společné !interní odkaz potlačí odkaz při zachování textu (vhodné pro dočasné zakázání)
externí odkazy
URL http://www.osel.cz text URL je rozpoznán a automaticky převeden na odkaz stejného znění
"OSEL":http://www.osel.cz náhrada URL vlastním textem (uvozovky jsou nutné i pro text bez mezer)
"Redmine info":mailto:info@redmine.org odkaz vytvoří e-mail s adresátem info@redmine.org
"Redmine info":mailto:info@redmine.org?cc=kopie@redmine.org&subject=Dotaz%20z%20webu&body=Hledám%20odpověď%20na vytváří takto předvyplněnou zprávu:

adresát: info@redmine.org
kopie: kopie@redmine.org
předmět zprávy: "Dotaz z webu"
obsah zprávy: "Hledám odpověď na"

grafické a jiné značky[editovat]

Smyslem těchto značky je zvýšit čitelnost a přehlednost textů. Při jejich používání je vhodné respektovat typografická doporučení. Vybrané značky můžete vložit na pozici kurzoru či aplikovat na myší označený text tlačítky z nástrojovém pruhu. Přehled běžných značek i s příslušnou ikonou obsahuje tabulka.

kategorie syntaxe poznámka
znak Redmine bt strong.png *tučné*
Redmine bt em.png _kurzíva_
*_tučná kurzíva_* ukázka kombinace vlastností
Redmine bt ins.png +podtržení+
Redmine bt del.png -přeškrtnuté-
Redmine bt code.png @nějaký kód@ pro kódu vložený do běžného textu (inline code) použije neproporcionální písmo
^horní index^
~dolní index~
odstavec Redmine bt h1.png h1. Nadpis 1 nadpisy je třeba od ostatního textu oddělit prázdným řádkem
Redmine bt h2.png h2. Nadpis 2
Redmine bt h3.png h3. Nadpis 3
Redmine bt ul.png * seznam počet * určuje úroveň zanoření
Redmine bt ol.png # uspořádaný seznam počet # určuje úroveň zanoření
Redmine bt bq.png > citace počet > určuje velikost odsazení. Redmine navíc zobrazuje vodící světle šedé svislé čáry
Redmine bt bq remove.png snižuje velikost odsazení označených řádků či aktuálního řádku
Redmine bt pre.png <pre>text bude naformátován přesně,

jak byl napsán;
písmem s pevnou šířkou;</pre>

vhodné např. pro víceřádkové kódy
p>.zarovnání doprava nepřehlédněte tečku!
p=.zarovnání na střed
další Redmine bt link.png [[Tutoriál]] podrobněji v internich odkazech pro wiki
Redmine bt img.png !URL obrázku! má-li stránka obrazovou přílohu zobrazíte ji zápisem !názevSouboru!
!>URL obrázku! obrázek zarovnaný doprava

|_.UserID|_.Jméno|_.Skupina|
|\3=.IT|
|1|Ivan Potapovič|/2.Users|
|2|Jan Novák|
|3|John Smith|Admin|

tabulka

_. - záhlaví (tučně a centrovaně)
\3 - sloučení 3 buněk v řádku
/2 - sloučení 2 buněk ve sloupci
=. - zarovnání na střed

{{toc}} vygeneruje obsah na základě použitých nadpisů. Při zápisu {{>toc}} bude vpravo