Dokumenty jsou poznámky v Markdownu, které lze ukládat, propojit s libovolným počtem klientů a projektů, opatřit štítky a exportovat do PDF. Pokaždé, když změníte obsah, se předchozí verze automaticky archivuje, takže se k ní můžete vrátit nebo ji obnovit — viz Verzování dokumentů.
Co můžete dělat
Procházejte všechny své dokumenty na stránce Dokumenty s textovým vyhledáváním a filtry podle štítků a kdykoli vytvořte nový dokument. Otevřením dokumentu si zobrazíte jeho celý obsah a poté pomocí dostupných akcí dokument upravíte, zobrazíte historii verzí, exportujete do PDF nebo smažete.
Každý dokument získá ID ve tvaru D-7. Písmennou předponu lze změnit v Obecném nastavení.
Pole, která vyplníte
- Název — povinný, titul dokumentu.
- Obsah — povinný text v Markdownu.
- Popis — volitelné shrnutí, zobrazené nad obsahem na stránce s podrobnostmi.
- Klienti — volitelná propojení; dokument se poté objeví v souvisejících dokumentech každého propojeného klienta.
- Projekty — volitelná propojení; dokument se objeví v souvisejících dokumentech každého propojeného projektu.
- Štítky — volitelné, sdílené se zbytkem systému Štítky.
Psaní v editoru
Editor má dva režimy: WYSIWYG editor formátovaného textu (výchozí) a prosté pole pro Markdown. Mezi nimi přepínáte přepínačem v panelu nástrojů editoru — pište vizuálně, nebo se podle potřeby přepněte na zdrojový kód Markdownu. V obou případech se obsah ukládá jako Markdown. Žádné lomítkové příkazy, vložená média ani nahrávání obrázků nejsou k dispozici. Obsah je povinný; vše ostatní je volitelné.
Seznam
Seznam dokumentů zobrazuje ID, název (s popisem jako podtitulkem), klienty, projekty, štítky a datum poslední úpravy. Sloupce klientů a projektů uvádějí každou propojenou entitu jako klikací odkaz, přičemž při překročení dostupného místa se zobrazí přetečení „+N". Vyhledávat lze v názvu, popisu a obsahu a filtrovat podle štítků (dokument musí nést všechny zvolené štítky). Zvolte 50, 100 nebo 200 dokumentů na stránku.
Seznam nenabízí filtry podle klienta ani projektu přímo — chcete-li zobrazit dokumenty konkrétního klienta nebo projektu, otevřete daného klienta či projekt a použijte jeho seznam souvisejících dokumentů.
Stránka s podrobnostmi
Stránka s podrobnostmi dokumentu zobrazuje titul, popis, všechny propojené klienty a projekty jako klikací názvy, štítky, čas poslední úpravy a celý obsah. Sekce PDF exportů uvádí všechna vygenerovaná PDF. Odtud můžete dokument Upravit, zobrazit Historii, Smazat nebo Zavřít.
Pracovní postupy
Vytvoření dokumentu
- Otevřete formulář nového dokumentu.
- Zadejte název a napište obsah v Markdownu.
- Volitelně propojte jednoho či více klientů a projektů a přidejte štítky.
- Uložte. Dokument získá další ID.
Aktualizace dokumentu
Použijte Upravit, proveďte změny a uložte. Pokud se obsah skutečně změnil, předchozí verze se před nahrazením novým obsahem archivuje. Úprava pouze názvu, popisu, klientů, projektů nebo štítků novou verzi nevytváří.
Export do PDF
Na stránce s podrobnostmi použijte akci Exportovat PDF. Každý export zachytí dokument přesně tak, jak vypadal v daném okamžiku — název, obsah, štítky a propojené klienty/projekty — takže pozdější úpravy nikdy nemění minulý export. Sekce exportů uvádí každé PDF s jeho velikostí a datem; jednotlivě je můžete stáhnout nebo smazat. PDF obsahuje text dokumentu tak, jak vypadal při vygenerování; neobsahuje žádnou historii verzí.
Jak to souvisí se zbytkem Ceumu
- Klienti a projekty — dokument se propojuje s libovolným počtem klientů a projektů (vše volitelné). Objevuje se v souvisejících dokumentech každého propojeného klienta a projektu. Pokud některého z těchto klientů nebo projektů smažete, dokument zůstane — jen přijde o dané jedno propojení.
- Štítky — sdílené se systémem štítkování napříč celým Ceumem.
- Historie — úpravy dokumentů se sledují pomocí snímků verzí, nikoli prostřednictvím obecného Protokolu změn entity; viz Verzování dokumentů.
Tipy a okrajové případy
- Smazání je trvalé. Smazáním dokumentu se odstraní také jeho historie verzí a exportovaná PDF — koš neexistuje.
- Dokumenty se ukládají jako Markdown. Upravovat je můžete vizuálně v režimu formátovaného textu nebo v prostém Markdownu, ale nejsou k dispozici žádná vložená média ani samostatné nahrávání obrázků.
- Verzování probíhá jen při změnách obsahu. Přejmenování, změna štítků ani úprava propojení dokumentu snímek verze nevytváří.
- Žádný protokol změn na úrovni polí. U dokumentů slouží jako přehled historie časová osa verzí — neexistuje záznam o tom, kdo co změnil.
Na mobilu
- Dokumenty vytvářejte a upravujte v nativním formuláři ve spodním panelu; úpravy provedené offline se zařadí do fronty a odešlou po opětovném připojení — viz Offline podpora.
- Dokument si můžete přečíst a exportovat do PDF (sdíleného přes nativní panel sdílení), ale historie verzí a obnovení jsou dostupné pouze na webu.