Skip to content

Commit 4ca4ede

Browse files
VitSimonVitSimon
committed
EN,CZ : helpviewer, newLangViewer : took from authors guide
1 parent 35c64b7 commit 4ca4ede

4 files changed

Lines changed: 176 additions & 0 deletions

File tree

‎cs/helpviewer.md‎

Lines changed: 52 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,52 @@
1+
# 🔎 Projekt HelpViewer
2+
3+
## Organizace
4+
5+
Organizace [HelpViewer][HelpViewer] obsahuje 2 základní typy repozitářů:
6+
7+
- Základní repozitáře projektu - prohlížeč, překlady, další servisní repozitáře
8+
- Repozitáře nápověd (**help\***)
9+
10+
## Seznam základních repozitářů
11+
12+
| Repozitář | Obsah |
13+
|---|---|
14+
| [HelpViewer][RHelpViewer] | Základní repozitář projektu - prohlížeč nápovědy. |
15+
| [Translations][RTranslations] | Jazykové překlady UI prohlížeče nápovědy. Repozitář je vložený do **HelpViewer** jako submodul. Je částečně zdrojem seznamu jazyků, které se uživateli nabízejí pro přepnutí nápovědy. |
16+
| [.github][R.github] | Základní repozitář organizace s provozními informacemi. |
17+
| [helpviewer.github.io][RWebHello] | GitHub Pages projekt webové prezentace. [Nasazovací skript][RWebHelloDeploy] provede aktualizaci stránky s použitím nastavené verze nasazení. |
18+
| [fulltextSearchDBBuilder][FTSIndexBuilder] | Generátor fulltext indexu. Tento Bash skript je používán nasazovacími skripty nápověd při přípravě fulltext indexů. |
19+
| [helpTemplate][RhelpTemplate] | Šablona projektu souboru nápovědy. Je určená pro autory nápověd jako základní prázdný projekt. |
20+
| [prism][RPrism] | PrismJS sestavená pomocí download průvodce projektu. Repozitář je vložený do **HelpViewer** jako submodul. |
21+
22+
## Seznam repozitářů nápověd
23+
24+
Repozitáře bývají pojmenovány **help\***. Vzhledem k pojmenování projektu existují vyjímky, které byly popsány výše.
25+
26+
| Repozitář | Obsah |
27+
|---|---|
28+
| [helpHello][RhelpHello] | Představení projektu pro veřejnou webovou prezentaci. |
29+
| [helpUser][RhelpUser] | Nápověda pro uživatele prohlížeče. Popisuje základní práci s prohlížečem. |
30+
| [helpAuthorsGuide][RhelpAuthorsGuide] | (Tato) Nápověda pro autory nápověd. Popisuje vyškeré kroky, které jsou potřebné k vytvoření a vydání nápovědy. |
31+
32+
## Vydávání verzí
33+
34+
- Verze se vydávají nepravidelně
35+
- Číslem verze je vždy datum daného vydání ve formátu rokměsícden (například: 20250621)
36+
- Pokud se v daný den vydá více verzí, pak první má formát rokměsícden a každá další má příponu **-číslo** od 1 s krokem 1, tedy například: 20250606-1, 20250606-2
37+
- Data pro popis změn verzí se získávají z **CHANGELOG.md** v kořeni repozitáře. Popis pro nejnovější verzi se připojuje vždy na začátek souboru. Nejstarší verze bývají ve výpisu nejníže. Poslední sekci s "**File introduced**" neměňte a neodebírejte - slouží i pro Vaši informaci
38+
- Tento postup platí jak pro **HelpViewer**, tak i další nástroje a vydávané nápovědy
39+
- Postup je doporučován i pro autory nápověd, přestože mají možnost si tento bod rozhodnout po svém
40+
41+
[HelpViewer]: https://github.com/HelpViewer "HelpViewer"
42+
[RHelpViewer]: https://github.com/HelpViewer/HelpViewer "HelpViewer"
43+
[RTranslations]: https://github.com/HelpViewer/Translations "Překlady"
44+
[RWebHello]: https://github.com/HelpViewer/helpviewer.github.io "Webová prezentace projektu"
45+
[RWebHelloDeploy]: https://github.com/HelpViewer/helpviewer.github.io/actions/workflows/toPages.yml "Webová prezentace projektu - nasazení"
46+
[FTSIndexBuilder]: https://github.com/HelpViewer/fulltextSearchDBBuilder "Generátor fulltext indexu"
47+
[RhelpTemplate]: https://github.com/HelpViewer/helpTemplate "Šablona projektu souboru nápovědy"
48+
[RhelpHello]: https://github.com/HelpViewer/helpHello
49+
[RhelpUser]: https://github.com/HelpViewer/helpUser
50+
[RhelpAuthorsGuide]: https://github.com/HelpViewer/helpAuthorsGuide
51+
[R.github]: https://github.com/HelpViewer/.github "Repozitář se základními informacemi"
52+
[RPrism]: https://github.com/HelpViewer/prism

