Skip to content

Commit 463fb58

Browse files
committed
enhance traduction fr
1 parent 3857d20 commit 463fb58

27 files changed

Lines changed: 275 additions & 282 deletions

docs/doc/en/3.4.-Attributes.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,3 @@
1-
21
# Attributes
32

43
Attributes are variables associated with files, cases or journals. They can be useful to add context when interpeting your analysis. Open the Manage Attributes dialog. You can add, delete, rename and add memo notes to attributes.

docs/doc/en/4.2.-AI-Assisted-Coding.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
## Introduction
22

33
QualCoder’s built-in AI features (version 3.6 and up) can assist the coding process in various ways:
4+
45
- **AI Search:** Leverage the AI's ability to quickly analyze large amounts of text to find and explore specific topics or concepts within your corpus.
56
- **Search for concepts, not keywords:** QualCoder uses a combination of semantic search technologies and Large Language Models like GPT-4. As a result, you don’t need to enter exact keywords but can also search for much more abstract concepts, e.g. "changing gender roles" or "recognition in the workplace".
67
- **Interpret your data interactively with the AI:** The AI not only suggests relevant data but also provides interpretation, offering a different perspective that can enrich your understanding of the data.

docs/doc/en/5.1.-AI-chat-based-analysis.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
# 5.1 AI Chat based analysis
2+
13
The AI Chat tab in the main window allows you to discuss certain aspects of your analysis with the AI. QualCoder provides four different types of chats:
24

35
<img src="https://github.com/user-attachments/assets/faddc4da-e281-48f9-816e-97c5bad45108" width=270em alt="Screenshot New Chat">
@@ -59,6 +61,7 @@ If you want to **define your own types of text analysis**, you can do so by addi
5961
<img src="https://github.com/user-attachments/assets/64423034-a9f8-4e7f-ab99-f50853b155b3" width=750em alt="Screenshot code analysis chat">
6062

6163
From the AI Chat tab, click "New > New Code Analysis Chat". In the following window, select a code or a category you want to analyze, and choose between several analytic prompts:
64+
6265
- **Code summary** will give you an overview of the data associated with the selected code
6366
- **Analyze unexpected** will look for the most interesting, unexpected insights in you coded data
6467
- **Analyze differences** will examine whether there are significant differences between your empirical cases/documents with regard to the selected code.

docs/doc/en/5.2.-Journals.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@ Journals can be exported as a single journal or all journal text can be collated
44
Journals can be deleted. Journals can have attributes.
55

66
There is a search option to search through journal text. The search uses regex symbols for more flexibility.
7+
78
* A dot '.' is used as a wild card, e.g. '.ears' will match ‘bears’ and 'years'
89
* A '?' after a character will match one or none times that character, e.g. 'bears?' will match 'bear' and 'bears'
910
* A '*' after a character will match zero or more times.

docs/doc/en/5.3.-Reports.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
# Reports menu options
2+
23
* Coding reports (the main reporting function)
34
* Coding comparison - for text files (compares 2 coders)
45
* Coding comparison by file - for text files (compares 2 coders)
@@ -27,7 +28,7 @@ Coding results can be narrowed down by using the File selection, Case selection
2728
If text is entered into the Search text field, only codings which contain the matching text will be presented.
2829
The search text also looks for matching text in memos for coded image areas and coded audio/video segments. The search text function must be used in combination with File selection, Case selection or Attribute selection.
2930

30-
** Important coded text, images, segments
31+
## Important coded text, images, segments
3132
There is a tick box to select only the Important codings. This is useful for quickly finding those important exemplars that you may use in a written report.
3233

3334
## Attribute selection in reports
@@ -102,7 +103,7 @@ Disagree % shows the percentage of all the coded and non-coded text that did not
102103

103104
Agree coded only % shows the percentage of all the dual coded text divided by single plus dual coded text.
104105

