Skip to content

Commit 86d0fc1

Browse files
VitSimonVitSimon
committed
EN : partial translation : files.lst, newLang, newLangViewer, newTopic, publish
1 parent 8a2fff5 commit 86d0fc1

File tree

5 files changed

+175
-1
lines changed

5 files changed

+175
-1
lines changed

‎en/files.lst‎

Lines changed: 32 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,32 @@
1-
README.md|Overview
1+
README.md|Authoring Guide
2+
features.md|Features
3+
newHelp.md|Create new help file
4+
struct.md|Help project structure
5+
general.md|General recommendation
6+
newTopic.md|New chapter
7+
links.md|Odkazy v textech
8+
images.md|Images in text
9+
code.md|Code listing
10+
diagram.md|Diagram
11+
texts.md|Texts
12+
heading.md|Heading detection
13+
indexing.md|Chapter indexation
14+
newLang.md|New language for help file
15+
helpCfg.md|Help configuration
16+
tocIcon.md|TOC icons
17+
innerJS.md|Inline JavaScript blocks
18+
mdata/files.lst.md|File list
19+
mdata/keywords.lst.md|Keywords list
20+
mdata/keywords-files.lst.md|Keyword - file connection
21+
mdata/tree.lst.md|TOC tree
22+
fulltextIndex.md|Fulltext index
23+
publish.md|Publishing steps
24+
customUI.md|Viewer Custom UI
25+
token.md|GitHub Token
26+
integration.md|Integration with application
27+
helpviewer.md|HelpViewer Project
28+
=latestApp|Download latest version
29+
https://github.com/HelpViewer/HelpViewer|GitHub repository
30+
https://github.com/HelpViewer/HelpViewer/pkgs/container/helpviewer|Container images
31+
https://discord.gg/J2SjcmqHSZ|User group
32+
newLangViewer.md|New language for Viewer

‎en/newLang.md‎

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
# 🌐 New language for help file
2+
3+
1. For a new help language, you need to create a new directory with the language abbreviation in your main level repository.
4+
- To determine this abbreviation, refer to the list of known language abbreviations in the [localization Repository][Localiz] HelpViewer. This has the advantage of automatically switching the user's version of help when setting the language of the entire environment.
5+
- If no suitable abbreviation exists, choose an abbreviation ideally according to **ISO 639-1**.
6+
- You can write help in your language, even if **HelpViewer** itself is not localized.
7+
2. The directory should ideally be based on a copy of an existing localization that you understand, so that you have the texts of both languages side by side.
8+
3. Do not change file names or locations.
9+
4. Translate the indexing files:
10+
- 📑 [files.lst][Dfiles.lst] - right half (backup headings)
11+
- 📇 [keywords.lst][Dkeywords.lst] - list of keywords
12+
- 📖 [tree.lst][Dtree.lst] - topic tree
13+
5. Translate the texts of the chapters.
14+
6. The names of the bookmarks (anchors) will be changed as the chapters are translated (make sure the links are valid).
15+
16+
[Localiz]: https://github.com/HelpViewer/Translations "HelpViewer localization"
17+
[Dfiles.lst]: mdata/files.lst.md "files.lst"
18+
[Dkeywords.lst]: mdata/keywords.lst.md "keywords.lst"
19+
[Dtree.lst]: mdata/tree.lst.md "tree.lst"

‎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+
```
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"

‎en/newTopic.md‎

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
# 📄 New chapter
2+
3+
- You will define new chapter in your help by creating a new **md** or **htm** file.
4+
- Follow the standard document syntax for these formats ([md][MDSyntax], [HTML 5][HTML5Syntax]).
5+
- In HTML files write only content of **body** tag, but without body and surrounding tags to keep result HTML output compliant with **W3C** standard.
6+
- Currently **HelpViewer** has no editor of its own. For efficient writing, I recommend using **WYSIWYG** editors.
7+
8+
- For **md** files e.g.:
9+
- [Editor.md][MDE-1]
10+
- [stackedit.io][MDE-2]
11+
- [Toast UI editor][MDE-3]
12+
(all of these works offline in your web browser)
13+
14+
- For **htm** files e.g.:
15+
- [VS Codium][HTM-1]
16+
- [Geany][HTM-3]
17+
- [PSPad][HTM-2]
18+
(after an installation all of these works locally as a desktop version)
19+
20+
- Write the files in these editors, then download their source and save them in the help repository folder.
21+
- Editors can also occasionally fail and lose your parsed text. Therefore, copy the text to your disk over time.
22+
23+
[MDSyntax]: https://www.markdownguide.org/basic-syntax/ "MD syntax"
24+
[HTML5Syntax]: https://www.tutorialspoint.com/html5/html5_syntax.htm "HTML5 syntax"
25+
[MDE-1]: https://pandao.github.io/editor.md/en.html "Editor.md"
26+
[MDE-2]: https://stackedit.io/app# "stackedit.io"
27+
[MDE-3]: https://ui.toast.com/tui-editor "Toast UI editor"
28+
[HTM-1]: https://vscodium.com/ "VS Codium"
29+
[HTM-2]: https://www.pspad.com/cz/download.php "PSPad"
30+
[HTM-3]: https://www.geany.org/download/releases/ "Geany"

‎en/publish.md‎

Lines changed: 58 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,58 @@
1+
# 📦 Publishing of help file
2+
3+
💡 Recommendation:
4+
- If you don't know **Git**, check out its [documentation][GitRef].
5+
6+
✅ Entry conditions / Prerequisites:
7+
- Make sure you have a [🔑 PAT Token][PATToken] properly linked to the help repository that has not expired. If the token is not valid, the release script will fail.
8+
9+
The simplified procedure for issuing a hint can be summarised as follows:
10+
11+
1. Open a terminal/command prompt
12+
2. Go to your repository
13+
3. Add all your unmerged changes:
14+
```
15+
git add .
16+
```
17+
4. Merge the changes into the repository:
18+
```
19+
git commit -m "Help file changes"
20+
```
21+
"Help file changes" - any of your descriptive messages can be here
22+
23+
5. Make a change to the **CHANGELOG.md** file at the root of the repository so that the beginning of the file looks like:
24+
```
25+
# Changelog
26+
27+
## YMD
28+
- My changes
29+
```
30+
31+
kde:
32+
33+
| Position | Description |
34+
|---|---|
35+
| YMD | the date will be in 202050622 format (year, month and day without separators) |
36+
| My changes | Write down your change descriptions |
37+
38+
6. Merge the changes into the repository:
39+
```
40+
git commit -m "Help file changes [pub]"
41+
```
42+
- "Help file changes" - any of your descriptive messages can be here
43+
- **[pub]** in the message text is required to run the release script
44+
45+
7. Merge your version into the GitHub server:
46+
```
47+
git push
48+
```
49+
50+
The release script is then run.
51+
52+
The result will be an edition with attachments:
53+
- Help-(language short code).zip (for each individual language)
54+
- Help-.zip (for [custom Viewer UI][CustomUI])
55+
56+
[GitRef]: https://git-scm.com/docs "Git"
57+
[PATToken]: token.md "GitHub PAT token"
58+
[CustomUI]: customUI.md "Custom Viewer UI"

0 commit comments

Comments
 (0)