‎cs/newLangViewer.md‎

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
# 🌐 Nový jazyk prohlížeče
2+
3+
- Pro nový jazyk prohlížeče je potřeba v [repozitáři lokalizací][Localiz] na hlavní úrovni založit nový adresář se zkratkou jazyka.
4+
- Zvolte zkratku podle standardu **ISO 639-1**.
5+
- Váš jazykový překlad pro **HelpViewer** bude po schválení PR automaticky distribuován s nejbližším vydáním.
6+
7+
## Význam souborů v lokalizaci
8+
9+
- Všechny soubory vytvořte ve znakové sadě **UTF-8 no BOM (65001)**.
10+
11+
| Soubor | Popis |
12+
|---|---|
13+
| lname.txt | Název jazyka v daném jazyce. |
14+
| lstr.js | Klíče obsahující dynamické informace. |
15+
| lstr.txt | Klíče se statickými texty. |
16+
17+
## Struktura souborů
18+
19+
### lstr.js
20+
21+
```javascript
22+
var _lstr = {
23+
'klic' : () => `hodnota ${globalni-promenna}`,
24+
};
25+
```
26+
27+
### lstr.txt
28+
29+
```
30+
klic(id html prvku)|hodnota
31+
klic(id html prvku)__placeholder|popisek vstupního pole
32+
klic(id html prvku)__aria-label|popisek pro přístupnost
33+
klic(id html prvku)__*|hodnota atributu HTML elementu
34+
```
35+
36+
[Localiz]: https://github.com/HelpViewer/Translations "Lokalizace HelpViewer"

‎en/helpviewer.md‎