105-
Cohen’s Kappa is calculated based on the information in Wikipedia https://en.wikipedia.org/wiki/Cohen%27s_kappa
106+
Cohen’s Kappa is calculated based on the information in [Wikipédia](https://en.wikipedia.org/wiki/Cohen%27s_kappa).
106107

107108
<img width="1060" height="472" alt="Code comparisons table" src="https://github.com/user-attachments/assets/07e5ef6c-4e84-411b-a432-3f0ceac69b61" />
108109

@@ -247,6 +248,7 @@ Apply SQL Statements to query the data.
247248
This window contains three panes. The top pane is where SQL statements are entered and the bottom pane contains the results of queries. The left pane contains tables and field names. Double-clicking on a field name adds it to the SQL statement. Results can be exported to a delimited file. If you are not familiar with SQL take care as you will be able to update and delete the data as well as select data. Note: Some Unicode symbols are not converted to plain text and are ignored.
248249

249250
There are several prepared statements listed:
251+
250252
* Case text
251253
* Coded text using a case attribute selection (v3.6+)
252254
* Codes fileid and coded text

docs/doc/en/6.1.-Imports-and-Exports.md

Lines changed: 17 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,20 @@
1+
# 6.1 Imports and exports
12
Project menu
3+
24
* Exports
35
* Imports
46

5-
# Codebook export
7+
## Codebook export
68

79
This is an option under the Project Menu > Exports.
810

911
A codebook is a list of your codes. Each code memo should detail the reasons for the purpose of each code. The codebook can be exported to a text file. The codebook also shows the frequency of the codes used (from all coders). As codes and categories are put in a tree like structure the double minus ‘–‘ indicates the subordinate codes and categories within a category.
1012

11-
# Codebook import
13+
## Codebook import
1214

1315
Import a codebook as a plain text (.txt) file or as a .csv file. Use two greater than symbols to separate category and code.
1416

15-
## Plain text
17+
### Plain text
1618

1719
Use the tab to then add a memo.
1820

@@ -24,7 +26,7 @@ category1>>code3
2426

2527
category3>>code4
2628

27-
## CSV
29+
### CSV
2830

2931
The categories and codes are in the first column. Any code memos are in the second column.
3032

@@ -34,8 +36,8 @@ category1>>category2>>code2
3436

3537
category3>>code3
3638

37-
# REFI-QDA
38-
The Rotterdam Exchange Format Initiative (REFI) is an open standard for exporting and importing codebooks and projects from and to different computer-aided qualitative data analysis software. The website for the exchange initiative is www.qdasoftware.org
39+
## REFI-QDA
40+
[Rotterdam Exchange Format Initiative (REFI)](https://www.qdasoftware.org) is an open standard for exporting and importing codebooks and projects from and to different computer-aided qualitative data analysis software.
3941

4042
Currently, QualCoder is able to export and import a codebook.
4143

@@ -51,14 +53,14 @@ If no coded data is visible, you may need to change the current coder's name in
5153

5254
This is now old (Feb 2021), but a user tested the importation of a REFI-QDA project file generated by QualCoder and imported into MAXQDA, Quirkos, Atlas.ti. Only text and Images were tested. A PDF of the test results is here: [Testing importation of REFI-QDA Project files into Atlas, MAXQDA, Quirkos PDF](https://qualcoder.files.wordpress.com/2021/02/refi-qda-project-import-quirkos-maxqda-atlas.pdf)
5355

54-
# RQDA
55-
Projects made with RQDA (http://rqda.r-forge.r-project.org/) can be directly imported. All data except for file categories are imported.
56+
## RQDA
57+
Projects made with [RQDA](http://rqda.r-forge.r-project.org/) can be directly imported. All data except for file categories are imported.
5658

5759
Close any opened project. Then in the Main Menu under Project click on RQDA Project import. You will be asked to create a new project- so enter a name. Then you will be asked to select the RQDA project file. QualCoder will then import the data.
5860

5961
If no coded data is visible, you may need to change the current coder's name in Settings. Try the drop down coder name box.
6062

61-
# Survey import
63+
## Survey import
6264

6365
This requires a CSV or Excel (xlsx format) file. You can try importing the survey.csv file in the Examples folder.
6466

@@ -88,7 +90,7 @@ The default option, is that each qualitative response for each row, will be stor
8890

8991
When you click on the OK button, the cases and their attributes will be added.
9092

91-
## Older versions of QualCoder, e.g. QualCoder 3.5.
93+
### Older versions of QualCoder, e.g. QualCoder 3.5.
9294
Each qualitative question answer was appended to ONE text file. Preceding the answer was additional QualCoder added text, to show which case the answer was relevant to.
9395

9496
In this format: _[unique id] The qualitative text._
@@ -98,7 +100,7 @@ Open Manage Files, then View that file, and you will see the case assigned text
98100
![image](https://github.com/user-attachments/assets/5c05347a-731b-40d8-943f-921409447403)
99101

100102

101-
# Bibliography import
103+
## Bibliography import
102104

103105
Import a bibliography. This must be in RIS formatted plain text. The file can have endings of .txt or .ris
104106

@@ -117,19 +119,20 @@ In here there will be four new attribute columns: Ref_Authors, Ref_Title, Ref_Ty
117119

118120
Files link to references will have details in those columns.
119121

120-
# Help - Special Functions
122+
## Help - Special Functions
121123

122-
## Dynamic update text content
124+
### Dynamic update text content
123125

124126
This is useful for updating text files such as blog post extract that change over time. Update a text file while attempting to keep the existing coded text segments. Select the text file that needs to be replaced and select the replacement file. Click the cogs button to run the update. This function works by finding the identical matching text in the replacement file, as it parses through the file text. It may produce erroneous coded segments.
125127

126-
## Merge QualCoder Projects
128+
### Merge QualCoder Projects
127129

128130
Select a QualCoder project to merge (source project) into the currently opened project (destination project), then click the _Run merge projects_, cogs button. **Before performing the merge, make a backup of the destination project.**
129131

130132
Caution: If each project to be merged has the same coder name, e.g. 'default' then these will merge as such, and you will not be able to separate out which coder performed their own coding. This may or may not be an important consideration to your final merged project.
131133

132134
The following occurs:
135+
133136
* Copies unmatched files from source project folders to destination project folders.
134137
* Adds new (unmatched) source categories to destination database.
135138
* Adds new (unmatched) source code names to destination database.

docs/doc/en/6.2.-AI-Prompt-Library.md

Lines changed: 3 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,7 @@ This is the basic structure:
1515
<img src="https://github.com/user-attachments/assets/b77df95d-f5b3-4ffa-8d3a-a511c82ef9ab" width=500em>
1616

1717
This structure consists of
18+
1819
- **fixed elements** (shown here in white on blue) that are defined in the source code of the application,
1920
- **contextual information** (here in green) that you enter at various places in QualCoder's user interface, such as code names and memos, or the project memo with important information about your research,
2021
- **empirical data** (here in yellow), selected in various ways, and
@@ -39,13 +40,9 @@ The prompts are divided into several categories:
3940
- **User** prompts are defined by the user and stored on their computer. They are available to any project opened on that computer.
4041
- **Project** specific prompts are stored with the project files. If you or someone else opens the same project on a different computer, these prompts will be available there as well.
4142

42-
3) **Prompt name and description**
43-
44-
These are displayed in several places in the user interface where you can select an analytic prompt. The names must be unique within each scope.
45-
46-
4) **Prompt text**
43+
3) **Prompt name and description**: These are displayed in several places in the user interface where you can select an analytic prompt. The names must be unique within each scope.
4744

48-
These are the actual instructions that will be sent to the AI (the orange box in the image above). If you want to share your prompt with someone else, this is the most important information you will need to send over.
45+
4) **Prompt text**: These are the actual instructions that will be sent to the AI (the orange box in the image above). If you want to share your prompt with someone else, this is the most important information you will need to send over.
4946

5047

5148
## A Note About Languages

docs/doc/en/7.3.-QualCoder-Development.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,9 +22,11 @@ Some potential plans for the future are to add functionality:
2222
### Reports:
2323

2424
**Look at alternative ways to visualise codes:**
25+
2526
* Display code frequency in a comparative way - e.g. compare female versus males for the code frequencies using bar charts or other plots
2627

2728
**Look at timeline reporting:**
29+
2830
* Maybe add in a way to display coding from documents in a timeline - drawing from a file data attribute that is created by the end user.
2931

3032
### General:

0 commit comments

Comments
 (0)