Skip to content

Commit 87f01c6

Browse files
VitSimonVitSimon
committed
EN : translation finished : links, token
1 parent 4739b04 commit 87f01c6

File tree

2 files changed

+134
-0
lines changed

2 files changed

+134
-0
lines changed

‎en/links.md‎

Lines changed: 74 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,74 @@
1+
# 🔗 Links in texts
2+
3+
- Two underscores (**__**) represents the selected language, which the system automatically adds from the user settings.
4+
- Refer to documents in relative ways (using ..).
5+
- Use **forward - /** for slashes in travel.
6+
- For more complex links (going to another help), use **?** and enter only parameters to make the system transfer easier in the future
7+
8+
See below for common ways to define a link.
9+
10+
## Inside Help
11+
12+
### Other topic/page
13+
```
14+
The file defines a link between [keywords][Dkeywords.lst] and a list of [files][Dfiles.lst]
15+
// ... at the end of the file:
16+
[Dfiles.lst]: mdata/files.lst.md "files.lst"
17+
[Dkeywords.lst]: mdata/keywords.lst.md "keywords.lst"
18+
```
19+
The file defines a link between [keywords][Dkeywords.lst] and a list of [files][Dfiles.lst]
20+
21+
### Another topic and its subchapter
22+
```
23+
Chapter [How the application works][working] discusses the basics of working with the application.
24+
// ... at the end of the file:
25+
[working]: README.md#how-it-works "How the application works"
26+
```
27+
*Here, the link created will automatically change with the language translation of the chapters.*
28+
29+
Chapter [How the application works][working] discusses the basics of working with the application.
30+
31+
## Outside the help file - URI path
32+
```
33+
This solution also uses the [JSZip library][JSZIP].
34+
// ... at the end of the file:
35+
[JSZIP]: http://jszip.org/ "JSZip - support for ZIP files handling"
36+
```
37+
This solution also uses the [JSZip library][JSZIP].
38+
39+
## Another help file
40+
41+
### Default page
42+
```
43+
You will see [user documentation][userdoc] directly in the HelpViewer, just like you see this website now.
44+
// ... at the end of the file:
45+
[userdoc]: ?d=hlp-user/Help-__.zip "Help Viewer quick guide"
46+
```
47+
48+
You will see [user documentation][userdoc] directly in the HelpViewer, just like you see this website now.
49+
50+
### Specific topic
51+
```
52+
If the problem persists, go to [troubleshooting guide][trouble].
53+
// ... at the end of the file:
54+
[trouble]: ?d=hlp/Help-__.zip&p=trouble.md "Troubleshooting guide"
55+
```
56+
57+
If the problem persists, go to [troubleshooting guide][trouble].
58+
59+
### URI from the network
60+
```
61+
You will see [user documentation][userdoc2] directly in the HelpViewer, just like you see this website now.
62+
// ... at the end of the file:
63+
[userdoc2]: ?d=https://github.com/HelpViewer/helpUser/releases/download/20250615/Help-__.zip "Help Viewer quick guide"
64+
```
65+
66+
You will see [user documentation][userdoc2] directly in the HelpViewer, just like you see this website now.
67+
68+
[Dfiles.lst]: mdata/files.lst.md "files.lst"
69+
[Dkeywords.lst]: mdata/keywords.lst.md "keywords.lst"
70+
[working]: README.md#how-it-works "How the application works"
71+
[JSZIP]: http://jszip.org/ "JSZip - support for ZIP files handling"
72+
[userdoc]: ?d=hlp-user/Help-__.zip "Help Viewer quick guide"
73+
[trouble]: ?d=hlp/Help-__.zip&p=trouble.md "Troubleshooting guide"
74+
[userdoc2]: ?d=https://github.com/HelpViewer/helpUser/releases/download/20250615/Help-__.zip "Help Viewer quick guide"

‎en/token.md‎

Lines changed: 60 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,60 @@
1+
# 🔑 Token
2+
3+
For the release to work properly, you need to create a PAT GitHub user token.
4+
5+
If the token is not linked to the repository or expires, the build script will fail when trying to upload the generated help to the release attachments.
6+
7+
## Creating a PAT token
8+
9+
1. Open:
10+
```
11+
https://github.com/settings/personal-access-tokens
12+
```
13+
14+
2. Fine-grained personal access tokens
15+
3. Generate new token
16+
4. Choose a name according to yourself
17+
5. Resource owner will your organisation or you as a user
18+
6. Expiration set the value as high as possible
19+
7. Repository access: Only select repositories (then select the specific repository with your help)
20+
8. Set the following areas and permission levels in the token:
21+
22+
| Area | Level |
23+
|---|---|
24+
| Actions | Read and write |
25+
| Commit statuses | Read and write |
26+
| Contents | Read and write |
27+
| Deployments | Read and write |
28+
| Environments | Read and write |
29+
| Merge queues | Read and write |
30+
| Metadata | Read-only |
31+
| Pull requests | Read and write |
32+
| Webhooks | Read and write |
33+
| Workflows | Read and write |
34+
35+
9. Generate token
36+
10. In the green box you will see the token code to save. Do not reload, you would not get the code again. (If you accidentally reload, click on the token name. This will bring up the detail, and here click on **Regenerate token**, confirm Expiration and you will see the new code this time in the blue box.)
37+
38+
## Linking the token to the help repository
39+
40+
The following steps need to be taken:
41+
42+
1. Open:
43+
```
44+
https://github.com/(organizace)/(repozitář)/settings/secrets/actions
45+
```
46+
(
47+
- On the repository tab at the top:
48+
- On right: Settings
49+
- On left down: Secrets and variables
50+
- Actions
51+
52+
)
53+
54+
1. On right: Repository secrets
55+
2. New repository secret
56+
3. Name: **_TOKEN** (name cannot be changed)
57+
4. Enter the code you saved from the previous step
58+
5. Add secret
59+
60+
The hint build process should now work correctly.

0 commit comments

Comments
 (0)