Skip to content

Commit a5ea81b

Browse files
committed
create es doc
1 parent 23d856e commit a5ea81b

31 files changed

Lines changed: 2869 additions & 6 deletions

docs/doc/add_metadata.py

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
# Dossiers contenant les fichiers Markdown
44
en_dir = "en"
55
fr_dir = "fr"
6-
6+
es_dir = "es"
77
def add_path_metadata(directory, lang):
88
"""Ajoute le bloc `path` en haut des fichiers Markdown."""
99
for root, _, files in os.walk(directory):
@@ -37,11 +37,9 @@ def add_path_metadata(directory, lang):
3737
f.write(new_content)
3838
f.truncate()
3939

40-
# Ajouter les métadonnées `path` pour les fichiers en anglais
41-
add_path_metadata(en_dir, "en")
4240

43-
# Ajouter les métadonnées `path` pour les fichiers en français
41+
add_path_metadata(en_dir, "en")
4442
add_path_metadata(fr_dir, "fr")
45-
43+
add_path_metadata(es_dir, "es")
4644
print("Les métadonnées `path` ont été ajoutées à tous les fichiers Markdown.")
4745

docs/doc/es/2.1.-Installation.md

Lines changed: 80 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,80 @@
1+
---
2+
path: 2.1.-Installation
3+
---
4+
5+
# QualCoder Installation and running instructions
6+
7+
## INSTALLATION
8+
9+
For the manual installations (using the command line or terminal) I mention a specific release version, for example version 3.7. Please check on the [releases page](https://github.com/ccbogel/QualCoder/releases) for the most current version, as it may be newer.
10+
11+
### Prerequisites
12+
VLC is optional, but you will need it installed if you need to do any audio/video coding. Occasionally on some operating systems (e.g. Fedora) QualCoder cannot find VLC to use it. Optionally, install ffmpeg for waveform display, see https://phoenixnap.com/kb/ffmpeg-windows
13+
14+
### Windows
15+
16+
See [https://github.com/ccbogel/QualCoder/releases/3.7](https://github.com/ccbogel/QualCoder/releases/3.7)
17+
18+
You have two options for executables created on Windows 11:
19+
20+
Option 1: There is a Windows installer on the release page called: **QualCoder.Win.3.7.exe**
21+
22+
Option 2: There is a standalone, non-installable exe folder called: **QualCoder.Win.3.7.Portable.zip** Download and unzip. It is in a folder alongside an internal folder. These both must be together or the exe will not run. Double-click the QualCoder exe to run, it takes up to 20 seconds to start.
23+
24+
Standalone, portable version: <img width="100" height="60" alt="QualCoder portable" src="https://github.com/user-attachments/assets/6be1de98-8b47-4d57-b4b5-c34375e44959" />
25+
26+
On first use of the exe, Windows will ask you to allow to run QualCoder. This is because it is from an unknown publisher. It costs a lot of money to get a trusted publisher certificate - so that will not be possible for the foreseeable future. If you are uncomfortable with these warnings install from the source as detailed next.
27+
28+
Alternatively, install from source code:
29+
30+
Download the source code. Read and apply the section for Windows source code installation in the **Readme.md** file.
31+
Remove the back-ticks that surround the command line instructions ` as these are used for display only.
32+
33+
### MacOS
34+
35+
**Install from App bundles:**
36+
37+
Make sure you have installed any macOS updates before starting the installation. Go to the System Settings app on your Mac. Click General in the sidebar (you may need to scroll down), then click Software Update.
38+
39+
Install QualCoder: Double-click the downloaded dmg-file. Drag QualCoder into the link to your applications.
40+
41+
Start QualCoder from your Launchpad or by double-clicking the app within your applications folder.
42+
We are currently not able to sign the app bundles, so when you first try to run the program, you may get a pop-up warning that QualCoder is from an unregistered developer or "QualCoder can't be opened because Apple cannot check it for malicious software." Depending on your processor, you may see one of these:
43+
44+
If you see "Show in Finder" or OK. Click Ok.
45+
46+
If you see "Done" or "Move to trash". Click Done.
47+
48+
Next, go to Settings and select Privacy and Security. Scroll down until you see a message stating QualCoder was prevented from starting. Click on "open anyway". You may be prompted to enter your password and may need to click "Open" again. After entering your password, just wait for the program to open up. It may take several seconds.
49+
50+
From now on, QualCoder should start without issues.
51+
52+
**Install from source code:**
53+
54+
Download the source code. Read and apply the section for macOS source code usage in the **Readme.md** file.
55+
Remove the back ticks that surround the command line instructions ` as these are used for display only.
56+
57+
58+
### Debian / Ubuntu / Lubuntu / ZorinOS Linux
59+
60+
There is an executable file in the releases page for Ubuntu 24.04 for the 3.6 release. Download and double click to run.
61+
62+
Alternatively, run QualCoder from the source code:
63+
64+
Download the source code. Read and apply the section for Ubuntu source code usage in the **Readme.md** file.
65+
Remove the back ticks that surround the command line instructions ` as these are used for display only.
66+
67+
### Fedora Linux
68+
69+
These instructions download the current source code directly from GitHub. Note: Fedora uses Wayland which may not work well with the Qt graphical interface. It is suggested you also install Xwayland.
70+
71+
Download the source code. Read and apply the section for Fedora source code usage in the **Readme.md** file.
72+
Remove the back ticks that surround the command line instructions ` as these are used for display only.
73+
74+
There may be problems with QualCoder working with audio / video in Fedora.
75+
76+
### Arch/Manjaro Linux
77+
78+
Download the source code. Read and apply the section for Arch source code usage in the **Readme.md** file.
79+
Remove the back ticks that surround the command line instructions ` as these are used for display only.
80+

docs/doc/es/2.2.-Settings.md

Lines changed: 60 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,60 @@
1+
---
2+
path: 2.2.-Settings
3+
---
4+
5+
6+
# Settings
7+
8+
The settings screen allows you to change several features including language, coder name and font type and font size, as well as options for the AI integration.
9+
10+
### Coder name
11+
12+
Multiple coders can code and annotate the same text. Your current coder name is displayed at the top of the settings dialog.
13+
14+
<img width="400" alt="grafik" src="https://github.com/user-attachments/assets/cd0aab19-5f2b-43de-b6f0-08ab171fbb91" />
15+
16+
This name will be used to identify your contributions to the project. Click the "Change" button to alter your identity or to create, rename, or merge other coders within the current project. [See here for more information.](2.4.-Working-in-a-Team.md/#important-considerations-regarding-coder-names)
17+
18+
### General settings
19+
20+
The default language of QualCoder is English. Chinese, French, German, Italian, Japanese, Portuguese and Spanish, Swedish are alternative languages. Some languages have not been thoroughly reviewed for accuracy of translations. When changing a language, you need to close then reopen QualCoder for the change to occur.
21+
22+
Checking the Show IDs box displays the numeric IDs for codes files cases and more. These IDs may be useful when writing sql queries.
23+
24+
There area few options to change the overall look of QualCoder.
25+
26+
For transcribing audio and video, the time format and bracket type can be selected.
27+
28+
Very large text files can slow the coding mode in QualCoder. So a right-click option in Code Text is to load smaller sized chunks of the text. 50,000 characters is the default size, but this can be changed in Settings to smaller sizes for slower computers.
29+
30+
<img width="800em" alt="settings dialog" src="https://github.com/user-attachments/assets/ff9c27a9-180d-41eb-aa60-877e1ff7cfb9" />
31+
32+
### Backups
33+
34+
Project backup can be set to automatically backup every hour, or no backup. QualCoder keeping the most recent backups with a date and hour time stamp. The backup name is: _projectname_BKP_yyyymmdd_hh.qda_ Where _hh_ is 24 hour time. This also means multiple backups are not done within an hour. So a new backup cannot overwrite another backup created within the same hour. A limited number of backups are kept, **older backups are deleted**. Setting option allows you to choose from 1 to 10 backups.
35+
36+
I recommend that you make a backup before doing any substantial changes, such as reorganising codes and categories, merging projects, or merging codes. QualCoder does perform hourly backups (keeping up to the most recent five) if backups are set in the settings.
37+
38+
Rename or move to another location particular backups that you need to keep. When the backups are set, an additional option is to choose to backup the audio/video files. For completeness of backups it is recommended to back up audio and video, however this may slow down opening of the software if you have many large files. Alternatively you can link to large audio/video files rather than import them into the project folder. The default project directory is where many file operations will default to, for export or looking to import files.
39+
40+
In your home folder QualCoder will create a .qualcoder folder with a QualCoder.log file for logging events and a config.ini file which will contain a lot of settings such as the current coder’s name, preferred fonts, language and a preferred working directory. Do not sure any data or project inside the .qualcoder folder. The only file that you should put in here is a stopwords.txt file, only if you need to apply a different set of stopwords for word cloud and word count functions. This folder is only for the QualCoder software to use as it is running.
41+
42+
## Advanced options and logging
43+
44+
The **AI related options** at the bottom of the Settings dialog are described here: [AI Setup](https://qualcoder-org.github.io/doc/en/2.3.-AI-Setup)
45+
46+
47+
48+
49+
50+
51+
52+
53+
54+
55+
56+
57+
58+
59+
60+

0 commit comments

Comments
 (0)