Add in-app help page with user manual (Romanian)
Adds a /help page served from the dashboard navigation, containing the full
Romanian user manual for operators: dashboard, playlist management, adding
media, removing files from playlists, player management, and the advanced
edited-media view.
Implementation notes
- Manual is pre-rendered to HTML with pandoc and shipped as a static asset
(app/static/help/_manual_body.html) rather than parsed at runtime. This
keeps the container free of a Markdown dependency and makes the page render
identically regardless of what is installed.
- /help is login-protected; the sidebar table of contents is derived from the
level-2 headings at request time.
- Screenshots are served from app/static/help/screenshots/ (32 images).
- Regenerate after editing the manual:
documentatie/convert_help_page.sh
docker compose up -d --build
Also adds
- backup_players_playlists.sh / restore_database.sh for DB backup and restore.
- .gitignore rules so local database backups (real production data), generated
.docx files and duplicate screenshot copies are never committed.
This commit is contained in:
@@ -0,0 +1,225 @@
|
||||
# Cum convertesc acest manual în format .DOCX
|
||||
|
||||
Acest fișier explică pașii pentru a transforma `Manual-Utilizare-DigiServer.md` într-un document Word (`.docx`) gata de printat sau distribuit.
|
||||
|
||||
---
|
||||
|
||||
## Metoda 1 – Pandoc (recomandată)
|
||||
|
||||
Pandoc este cea mai bună soluție: convertește Markdown în DOCX păstrând titluri, tabele, liste și imagini.
|
||||
|
||||
### 1.1. Instalare Pandoc
|
||||
|
||||
Pe Debian/Ubuntu (inclusiv pe acest server):
|
||||
|
||||
```bash
|
||||
sudo apt-get update
|
||||
sudo apt-get install -y pandoc
|
||||
```
|
||||
|
||||
Verificare:
|
||||
|
||||
```bash
|
||||
pandoc --version
|
||||
```
|
||||
|
||||
### 1.2. Conversie simplă
|
||||
|
||||
Din folderul `documentatie/`:
|
||||
|
||||
```bash
|
||||
cd /srv/digiserver-v2/documentatie
|
||||
pandoc Manual-Utilizare-DigiServer.md -o Manual-Utilizare-DigiServer.docx
|
||||
```
|
||||
|
||||
### 1.3. Conversie cu cuprins automat (Table of Contents)
|
||||
|
||||
```bash
|
||||
pandoc Manual-Utilizare-DigiServer.md \
|
||||
--toc \
|
||||
--toc-depth=2 \
|
||||
--number-sections \
|
||||
-o Manual-Utilizare-DigiServer.docx
|
||||
```
|
||||
|
||||
| Opțiune | Efect |
|
||||
|---------|-------|
|
||||
| `--toc` | Adaugă cuprins automat |
|
||||
| `--toc-depth=2` | Cuprinsul include titluri de nivel 1 și 2 |
|
||||
| `--number-sections` | Numerotează secțiunile (1, 1.1, 1.2...) |
|
||||
|
||||
### 1.4. Conversie cu șablon personalizat (logo, fonturi corporate)
|
||||
|
||||
Dacă doriți un aspect personalizat:
|
||||
|
||||
1. Generați un șablon de referință:
|
||||
```bash
|
||||
pandoc -o template-referinta.docx --print-default-data-file reference.docx
|
||||
```
|
||||
2. Deschideți `template-referinta.docx` în Word
|
||||
3. Modificați stilurile (fonturi, culori, antet, logo)
|
||||
4. Salvați și folosiți-l la conversie:
|
||||
```bash
|
||||
pandoc Manual-Utilizare-DigiServer.md \
|
||||
--toc --number-sections \
|
||||
--reference-doc=template-referinta.docx \
|
||||
-o Manual-Utilizare-DigiServer.docx
|
||||
```
|
||||
|
||||
### 1.5. Conversie cu imagini redimensionate (pentru capturile de ecran)
|
||||
|
||||
```bash
|
||||
pandoc Manual-Utilizare-DigiServer.md \
|
||||
--toc --number-sections \
|
||||
--resource-path=screenshots \
|
||||
-o Manual-Utilizare-DigiServer.docx
|
||||
```
|
||||
|
||||
> **Notă:** Pentru ca imaginile să apară în document, ele trebuie să existe în folderul
|
||||
> `screenshots/` cu numele exacte din Anexa B și trebuie referite în Markdown.
|
||||
|
||||
---
|
||||
|
||||
## Metoda 2 – VS Code (fără instalări suplimentare)
|
||||
|
||||
Dacă editați în VS Code:
|
||||
|
||||
1. Instalați extensia **„Markdown PDF"** sau **„Markdown Preview Enhanced"**
|
||||
2. Deschideți `Manual-Utilizare-DigiServer.md`
|
||||
3. Click dreapta → **„Markdown: Export to DOCX"** (sau PDF)
|
||||
4. Salvați documentul rezultat
|
||||
|
||||
Alternativ, extensia **„Markdown All in One"** + **„Pandoc"** permite export direct DOCX din Command Palette.
|
||||
|
||||
---
|
||||
|
||||
## Metoda 3 – Online (fără instalare)
|
||||
|
||||
Pentru conversie rapidă fără a instala nimic:
|
||||
|
||||
1. Accesați un convertor online (ex: `https://www.markdowntodocx.com`)
|
||||
2. Încărcați sau lipiți conținutul din `Manual-Utilizare-DigiServer.md`
|
||||
3. Descărcați fișierul `.docx` rezultat
|
||||
|
||||
> **Atenție:** Nu folosiți convertizoare online pentru documente cu informații sensibile (adrese IP interne, credențiale). Preferați Metoda 1 sau 2.
|
||||
|
||||
---
|
||||
|
||||
## Pașii compleți pentru un document final (cu capturi de ecran)
|
||||
|
||||
### Pasul 1 – Faceți capturile de ecran
|
||||
|
||||
Deschideți aplicația în browser și faceți capturi pentru fiecare punct din **Anexa B** a manualului.
|
||||
|
||||
**Sfaturi pentru capturi bune:**
|
||||
- Folosiți rezoluția completă a ferestrei (nu tăiați meniurile)
|
||||
- Evitați să apară date sensibile (parole, IP-uri reale dacă nu e necesar)
|
||||
- Salvați în format PNG pentru claritate
|
||||
- Denumiți exact ca în Anexa B (ex: `01-login.png`)
|
||||
|
||||
### Pasul 2 – Salvați capturile
|
||||
|
||||
Puneți toate fișierele în:
|
||||
|
||||
```
|
||||
/srv/digiserver-v2/documentatie/screenshots/
|
||||
```
|
||||
|
||||
### Pasul 3 – Referiți imaginile în Markdown
|
||||
|
||||
Înlocuiți liniile de tip:
|
||||
|
||||
```markdown
|
||||
**[SCREENSHOT: 03-dashboard.png – Dashboard după autentificare]**
|
||||
```
|
||||
|
||||
cu:
|
||||
|
||||
```markdown
|
||||
|
||||
|
||||
*Figura 1 – Dashboard-ul principal al aplicației*
|
||||
```
|
||||
|
||||
### Pasul 4 – Convertiți în DOCX
|
||||
|
||||
```bash
|
||||
cd /srv/digiserver-v2/documentatie
|
||||
pandoc Manual-Utilizare-DigiServer.md \
|
||||
--toc \
|
||||
--toc-depth=2 \
|
||||
--number-sections \
|
||||
--resource-path=screenshots \
|
||||
-o Manual-Utilizare-DigiServer.docx
|
||||
```
|
||||
|
||||
### Pasul 5 – Verificați documentul
|
||||
|
||||
Deschideți `Manual-Utilizare-DigiServer.docx` în Word / LibreOffice și verificați:
|
||||
|
||||
- [ ] Cuprinsul este corect și complet
|
||||
- [ ] Toate capturile de ecran apar
|
||||
- [ ] Tabelele sunt formatate corect
|
||||
- [ ] Numerotarea secțiunilor este consecventă
|
||||
- [ ] Textul diacriticilor românești (ă, â, î, ș, ț) se afișează corect
|
||||
|
||||
---
|
||||
|
||||
## Script automat de conversie
|
||||
|
||||
Un script care face totul automat:
|
||||
|
||||
```bash
|
||||
#!/bin/bash
|
||||
# convert_manual.sh - Converteste manualul in DOCX cu cuprins si imagini
|
||||
|
||||
cd "$(dirname "$0")"
|
||||
|
||||
echo "Verificare Pandoc..."
|
||||
if ! command -v pandoc &> /dev/null; then
|
||||
echo "Pandoc nu este instalat. Rulati: sudo apt-get install -y pandoc"
|
||||
exit 1
|
||||
fi
|
||||
|
||||
echo "Numar capturi de ecran disponibile:"
|
||||
ls -1 screenshots/*.png 2>/dev/null | wc -l
|
||||
|
||||
echo "Conversie in DOCX..."
|
||||
pandoc Manual-Utilizare-DigiServer.md \
|
||||
--toc \
|
||||
--toc-depth=2 \
|
||||
--number-sections \
|
||||
--resource-path=screenshots \
|
||||
-o Manual-Utilizare-DigiServer.docx
|
||||
|
||||
if [ -f Manual-Utilizare-DigiServer.docx ]; then
|
||||
echo "✓ Document creat: Manual-Utilizare-DigiServer.docx"
|
||||
ls -lh Manual-Utilizare-DigiServer.docx
|
||||
else
|
||||
echo "✗ Eroare la conversie"
|
||||
exit 1
|
||||
fi
|
||||
```
|
||||
|
||||
Salvați ca `convert_manual.sh`, apoi:
|
||||
|
||||
```bash
|
||||
chmod +x convert_manual.sh
|
||||
./convert_manual.sh
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Rezumat rapid
|
||||
|
||||
| Metodă | Necesită | Calitate | Recomandat pentru |
|
||||
|--------|----------|----------|-------------------|
|
||||
| **Pandoc** | instalare | ★★★★★ | Document final profesional |
|
||||
| **VS Code** | extensie | ★★★★ | Utilizatori VS Code |
|
||||
| **Online** | browser | ★★★ | Conversie rapidă, documente nesensibile |
|
||||
|
||||
**Recomandare:** Folosiți **Pandoc cu `--toc` și `--number-sections`** și un șablon de referință personalizat pentru un document final profesionist.
|
||||
|
||||
---
|
||||
|
||||
*Pentru întrebări despre conversie, consultați documentația Pandoc: https://pandoc.org/MANUAL.html*
|
||||
Reference in New Issue
Block a user