Lines changed: 52 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,52 @@
1+
# 🔎 HelpViewer Project
2+
3+
## Organization
4+
5+
Organization [HelpViewer][HelpViewer] contains 2 basic types of repositories:
6+
7+
- Basic project repositories - Viewer, translations, another service repositories
8+
- Help files repositories (**help\***)
9+
10+
## Basic repositories
11+
12+
| Repository | Content |
13+
|---|---|
14+
| [HelpViewer][RHelpViewer] | Base repository of project - help files viewer. |
15+
| [Translations][RTranslations] | Language translation strings for UI of HelpViewer. Repository is inserted to **HelpViewer** as a Git submodule. It is also one of the sources of language list which is offered to user for language selection of UI and help file version. |
16+
| [.github][R.github] | Base repository of organization with operational information. |
17+
| [helpviewer.github.io][RWebHello] | GitHub Pages project for web presentation. [CI deployment script][RWebHelloDeploy] will do page content update with defined version number to deploy. |
18+
| [fulltextSearchDBBuilder][FTSIndexBuilder] | Full text index generator logic. This Bash script is used by CI scripts which handles publishing of help files in case there is required to create full text index. |
19+
| [helpTemplate][RhelpTemplate] | Template for help file project. It is intended for help authors as a basic blank project. |
20+
| [prism][RPrism] | PrismJS library mixed-customized release. Repository is inserted to **HelpViewer** as a Git submodule. |
21+
22+
## Help files repositories
23+
24+
Repository names are starting with **help\***. Due to the naming of the project, there are exceptions as described above.
25+
26+
| Repository | Content |
27+
|---|---|
28+
| [helpHello][RhelpHello] | Project hello help file for public web presentation. |
29+
| [helpUser][RhelpUser] | Help file with starting instruction, UI description for HelpViewer users. It describes basic work with Viewer. |
30+
| [helpAuthorsGuide][RhelpAuthorsGuide] | (This) Help file (pages) for help file authors. Describes all necessary steps for creation and publishing of your own help file. |
31+
32+
## Version publishing
33+
34+
- Versions are released irregularly
35+
- The version number is always the date of the release in yearmonthday format (for example: 20250621)
36+
- If more than one version is released on a given day, then the first version has the format yearmonth and each subsequent version has the suffix **-number** starting from 1 with step 1, for example: 20250606-1, 20250606-2
37+
- The data for describing version changes is obtained from **CHANGELOG.md** in the root of the repository. The description for the latest version is always appended to the beginning of the file. The oldest versions tend to be lowest in the listing. Do not change or remove the last section with “**File introduced**” - it is also for your information
38+
- This procedure applies to **HelpViewer** as well as other tools and issued help
39+
- The same procedure is also recommended for authors of help files, although they are free to decide this point on their own
40+
41+
[HelpViewer]: https://github.com/HelpViewer "HelpViewer"
42+
[RHelpViewer]: https://github.com/HelpViewer/HelpViewer "HelpViewer"
43+
[RTranslations]: https://github.com/HelpViewer/Translations "Translation"
44+
[RWebHello]: https://github.com/HelpViewer/helpviewer.github.io "Project web presentation"
45+
[RWebHelloDeploy]: https://github.com/HelpViewer/helpviewer.github.io/actions/workflows/toPages.yml "Project web presentation - deployment"
46+
[FTSIndexBuilder]: https://github.com/HelpViewer/fulltextSearchDBBuilder "Full text index builder"
47+
[RhelpTemplate]: https://github.com/HelpViewer/helpTemplate "Help file project template"
48+
[RhelpHello]: https://github.com/HelpViewer/helpHello
49+
[RhelpUser]: https://github.com/HelpViewer/helpUser
50+
[RhelpAuthorsGuide]: https://github.com/HelpViewer/helpAuthorsGuide
51+
[R.github]: https://github.com/HelpViewer/.github "Repository with basic information"
52+
[RPrism]: https://github.com/HelpViewer/prism

‎en/newLangViewer.md‎

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
# 🌐 New language for Viewer
2+
3+
- For a new Viewer language, you need to create a new directory with the language abbreviation in [localization repository][Localiz] at the main level.
4+
- Select the abbreviation according to the **ISO 639-1** standard.
5+
- Your language translation for **HelpViewer** will be automatically distributed with the next release after PR approval.
6+
7+
## The meaning of files in localization
8+
9+
- Create all files in the **UTF-8 no BOM (65001)** character set.
10+
11+
| File | Meaning |
12+
|---|---|
13+
| lname.txt | The name of the language in the language. E.g. Español in Spanish |
14+
| lstr.js | Keys containing dynamic information. |
15+
| lstr.txt | Keys with static texts. |
16+
17+
## File structure
18+
19+
### lstr.js
20+
21+
```javascript
22+
var _lstr = {
23+
'key' : () => `value ${global-variable}`,
24+
};
25+
```
26+
27+
### lstr.txt
28+
29+
```
30+
key(html element id)|value
31+
key(html element id)__placeholder|input field title before entering it by cursor
32+
key(html element id)__aria-label|accessibility text
33+
key(html element id)__*|value HTML element attribute named *
34+
```
35+
36+
[Localiz]: https://github.com/HelpViewer/Translations "HelpViewer localization"

0 commit comments

Comments
 (0)