mirror of
https://codeberg.org/Kankys/doxa.git
synced 2026-11-11 14:44:36 +01:00
396 lines
19 KiB
HTML
396 lines
19 KiB
HTML
<!DOCTYPE html>
|
||
<html lang="en" data-bs-theme="light">
|
||
<head>
|
||
<meta charset="utf-8">
|
||
<meta http-equiv="X-UA-Compatible" content="IE=edge">
|
||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||
|
||
|
||
|
||
<link rel="shortcut icon" href="../img/favicon.ico">
|
||
<title>DOXA editor - DOXA Notes 🦅</title>
|
||
<link href="../css/bootstrap.min.css" rel="stylesheet">
|
||
<link href="../css/fontawesome.min.css" rel="stylesheet">
|
||
<link href="../css/brands.min.css" rel="stylesheet">
|
||
<link href="../css/solid.min.css" rel="stylesheet">
|
||
<link href="../css/v4-font-face.min.css" rel="stylesheet">
|
||
<link href="../css/base.css" rel="stylesheet">
|
||
<link id="hljs-light" rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.8.0/styles/github.min.css" >
|
||
<link id="hljs-dark" rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.8.0/styles/github-dark.min.css" disabled>
|
||
<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.8.0/highlight.min.js"></script>
|
||
<script>hljs.highlightAll();</script>
|
||
</head>
|
||
|
||
<body>
|
||
<div class="navbar fixed-top navbar-expand-lg navbar-dark bg-primary">
|
||
<div class="container">
|
||
<a class="navbar-brand" href="..">DOXA Notes 🦅</a>
|
||
<!-- Expander button -->
|
||
<button type="button" class="navbar-toggler" data-bs-toggle="collapse" data-bs-target="#navbar-collapse" aria-controls="navbar-collapse" aria-expanded="false" aria-label="Toggle navigation">
|
||
<span class="navbar-toggler-icon"></span>
|
||
</button>
|
||
|
||
<!-- Expanded navigation -->
|
||
<div id="navbar-collapse" class="navbar-collapse collapse">
|
||
<!-- Main navigation -->
|
||
<ul class="nav navbar-nav">
|
||
<li class="nav-item">
|
||
<a href=".." class="nav-link">Home</a>
|
||
</li>
|
||
<li class="nav-item dropdown">
|
||
<a href="#" class="nav-link dropdown-toggle active" aria-current="page" role="button" data-bs-toggle="dropdown" aria-expanded="false">Wiki - Česky</a>
|
||
<ul class="dropdown-menu">
|
||
|
||
<li>
|
||
<a href="../install/" class="dropdown-item">Instalace</a>
|
||
</li>
|
||
|
||
<li>
|
||
<a href="./" class="dropdown-item active" aria-current="page">DOXA editor</a>
|
||
</li>
|
||
</ul>
|
||
</li>
|
||
<li class="nav-item dropdown">
|
||
<a href="#" class="nav-link dropdown-toggle" role="button" data-bs-toggle="dropdown" aria-expanded="false">Wiki - English</a>
|
||
<ul class="dropdown-menu">
|
||
|
||
<li>
|
||
<a href="../install_en/" class="dropdown-item">Install</a>
|
||
</li>
|
||
|
||
<li>
|
||
<a href="../editor_en/" class="dropdown-item">DOXA editor</a>
|
||
</li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
|
||
<ul class="nav navbar-nav ms-md-auto">
|
||
<li class="nav-item">
|
||
<a href="#" class="nav-link" data-bs-toggle="modal" data-bs-target="#mkdocs_search_modal">
|
||
<i class="fa fa-search"></i> Search
|
||
</a>
|
||
</li>
|
||
<li class="nav-item">
|
||
<a rel="prev" href="../install/" class="nav-link">
|
||
<i class="fa fa-arrow-left"></i> Previous
|
||
</a>
|
||
</li>
|
||
<li class="nav-item">
|
||
<a rel="next" href="../install_en/" class="nav-link">
|
||
Next <i class="fa fa-arrow-right"></i>
|
||
</a>
|
||
</li>
|
||
</ul>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
|
||
<div class="container">
|
||
<div class="row">
|
||
<div class="col-md-3"><div class="navbar-expand-md bs-sidebar hidden-print affix" role="complementary">
|
||
<div class="navbar-header">
|
||
<button type="button" class="navbar-toggler collapsed" data-bs-toggle="collapse" data-bs-target="#toc-collapse" title="Table of Contents">
|
||
<span class="fa fa-angle-down"></span>
|
||
</button>
|
||
</div>
|
||
|
||
|
||
<div id="toc-collapse" class="navbar-collapse collapse card bg-body-tertiary">
|
||
<ul class="nav flex-column">
|
||
|
||
<li class="nav-item" data-bs-level="2"><a href="#vytvoreni-nove-poznamky" class="nav-link">Vytvoření nové poznámky</a>
|
||
<ul class="nav flex-column">
|
||
</ul>
|
||
</li>
|
||
|
||
<li class="nav-item" data-bs-level="2"><a href="#slash-command-rychla-napoveda-prikazu" class="nav-link">Slash Command - Rychlá nápověda příkazú</a>
|
||
<ul class="nav flex-column">
|
||
</ul>
|
||
</li>
|
||
|
||
<li class="nav-item" data-bs-level="2"><a href="#tagy" class="nav-link">Tagy</a>
|
||
<ul class="nav flex-column">
|
||
</ul>
|
||
</li>
|
||
|
||
<li class="nav-item" data-bs-level="2"><a href="#editace-a-mazani" class="nav-link">Editace a mazání</a>
|
||
<ul class="nav flex-column">
|
||
</ul>
|
||
</li>
|
||
|
||
<li class="nav-item" data-bs-level="2"><a href="#presouvani-poradi-poznamek" class="nav-link">Přesouvání pořadí poznámek</a>
|
||
<ul class="nav flex-column">
|
||
</ul>
|
||
</li>
|
||
|
||
<li class="nav-item" data-bs-level="2"><a href="#prepinani-vzhledu" class="nav-link">Přepínání vzhledu</a>
|
||
<ul class="nav flex-column">
|
||
</ul>
|
||
</li>
|
||
|
||
<li class="nav-item" data-bs-level="2"><a href="#automaticke-ukladani" class="nav-link">Automatické ukládání</a>
|
||
<ul class="nav flex-column">
|
||
</ul>
|
||
</li>
|
||
|
||
<li class="nav-item" data-bs-level="2"><a href="#manualni-ulozeni" class="nav-link">Manuální uložení</a>
|
||
<ul class="nav flex-column">
|
||
</ul>
|
||
</li>
|
||
|
||
<li class="nav-item" data-bs-level="2"><a href="#import-export" class="nav-link">Import / Export</a>
|
||
<ul class="nav flex-column">
|
||
</ul>
|
||
</li>
|
||
|
||
<li class="nav-item" data-bs-level="2"><a href="#export-do-markdown" class="nav-link">Export do Markdown</a>
|
||
<ul class="nav flex-column">
|
||
</ul>
|
||
</li>
|
||
|
||
<li class="nav-item" data-bs-level="2"><a href="#vyhledavani-filtrace" class="nav-link">Vyhledávání (Filtrace)</a>
|
||
<ul class="nav flex-column">
|
||
</ul>
|
||
</li>
|
||
|
||
<li class="nav-item" data-bs-level="2"><a href="#slozky" class="nav-link">Složky</a>
|
||
<ul class="nav flex-column">
|
||
</ul>
|
||
</li>
|
||
|
||
<li class="nav-item" data-bs-level="2"><a href="#bezpecnost-a-zalohy" class="nav-link">Bezpečnost a zálohy</a>
|
||
<ul class="nav flex-column">
|
||
</ul>
|
||
</li>
|
||
|
||
<li class="nav-item" data-bs-level="2"><a href="#caste-problemy" class="nav-link">Časté problémy</a>
|
||
<ul class="nav flex-column">
|
||
</ul>
|
||
</li>
|
||
|
||
<li class="nav-item" data-bs-level="2"><a href="#markdown" class="nav-link">Markdown</a>
|
||
<ul class="nav flex-column">
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
</div>
|
||
</div></div>
|
||
<div class="col-md-9" role="main">
|
||
|
||
<h2 id="vytvoreni-nove-poznamky">Vytvoření nové poznámky</h2>
|
||
<ul>
|
||
<li>Klikni na tlačítko ➕ Nová poznámka a zadej název.</li>
|
||
<li>Položka se objeví v seznamu. Klikem načteš název a obsah do editoru nahoře.</li>
|
||
<li>Uprav obsah a klikni Uložit nyní.</li>
|
||
</ul>
|
||
<h2 id="slash-command-rychla-napoveda-prikazu">Slash Command - Rychlá nápověda příkazú</h2>
|
||
<pre><code>1. Napíšete / v editoru → objeví se menu s příkazy
|
||
2. Filtrování Menu se filtruje podle dalšího textu (např. `/da` zobrazí `/date`)
|
||
3. Navigace:
|
||
↓↑ = Pohyb nahoru/dolů v menu
|
||
Enter/Tab = Výběr aktuálního příkazu
|
||
Escape = Zavření menu
|
||
4. Kliknutí na příkaz Vložení na místo kurzoru
|
||
5. Automatické zavření když kliknete mimo
|
||
</code></pre>
|
||
<p>Dostupné slash commands:</p>
|
||
<pre><code> /date - Vložit dnešní datum (📅)
|
||
/time - Vložit čas (🕐)
|
||
/code - Inline kód (💻)
|
||
/codeblock - Blok kódu (📝)
|
||
/link - Vložit odkaz (🔗)
|
||
/image - Vložit obrázek (🖼)
|
||
/table - Vložit tabulku (▦)
|
||
/quote - Citace (❝)
|
||
/hr - Vodorovná čára (—)
|
||
/task - Úkol/checkbox (☐)
|
||
/list - Odrážkový seznam (•)
|
||
/h1 - H1 Nadpis
|
||
/h2 - H2 Nadpis
|
||
/h3 - H3 Nadpis
|
||
</code></pre>
|
||
<h2 id="tagy">Tagy</h2>
|
||
<p>Tagy jsou slova nebo fráze, která popisuje obsah poznámky. V aplikaci Doxa díky nim můžete filtrovat poznámky podle tagu.</p>
|
||
<p>Klikni do pole tagy a zadej název tagu (uloží se stejně s poznámkou).</p>
|
||
<p>Poznámku pomocí tagu pak vyhledáš v poli s lupou <strong>Filtrovat poznámky podle tagu...</strong></p>
|
||
<h2 id="editace-a-mazani">Editace a mazání</h2>
|
||
<p>Inline: klikni na poznámku, uprav obsah a stiskni Uložit nyní.</p>
|
||
<p>Modal: klikni na ikonu ✎ vedle položky pro pokročilou editaci v modal okně.</p>
|
||
<p>Mazání: ikona 🗑 u položky — po potvrzení se poznámka smaže.</p>
|
||
<h2 id="presouvani-poradi-poznamek">Přesouvání pořadí poznámek</h2>
|
||
<p>Použij šipky <strong>↑ / ↓</strong> u položek.</p>
|
||
<p>Nebo přetahuj položky (drag & drop) na požadované místo — při přetažení se ukáže indikátor vložení.</p>
|
||
<h2 id="prepinani-vzhledu">Přepínání vzhledu</h2>
|
||
<p>V horním menu najdeš tlačítko pro přepínání vzhledu. Aplikace podporuje tři režimy:</p>
|
||
<ul>
|
||
<li>Světlý — ikona: ☀️</li>
|
||
<li>Tmavý — ikona: 🌙</li>
|
||
<li>Respektovat systém — ikona: 🌓 — aplikace bude sledovat systémovou volbu (prefers-color-scheme) a automaticky se přepne, pokud se změní systémový motiv.</li>
|
||
</ul>
|
||
<p>Kliknutím na tlačítko v menu cyklíš mezi režimy <strong>(Light → Dark → System)</strong>. Vybraná volba se uloží do localStorage pod klíčem doxa_theme a přetrvá mezi stránkami a obnovami. Pokud chceš volbu resetovat, otevři konzoli prohlížeče a spusť: localStorage.removeItem('doxa_theme') nebo vymaž storage v nástrojích pro vývojáře.</p>
|
||
<h2 id="automaticke-ukladani">Automatické ukládání</h2>
|
||
<p>Aplikace nyní automaticky ukládá změny poznámek lokálně během psaní (autosave). V běžném prohlížeči se změny ukládají do localStorage (klíč doxa_notes_v1) bez nutnosti manuálního ukládání — data se uloží po krátké prodlevě. Pokud aplikaci spouštíš v Electron/Node režimu, změny se zapisují přímo do lokálního souboru.</p>
|
||
<p><strong>Průběžně si úkládej i JSON soubor manuálně!!</strong></p>
|
||
<h2 id="manualni-ulozeni">Manuální uložení</h2>
|
||
<p>Vedle editoru najdeš tlačítko Uložit nyní. I když autosave ukládá průběžně, tlačítko je užitečné v těchto případech:</p>
|
||
<ul>
|
||
<li><strong>Okamžité uložení</strong> — provede persist bez čekání na autosave (užitečné před zavřením aplikace nebo pokud chcete rychlou jistotu, že jsou změny zapsány).</li>
|
||
<li><strong>Vizuální potvrzení</strong> — po uložení se zobrazí stav „Uloženo“, což dává uživateli okamžitou zpětnou vazbu.</li>
|
||
<li><strong>Bez stažení</strong> — tlačítko Uložit poznámku neprovádí stažení souboru; pokud chcete stáhnout JSON, použijte tlačítko Exportovat JSON.</li>
|
||
</ul>
|
||
<p>Pro přenos dat mezi zařízeními použijte tlačítko Exportovat JSON (stáhne soubor doxa.json), nebo z konzole spusťte saveNotesToFile(true).</p>
|
||
<h2 id="import-export">Import / Export</h2>
|
||
<p>Pro import klikni Importovat JSON a vyber soubor. Podporované formáty:</p>
|
||
<ul>
|
||
<li>Objekt s polem notes: { "notes": [ ... ] }</li>
|
||
<li>Přímo pole: [ { ... }, { ... } ]</li>
|
||
</ul>
|
||
<p>Export je nyní dostupný přes tlačítko Exportovat JSON (vedle tlačítka Uložit). Aplikace zároveň provádí autosave lokálně — nic neztratíte, pokud zapomenete manuálně uložit. Chcete-li stáhnout JSON přes skript, můžete také spustit v konzoli saveNotesToFile(true).</p>
|
||
<ul>
|
||
<li>Od verze 26.07.04 Import/Export: pole folder se ukládá do JSONu, zpětně kompatibilní se staršími daty (prázdné pole).</li>
|
||
</ul>
|
||
<h2 id="export-do-markdown">Export do Markdown</h2>
|
||
<p>Jednotlivou poznámku si můžete exportovat do Markdown.</p>
|
||
<p>Export je v formátu názevPoznámky.md</p>
|
||
<h2 id="vyhledavani-filtrace">Vyhledávání (Filtrace)</h2>
|
||
<ul>
|
||
<li>Filtrace: rozbalovač „📁 Všechny složky“ omezuje seznam pouze na vybranou složku.</li>
|
||
<li>Vyhledávání: pole vyhledává v názvu, obsahu, tagách i názvu složky (fulltext).</li>
|
||
</ul>
|
||
<h2 id="slozky">Složky</h2>
|
||
<ul>
|
||
<li>Složky: u poznámky vyplňte pole "Složka" nebo do obsahu napište řádek ve tvaru folder: Název (pole má nativní návrhy — seznam existujících složek).</li>
|
||
<li>Přiřazení lze také upravit ručně v poli Složka; změny se ukládají automaticky.</li>
|
||
</ul>
|
||
<h2 id="bezpecnost-a-zalohy">Bezpečnost a zálohy</h2>
|
||
<p>Výchozí režim je local‑first: data zůstávají ve tvém prohlížeči (localStorage) nebo lokálním souboru, aplikace je sama neodesílá.</p>
|
||
<h2 id="caste-problemy">Časté problémy</h2>
|
||
<ul>
|
||
<li>Při otevírání přes file:// může fetch statického JSONu selhávat — použij lokální server nebo Electron.</li>
|
||
<li>Přenos dat mezi zařízeními? Stáhni JSON a importuj ho na druhém zařízení.</li>
|
||
</ul>
|
||
<hr />
|
||
<h2 id="markdown">Markdown</h2>
|
||
<h3 id="editor-pouziva-markdown">Editor používá Markdown</h3>
|
||
<p>Editor pracuje s Markdown syntaxí. Všechny úpravy se ukládají jako Markdown (čistý text) — náhled ukazuje vykreslené HTML. Níže základní příklady (vložte je přímo do editoru nebo použijte tlačítka v toolbaru):</p>
|
||
<pre><code class="language-md">Tučné: **tučný text**
|
||
Kurzíva: *kurzíva*
|
||
Přeškrtnutí: ~~přeškrtnuté~~
|
||
Inline kód: `kód`
|
||
Kódový blok:
|
||
</code></pre>
|
||
<p>console.log('hello')</p>
|
||
<pre><code>Nadpisy:
|
||
# Nadpis H1
|
||
## Nadpis H2
|
||
### Nadpis H3
|
||
Seznam (odrážky):
|
||
- položka 1
|
||
- položka 2
|
||
Číslovaný seznam:
|
||
1. první
|
||
2. druhý
|
||
Citace:
|
||
> Toto je citace
|
||
Tabulka:
|
||
| Sloupec 1 | Sloupec 2 |
|
||
| --- | --- |
|
||
| bunka 1 | bunka 2 |
|
||
| bunka 3 | bunka 4 |
|
||
Obrázek (referenční URL):
|
||
|
||
Odkaz:
|
||
[text](https://example.com)
|
||
Úkoly (task list):
|
||
- [ ] nedokončeno
|
||
- [x] hotovo
|
||
</code></pre>
|
||
<h4 id="dulezite-tipy">Důležité tipy:</h4>
|
||
<ul>
|
||
<li>Kliknutím na tlačítka v toolbaru vložíte potřebné Markdown tokeny automaticky.</li>
|
||
<li>Stiskněte Ctrl/Cmd+B pro tučné, Ctrl/Cmd+I pro kurzívu a Ctrl/Cmd+` pro inline kód.</li>
|
||
<li>Tlačítko Náhled přepne vykreslení Markdownu; používejte jej k ověření výsledku.</li>
|
||
<li>Tlačítko Tabulka (▦) vloží šablonu tabulky a během vložení vás vyzve na počet sloupců a řádků.</li>
|
||
<li>Obrázky vkládejte jako URL — aplikace obrázky nesynchronizuje ani nahrává.</li>
|
||
<li>Markdown je přenosný: poznámky zůstávají čitelné i bez aplikace (export/import).</li>
|
||
</ul></div>
|
||
</div>
|
||
</div>
|
||
|
||
<footer class="col-md-12">
|
||
<hr>
|
||
<p>Documentation built with <a href="https://www.mkdocs.org/">MkDocs</a>.</p>
|
||
</footer>
|
||
<script src="../js/bootstrap.bundle.min.js"></script>
|
||
<script>
|
||
var base_url = "..",
|
||
shortcuts = {"help": 191, "next": 78, "previous": 80, "search": 83};
|
||
</script>
|
||
<script src="../js/base.js"></script>
|
||
<script src="../search/main.js"></script>
|
||
|
||
<div class="modal" id="mkdocs_search_modal" tabindex="-1" role="dialog" aria-labelledby="searchModalLabel" aria-hidden="true">
|
||
<div class="modal-dialog modal-lg">
|
||
<div class="modal-content">
|
||
<div class="modal-header">
|
||
<h4 class="modal-title" id="searchModalLabel">Search</h4>
|
||
<button type="button" class="btn-close" data-bs-dismiss="modal" aria-label="Close"></button>
|
||
</div>
|
||
<div class="modal-body">
|
||
<p>From here you can search these documents. Enter your search terms below.</p>
|
||
<form>
|
||
<div class="form-group">
|
||
<input type="search" class="form-control" placeholder="Search..." id="mkdocs-search-query" title="Type search term here">
|
||
</div>
|
||
</form>
|
||
<div id="mkdocs-search-results" data-no-results-text="No results found"></div>
|
||
</div>
|
||
<div class="modal-footer">
|
||
</div>
|
||
</div>
|
||
</div>
|
||
</div><div class="modal" id="mkdocs_keyboard_modal" tabindex="-1" role="dialog" aria-labelledby="keyboardModalLabel" aria-hidden="true">
|
||
<div class="modal-dialog">
|
||
<div class="modal-content">
|
||
<div class="modal-header">
|
||
<h4 class="modal-title" id="keyboardModalLabel">Keyboard Shortcuts</h4>
|
||
<button type="button" class="btn-close" data-bs-dismiss="modal" aria-label="Close"></button>
|
||
</div>
|
||
<div class="modal-body">
|
||
<table class="table">
|
||
<thead>
|
||
<tr>
|
||
<th style="width: 20%;">Keys</th>
|
||
<th>Action</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr>
|
||
<td class="help shortcut"><kbd>?</kbd></td>
|
||
<td>Open this help</td>
|
||
</tr>
|
||
<tr>
|
||
<td class="next shortcut"><kbd>n</kbd></td>
|
||
<td>Next page</td>
|
||
</tr>
|
||
<tr>
|
||
<td class="prev shortcut"><kbd>p</kbd></td>
|
||
<td>Previous page</td>
|
||
</tr>
|
||
<tr>
|
||
<td class="search shortcut"><kbd>s</kbd></td>
|
||
<td>Search</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</div>
|
||
<div class="modal-footer">
|
||
</div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
|
||
</body>
|
||
</html>
|