======== NV3 Docs ======== Projekt obejmujujący dokumntację NV dostępną dla partnera i klienta. Projekt oparty na silniku tworzenia dokumentacji Sphinx z motywem `sphinx-immaterial` Przydatne linki =============== .. _RST_CHEATSHEET: https://bashtage.github.io/sphinx-material/rst-cheatsheet/rst-cheatsheet.html .. _MYST_CHEATSHEET: https://myst-parser.readthedocs.io/en/v0.13.3/using/syntax.html .. _IMMATERIAL_EXAMPLE: https://sphinx-immaterial.readthedocs.io/en/latest/ * RST_CHEATSHEET_ * MYST_CHEATSHEET_ * IMMATERIAL_EXAMPLE_ Kolejność nagłówków =================== Oznaczenia nagłówków muszą być przynajmniej tak długie jak ich tekst. 1. Overline ========== .. code-block:: rst ============ TYTUŁ STRONY ============ 2. Overline ---------- .. code-block:: rst ------------------------- Pierwszy poziom paragrafu ------------------------- 3. Underline ========= .. code-block:: rst Drugi poziom ============ 4. Underline --------- .. code-block:: rst Trzeci poziom ------------- 5. Underline ######### .. code-block:: rst Czwarty poziom ############## 6. Underline ********* .. code-block:: rst Piąty poziom ************ Dla `Markdown` nagłówki pozostają takie jak normalnie. --------------------------- Opis `Administator's Guide` --------------------------- Linki ===== Linki tworzone są według schematu: `/admin-guide/{resourceCategory}/{resourceRoute}.rst`. To jest główny link, który jest dostępny z poziomu pomocy dla widoku (ekranu) typu *List*. Ta strona zawiera odnośniki do podstron zawierających opisy wszystkich widoków. Dodatkowo, z poziomu widoku typu *Form*, dostępny jest bezpośredni link według schematu: `/admin-guide/{resourceCategory}/{resourceRoute}/{resourceRoute}/form.rst`. Zawartość ========= W pliku `index.rst` folderu admin-guide (czyli w głównym plik *Administrator's Guide*), są sekcje odpowiadające danej *resourceCategory*. Znajduję się tam krótkie opis danej kategorii (jakie elementy systemu, do czego służą, opis powiązań jeśli występują). W pliku `resourceRoute.rst` dla każdego folderu znajduje się krótki opis funkcjonalności dostępnej w danej zakładce - czym to jest, do czego to służy, jak można tego użyć. W plikach `{resourceRoute}-list.rst`, `{resourceRoute}-form.rst`, `{resourceRoute}-show.rst` znajdują się opisy poszczególnych widoków - pola, przyciski. Elementy statyczne (ikony i tym podobne) w katalogu *_static*, natomiast obrazki/grafiki znajdują się w katalogu *images*. Jeśli w danym pliku występuje tylko jeden obrazek, to jest on nazywany nazwą pliku. Jeśli jest ich więcej, to należy stworzyć katalog/i odopowiadające ścieżce do danego pliku od korzenia dokumentu. Następnie należy utworzyć folder o nazwie takiej samej jak nazwa pliku i tam umieśći wszystkie pliki.