The following guide describes the typical use case for Kvalikirstu2.
Open the help manual on the left for more information.
- The study folder must include a subfolder called 'data', that includes the study files.
- The study folder must also include metadata information for the study.
2. Modify the Format of the Study Files
Renaming Data Files
- Rename files -> Rename files to 'dafxxxx'
- Renames data files with a uniform naming scheme based on the metadata information for the study (for example text files are named as daFxxxx_01.txt, daFxxxx_02.txt etc.).
Adding Language Codes to Filenames
- Rename files -> Rename with lang codes
- Opens a window for marking the language of each file. The command then adds the corresponding language codes to the filenames.
File Conversion
- TXT encoding - converts text file encoding to default encoding
- TXT/UTF-8 - converts all supported files to text files with UTF-8 encoding
- ODT/UTF-8 - converts all supported files to ODT
Generating Citation Requirement
- Add text -> Generate citation requirement
- Adds a citation requirement in front of all data files.
Adding Free Text
- Add text -> Add free text
- Adds free text in front of every data file. You can for example add headers to files if they are missing.
Search and Replace Text
- Add text -> Replace text
- Searches for the input in "Original text" field and replaces all occurences in all files with the input in "New text" field.
Creating a Header List
- Select this feature to add headers for your study if the study consist of files other than text files.
- Note that this feature is currently not intended to be used with mixed studies.
Editing Background Information Headers and Values
- Save -> Save changes to daF
- After selecting the study the program lists headers that were detected from the data files or a header list.
- Header editing mode is activated by double-clicking a row. Changes are saved by pressing enter or clicking outside of the row.
- Background information values can be edited by selecting a row and pressing the 'Background information' button on the left toolbar.
- Changes are not automatically written to file, rather changes only show up in the index by default. If you want the headers to be changed in the data files, press Save changes to daF.
Saving changes without writing to data files
- Save -> Save changes
- Use this feature if you want to save changes without writing them to data files. The changes are saved to temporary files.
Headers in the Index
- Left toolbar -> Select headers
- Select one or more rows from the header list and set a type with "Select headers".
- A header has four possible types:
- Show: The row is a header and is shown in the index. This is the default type.
- Hide: The row is a header but it won't be displayed in the index.
- Not header: The row is not a header and was mistakenly detected as one.
- daF header: This header contains the path of each data file. This is not necessary if there is no data files in formats such as pdf or image formats.
- Not header-marked rows can be hidden/shown with the Show/Hide non-headers buttons. This toggle has no effect in the index file, as these rows are never displayed in the index.
Index file table formatting
- Column text alignment
- Left toolbar -> Align
- Select one or more rows and set the alignment with the "Align" button. All text in the columns with the selected headers will be aligned in the index according to the selected setting.
- Column order
- Left toolbar -> Column ordering
- Enable or disable column ordering with the "Column ordering" button. (Off by default)
- The order of the headers can be changed by selecting a header row and moving it using the arrow keys. Columns will be displayed in the same order in the index as the corresponding headers are in the list.
Built-in Headers
- Grey headers are built-in headers automatically generated by the program that are not study specific(for example daF or Folder). Their order and visibility in the index can be modified, but their values cannot be edited. These headers can be hidden from the list using the controls on the left.
Index Language
- Index language button can be used to select the language for the index.
Generate / Update Index
- Generate index button starts generating the index
- Temporary files are generated along with generating the index. There can be errors in the temporary files that must be corrected by the user. See more information in section Error recovery.
Open Index
- You can open the generatex index with the button Open index.
- Repeat steps 3-4 until you are satisfied with the result.
- Kvalikirstu2 makes backups from the study and temporary files into the backup folder. If you want to revert changes to any files, you can restore from backup.
- Selecting Restore backup opens a list of backups with corresponding timestamps. Choose the timestamp to restore to and press Restore.
- The backup folder can be deleted when you no longer need the backups.
6. Packaging the Index
-
The temp folder and backup folder can be deleted from the study before sending it. After this you can zip the folder and it should work on anyone else's computer.