Skip to content

Commit 6ff57dd

Browse files
authored
Update 3.2.-Files.md
1 parent 87decb4 commit 6ff57dd

1 file changed

Lines changed: 15 additions & 7 deletions

File tree

docs/doc/en/3.2.-Files.md

Lines changed: 15 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ Import linked, export to linked buttons: <img width="88" height="45" alt="Import
1818

1919
### Pdfs - plain text extraction
2020

21-
PDF importing can be problematic and may need editing as formatting is lost. Large PDF files take a long time to import. QualCoder extracts text from the Pdf files using pdfminer.six, but you may choose to use another extraction program for the plain text, suggestions include: www.pdf2go.com/ www.pdfmate.com/pdf-converter-free.html https://pandoc.org/ and then copy the plain text across. However, if you want to use the _Code Pdf_ function within QualCoder which allows text coding with the PDF text showing in place like the original PDF, you must use QualCoder's plain text extraction, and not edit the extracted plain text.
21+
PDF importing can be problematic and may need editing as formatting is lost. Large PDF files take a long time to import. QualCoder extracts text from the Pdf files using pdfminer.six, but you may choose to use another extraction program for the plain text, suggestions include: [PDF2Go](https://www.pdf2go.com), [PDFMate](https://www.pdfmate.com/pdf-converter-free.html), [Pandoc](https://pandoc.org) and then copy the plain text across. However, if you want to use the _Code Pdf_ function within QualCoder which allows text coding with the PDF text showing in place like the original PDF, you must use QualCoder's plain text extraction, and not edit the extracted plain text.
2222

2323
### Pseudonymisation (data de-identification)
2424

@@ -115,23 +115,30 @@ You can create and enter text into text in the database by pressing the pencil i
115115

116116
Create text entry button: <img width="57" height="47" alt="Pencil icon button, to create a plain text file" src="https://github.com/user-attachments/assets/3e25677d-56de-48b5-81e3-e292979672be" />
117117

118-
Text files can be edited providing no coding or annotations or case assignment have been performed with the text file. **BEST PRACTICE: Save a copy of the project before editing the text of a coded text file.**
118+
Text files can be edited providing no coding or annotations or case assignment have been performed with the text file.
119+
120+
!!! tip "Best practice"
121+
Save a copy of the project before editing the text of a coded text file.
119122

120123
Sections of the text file or audio/video transcribed file will have sections of text underlined in green (case assigned), yellow (annotation) or red (coded). Text can be edited even after the text is coded or annotated or assigned (fully or partially) to a case.
121124

122125
You can select text that is not underlined and copy/replace without problems. You can click on a position (**without selecting a section of text**) to then type, delete, or paste text. This can occur in underlined (coded, annotated, case-assigned) or not underlined (not coded/annotated/case-assigned) text locations. You will see the underlines shift as text is added or removed.
123126

124-
**There are some limitations: It is best to avoid selecting sections of text to delete (or to type or paste over) if those sections have a combination of not underlined (not coded/annotated/case-assigned) and underlined (coded, annotated, case-assigned). The reason is that the positions of the underlying codes/annotations/case-assigned may not correctly match as intended. If you have made a change that you think has affected these coded/annotated/case-assigned positions badly, exit the text editing window by pressing the Cancel button.**
127+
!!! info
128+
There are some limitations: It is best to avoid selecting sections of text to delete (or to type or paste over) if those sections have a combination of not underlined (not coded/annotated/case-assigned) and underlined (coded, annotated, case-assigned). The reason is that the positions of the underlying codes/annotations/case-assigned may not correctly match as intended. If you have made a change that you think has affected these coded/annotated/case-assigned positions badly, exit the text editing window by pressing the Cancel button.
125129

126130
## Audio and Video files
127131

128132
Video (mov, mp4, wmv, ogg) and audio files (wav, mp3, m4a) can be imported. Loading an audio or video file will also automatically create a blank text transcribed file. This file will have the same name as the audio or video file, but have a '.txt' suffix. Initially, this text transcription will be empty. You can transcribe the file yourself or get the file professionally transcribed and copy and paste the text into this file.
129133

130134
You can open an audio or video file to view. For video, this opens two windows, one for viewing the video and one for the controls and a transcript, shown below. When an audio or video file is loaded into QualCoder a blank text transcription file is automatically created. The transcription file name defaults to videoname.txt.
131135

132-
The transcribed text file is created and stored within the database, and can be exported to a text file. The file can be edited. **Important note: The edits occur within the database. An original text file is NOT changed. Transcriptions cannot be linked as an external file.**
136+
The transcribed text file is created and stored within the database, and can be exported to a text file. The file can be edited.
137+
138+
!!! warning
139+
Important note: The edits occur within the database. An original text file is NOT changed. Transcriptions cannot be linked as an external file.
133140

134-
If you have a .srt file (a translation file that is read by VLC) you can place this alongside the video inside the project folder, in the video folder, shown in the image below. When the video is played, the translation wording will be shown as subtitles in the video. Also, if you open the .srt file in a text editor, copy and paste this into the associated video text file. Then this text will be shown as the transcription for the video.
141+
If you have a .srt file (a transcript file that is read by VLC) you can place this alongside the video inside the project folder, in the video folder, shown in the image below. When the video is played, the translation wording will be shown as subtitles in the video. Also, if you open the .srt file in a text editor, copy and paste this into the associated video text file. Then this text will be shown as the transcription for the video.
135142

136143
![image](https://github.com/user-attachments/assets/221aac54-1907-41a7-95cc-26899250b13a)
137144

@@ -141,7 +148,7 @@ If you have ffmpeg installed a waveform is shown. If the audio files has multipl
141148

142149
To transcribe open the Manage files menu option, then view the audio or video file. The audio/video will load and there will be a text area to enter transcribed text.
143150

144-
QualCoder does not have an automated audio to text feature. Use other services such as: Microsoft Word Transcribe, Zoom transcription, Otter AI: https://otter.ai/, VOSK. https://alphacephei.com/vosk/install, audiopolis https://github.com/audapolis/audapolis, noScribe an offline transcriber for 99 different languages: https://github.com/kaixxx/noScribe
151+
QualCoder does not have an automated audio to text feature. Use other services such as: Microsoft Word Transcribe, [otter.ai](https://otter.ai/), [Vosk](https://alphacephei.com/vosk/install), [audapolis](https://github.com/audapolis/audapolis), [noScribe](https://github.com/kaixxx/noScribe) an offline transcriber for 99 different languages or [SocioTranscribe](https://framagit.org/justinmponcet/whisper).
145152

146153
Transcriptions may contain timestamps indicating when the text is being pronounced during the video. The following formats are recognised by QualCoder, where SSS are milliseconds:
147154

@@ -188,7 +195,8 @@ Sections of the text file or audio/video transcribed file will have sections of
188195

189196
You can select text that is not underlined and copy/replace without problems. You can click on a position (**without selecting text**) to then type, delete, or paste text. This can occur in underlined (coded, annotated, case-assigned) or not underlined (not coded/annotated/case-assigned) text locations. You will see the underlines shift as text is added or removed.
190197

191-
**There are some limitations: It is best to avoid selecting sections of text to delete (or to type or paste over) if those sections have a combination of not underlined (not coded/annotated/case-assigned) and underlined (coded, annotated, case-assigned). The reason is that the positions of the underlying codes/annotations/case-assigned may not correctly match as intended. If you have made a change that you think has affected these coded/annotated/case-assigned positions badly, exit the text editing window by pressing the Cancel button.**
198+
!!!! "There are some limitations"
199+
There are some limitations: It is best to avoid selecting sections of text to delete (or to type or paste over) if those sections have a combination of not underlined (not coded/annotated/case-assigned) and underlined (coded, annotated, case-assigned). The reason is that the positions of the underlying codes/annotations/case-assigned may not correctly match as intended. If you have made a change that you think has affected these coded/annotated/case-assigned positions badly, exit the text editing window by pressing the Cancel button.
192200

193201
## Example files
194202

0 commit comments

Comments
 (0)