Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/community.md
Original file line number Diff line number Diff line change
Expand Up @@ -95,7 +95,7 @@ You can view the list of translation coordinators on [this page](https://qualcod

---

*Community maintained*
*Community maintained (WIP)*
Translator coordinator: Alberto Antonio Rebonatto Neto

[:octicons-arrow-right-24: Download language file](https://github.com/ccbogel/QualCoder/raw/refs/heads/master/other_languages/pt.zip)
Expand Down
42 changes: 22 additions & 20 deletions docs/doc/en/3.2.-Files.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,20 +51,22 @@ PDF files are not pseudonymised.

"Mark speakers" creates codes for every speaker in an interview or group discussion, and assigns utterances automatically. You can reach it via the file context menu or the following toolbar button:

![grafik](/images/c742fad3-f34b-471d-8794-1919b7f5935d.png)
![image](/images/c742fad3-f34b-471d-8794-1919b7f5935d.png)

[See this section](4.1.-Coding-Text#auto-speaker-codings) for more details.

## General functions {#general-functions}

Filename entries can be changed in the database. The file names of the original files will not be changed. A right-click context menu allows you to view, export, delete a current file. The trashcan button is an option to select multiple files for deletion. The question mark '?' opens this help page. Files can be viewed either by right-click menu on the file, or by clicking the magnifying glass icon. This is where transcripts for audio and video can be entered, when viewing an audio or video file.

![button](/images/f03c0a5d-29ea-40c7-a5a1-917aeb894f9b.png)Bulk rename of all file rows. You provide a prefix and then a numbered suffix is added. This applies to all visible rows in the table. You can pre-select visible rows by right click and 'show this value' for example on an attribute.
### Bulk rename of all file rows.
You provide a prefix and then a numbered suffix is added. This applies to all visible rows in the table. You can pre-select visible rows by right click and 'show this value' for example on an attribute.
This button allows you to bulk rename files:
![button](/images/f03c0a5d-29ea-40c7-a5a1-917aeb894f9b.png)

## Attributes {#attributes}

Attributes are variables to describe the files. These can be added using the (x) button or through the Manage Attributes menu option. They can be character or numeric. The above image shows an added character attribute called _origin_ as well as one of several reference attribute columns _Ref-author_.
Attributes are variables to describe the files. These can be added using the (x) button or through the Manage Attributes menu option. They can be character or numeric. The above image shows an added character attribute called _origin_ as well as one of several reference attribute columns *Ref_author*.

Attributes can be exported to an Excel file via a button: ![image](/images/ccf331d7-63b6-460b-96df-41edd7cfe63b.png)

Expand Down Expand Up @@ -123,20 +125,20 @@ You can select text that is not underlined and copy/replace without problems. Yo

## Audio and Video files {#audio-and-video-files}

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.
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` extension. 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.

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.
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`.

The transcribed text file is created and stored within the database, and can be exported to a text file. The file can be edited.

!!! warning
Important note: The edits occur within the database. An original text file is NOT changed. Transcriptions cannot be linked as an external file.
**Important note**: The edits occur within the database. An original text file is **NOT** changed. Transcriptions cannot be linked as an external file.

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.
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.

![image](/images/221aac54-1907-41a7-95cc-26899250b13a.png)

If you have ffmpeg installed a waveform is shown. If the audio files has multiple audio tracks, only the first track is shown for the waveform.
If you have [ffmpeg](https://ffmpeg.org/) installed a waveform is shown. If the audio files has multiple audio tracks, only the first track is shown for the waveform.

### Transcribing audio and video {#transcribing-audio-and-video}

Expand Down Expand Up @@ -164,27 +166,27 @@ Manually transcribing audio and video is helped with some keyboard shortcuts. Tr

The key shortcuts are:

Ctrl R Rewind 5 seconds
Ctrl+R Rewind 5 seconds

Alt R Alt Minus (release 3.3+) Rewind 30 seconds
Alt+R/Alt+Minus (available in 3.3+) Rewind 30 seconds

Alt F Alt Plus (release 3.3+) Forward 30 seconds
Alt+F/Alt+Plus (available in 3.3+) Forward 30 seconds

Ctrl S or Ctrl P Stop/Start toggle audio/video. From stop to play will rewind 2 seconds.
Ctrl+S or Ctrl+P Stop/Start toggle audio/video. From stop to play will rewind 2 seconds.

Ctrl Shift > Increase play rate up to 2 times
Ctrl+Shift > Increase play rate up to 2 times

Ctrl Shift < Decrease play rate down to 0.1
Ctrl+Shift < Decrease play rate down to 0.1

The above controls are also available from the toolbar icons.

Ctrl T Insert timestamp in this format: [hh.mm.ss]
Ctrl+T Insert timestamp in this format: [hh.mm.ss]

Ctrl + N Add a speaker name. This also pauses the audio/video.
Ctrl+N Add a speaker name. This also pauses the audio/video.

Ctrl D Delete one or more speaker names.
Ctrl+D Delete one or more speaker names.

Ctrl 1 to 8 Insert speaker name in this format: [name]
Ctrl+1 to 8 Insert speaker name in this format: [name]


### Transcriptions that have codes, annotations and / or case-assigned {#transcriptions-that-have-codes-annotations-and-or-case-assigned}
Expand All @@ -193,8 +195,8 @@ Sections of the text file or audio/video transcribed file will have sections of

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.

!!!! "There are some limitations"
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.
!!! warning "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.

## Example files {#example-files}

Expand Down
18 changes: 9 additions & 9 deletions docs/doc/en/4.1.-Coding-Text.md
Original file line number Diff line number Diff line change
Expand Up @@ -140,11 +140,11 @@ It is always best to save a copy of the project before editing the text, to avoi

* A. Annotate selected text

* B. Bookmark the current location in the current text file. Shift B to go to bookmark.
* B. Bookmark the current location in the current text file. Shift+B to go to bookmark.

* C. In text area. Create a category.

* Ctrl E to enter and exit Edit mode.
* Ctrl+E to enter and exit Edit mode.

* H. Hide and show the top section of controls on the screen. This provides a bigger area to view the text and to code.

Expand All @@ -160,19 +160,19 @@ It is always best to save a copy of the project before editing the text, to avoi

* Q. Quick code with the most recent code. (Must have a text selection)

* R. Select Recent codes. (Must have a text selection)
<!-- it had the R key shortcut twice doing the same thing-->

* Ctrl R. Reverse text direction. May be needed for Arabic or other Right to left languages.
* Ctrl+R. Reverse text direction. May be needed for Arabic or other Right to left languages.

* S. Search text.

* R. Opens Recently used codes for marking text.
* R. Opens Recently used codes for marking text (must have text selected).

* U. Unmark one or more codes at a clicked text position. (QC Release 3.4)

* V. Code selected text with a new code made from the selected text. Also called *in vivo* coding.

* Ctrl Z. Restores the last coding that was unmarked.
* Ctrl+Z. Restores the last coding that was unmarked.

## Search text {#search-text}

Expand All @@ -193,7 +193,7 @@ Underneath the codes tree are the buttons: forward, back and a grid icon button
Select a code and then click on the forward and back arrows. These now traverse through the text document showing the selected coded text. All other coded text is hidden. To restore and show all the codes, click on the now coloured grid button.

!!! note
In the 4.0 version, the entire text file is dispayed. In the previous versions e.g. 3.8.2 there was an option to load a text file in chunks of 50,000 characters. If you need to load text in chunks, then we recommend you use the previous [QualCoder version 3.8.2](https://github.com/ccbogel/QualCoder/releases/tag/3.8.2). However note that PDF text loading changed from 3.8.2 to 4.0 which may cause inaccuracy with coding segment positions when opening a newer project (e.g. 4.0) in the older release (3.8.2 or earlier).
In the 4.0 version, the entire text file is dispayed. In the previous versions e.g. 3.8.2 there was an option to load a text file in chunks of 50,000 characters. If you need to load text in chunks, then we recommend you use the previous [QualCoder version 3.8.2](https://github.com/ccbogel/QualCoder/releases/tag/3.8.2). However note that PDF text loading changed from 3.8.2 to 4.0 which may cause inaccuracy with coding segment positions when opening a newer project (e.g. 4.0+) in the older release (3.8.2 or earlier).

## Show only important coded text {#show-only-important-coded-text}

Expand All @@ -205,7 +205,7 @@ Export in odt format - compatible with LibreOffice and Microsoft Word. Either ew

## Right-hand pane {#right-hand-pane}

The right-hand side of the coding text pane has another pane tucked away. To open click and drag from the right-hand side of the window, or press the button next to the Help button. This pane contains options useful when coding. One button is when clicking on a code, the code name, code rule (memo) and random coded text examples from the project are displayed. The other button displays the project memo.
The right-hand side of the coding text pane has another pane tucked away. To open click and drag from the right-hand side of the window, or press the button next to the Help button. This pane contains options useful when coding. One button shows, when clicking on a code, the code name, code rule (memo) and random coded text examples from the project are displayed. The other button displays the project memo.

![image](/images/a6977ba3-bdf2-43c8-9097-562a252af815.png)

Expand All @@ -220,7 +220,7 @@ When entering the edit mode, the entire file is loaded for editing. Other functi

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.

There are some limitations: It is best to avoid selecting sections of text to delete (or to type or paste over). This is particularly an issue if any of those sections have been underlined (coded, annotated, case-assigned). It may also be an The reason is that positions of the underlying codes/annotations/case-assigned may not correctly match as intended.
There are some limitations: It is best to avoid selecting sections of text to delete (or to type or paste over). This is particularly an issue if any of those sections have been underlined (coded, annotated, case-assigned). A possible reason is that 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. Then **before anything else is done** press the undo button (Back arrow) next to the Edit text button.

Expand Down
Loading
Loading