Skip to content

Commit 2c802f0

Browse files
committed
EN : partial translation : code, diagram, fulltextIndex, images
1 parent 5d1604e commit 2c802f0

File tree

4 files changed

+100
-0
lines changed

4 files changed

+100
-0
lines changed

en/code.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
# 🧾 Code listing
2+
3+
There is no support for this in HTML documents.
4+
5+
You will insert code listing to **md** file this way:
6+
7+
````
8+
```
9+
Your code snippet text
10+
```
11+
````
12+
13+
Example:
14+
15+
```
16+
Your code snippet text
17+
```

en/diagram.md

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
# 📊 Diagram
2+
3+
You will insert diagram to **md** file this way:
4+
5+
````
6+
```mermaid
7+
graph TD;
8+
A-->B;
9+
A-->C;
10+
B-->D;
11+
C-->D;
12+
```
13+
````
14+
15+
Example:
16+
17+
```mermaid
18+
graph TD;
19+
A-->B;
20+
A-->C;
21+
B-->D;
22+
C-->D;
23+
```
24+
25+
- For more examples read the [Mermaid][Mermaid] library documentation.
26+
- During HelpViewer package praparation there is every time used the last one version of Mermaid, which is published in [jsdelivr][MermaJsDelivr] distribution.
27+
28+
[Mermaid]: https://mermaid.js.org/intro/ "Mermaid library - renderer for diagrams defined by specific textual definitions"
29+
[MermaJsDelivr]: https://cdn.jsdelivr.net/npm/mermaid/dist/ "Mermaid - JsDelivr"

en/fulltextIndex.md

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
# 🔎 Fulltext search (fts-keywords.lst)
2+
3+
- File is used for fulltext search (🔎)
4+
- It is located in language version subdir.
5+
- Each language has its own independent copy.
6+
- If file **exists, then it is turned on** the creation of fulltext index during publishing process. There are no more steps needed from side of help author.
7+
- Keep file empty
8+
- If you want to turn off the fulltext index, then delete this file.
9+
10+
## Logic description in general
11+
12+
In repository [fulltextSearchDBBuilder][FTSIndexing] there is stored all logic of fulltext index assembly process. It is bash script.
13+
14+
For each one language independently there will be done these steps:
15+
16+
1. Select files: \*.md;\*.htm;\*.html for indexing
17+
2. All content is converted to UTF-8 code page
18+
3. Missing files in [file list][Dfiles.lst] are attached to end of list without any backup heading
19+
4. All letters are converted to lowercase
20+
5. Letters are stripped of diacritics and special characters (e.g.: about:blank -> aboutblank)
21+
6. Words smaller than 3 letters are excluded from next processing
22+
7. There is counted sum of emerges of words in each of indexed document/chapter
23+
8. The documents are ordered by word count from highest to lowest for each word
24+
9. Two new files will be created:
25+
- fts-keywords.lst (words)
26+
- fts-keywords-files.lst (word to files interconnection list)
27+
Files follow the same structure as defined in [keywords][Dkeywords.lst]
28+
29+
[FTSIndexing]: https://github.com/HelpViewer/fulltextSearchDBBuilder "Fulltext index assembly"
30+
[Dkeywords.lst]: mdata/keywords.lst.md "keywords.lst"
31+
[Dfiles.lst]: mdata/files.lst.md "files.lst"

en/images.md

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
# 🖼️ Images
2+
3+
You can insert images to chapter text this way:
4+
5+
```
6+
![description if image doesn't exists](path/to/image.png "Bubble hint description")
7+
```
8+
9+
There can be 2 types of path to image file:
10+
- local inside the help file:
11+
```
12+
path/to/image.png
13+
```
14+
- or remote:
15+
```
16+
https://avatars.githubusercontent.com/u/214681531?s=200&v=4
17+
```
18+
19+
Example:
20+
21+
![description if image doesn't exists](https://avatars.githubusercontent.com/u/214681531?s=200&v=4 "Bubble hint description")
22+
23+
![description if image doesn't exists (local image from given help file)](_icon.png "local image from given help file")

0 commit comments

Comments
 (0)