Configuration file
About
A configuration file is an XML file in which you define values for variables you use to conditionalize
and parameterize content in the content file. A configuration file is indicated by a fork-and-knife icon 
.
A publication often contains one configuration file. When publishing the publication, variables in the content file are replaced by the variable values you defined in the configuration file.
You can use the same content file in many publications, where each publication has a unique configuration file. This way, the same variable in the content file is given different values depending on which publication you publish.
Version designation icon 
is shown for the configuration file in the example. See Topic: Viewing the version designation of a folder or file to show/hide the version designation icon.
Figure 1: Example of a configuration file
What you can do
You can do the following tasks on the configuration file:
The tasks you can do depends on your user role.
Viewing the configuration file properties
You can view the properties on the configuration file, such as version, language, create date etc.
Skribenta generates these properties. You cannot change them manually.
It is possible to view the identity (resource ID) of a folder or file.
For instructions, see:
It is possible to view the version designation of a folder or file.
For instructions, see:
It is possible to view the version index of a folder or file.
For instructions, see:
It is possible to view the version state of a folder or file.
For instructions, see:
It is possible to view who created the current version of a folder or file and when it was created.
For instructions, see:
It is possible to view who modified the current version of a folder or file and when it was modified.
For instructions, see:
Setting source language on the configuration file
It is possible to set a language on a file.
For instructions, see:
Renaming the configuration file
It is possible to rename files and folders.
For instructions, see:
Managing versions of the configuration file
The configuration file can be checked in and out. As such, the configuration file gets a version history.
It is possible to check in an individual file, for example when it is approved for release. When the file is checked in, the current file version can not be edited anymore.
For instructions, see:
It is possible to check in all files in a folder at the same time (for example when the files are approved for release) by checking in the folder. Any subfolders with files are also checked in.
When the files are checked in, the current file versions can not be edited anymore.
For instructions, see:
It is possible to check in all files in a workspace at the same time (for example when the files are ready for review) by checking in the workspace. All folders and files in the workspace are checked in.
When the files are checked in, the current file versions can not be edited anymore. The checked-in workspace version (edition) is then possible to select when publishing a publication before sending it for review.
For instructions, see:
It is possible to check out a file or folder (resource) that has previously been checked in. A checked in resource cannot be changed. When you check out a resource, a new version is created and the resource can be edited.
For instructions, see:
If you have a checked out version of a resource (file or folder), it is possible to revert to the previous checked in version of the resource. This means that any changes made in the checked out version are lost.
For instructions, see:
It is possible to lock a file to prevent anyone else from editing the file. Only one user at a time can lock and edit a file. The file is auto saved and unlocked after 1 minute if you do not continue editing the file.
For instructions, see:
It is possible to view the version history tree for a file or folder.
For instructions, see:
It is possible to view the content of a checked in file or folder.
For instructions, see:
Normally, the latest version of a file is set and edited. However, sometimes you may need to set an older version to, for example, make a correction in a previous released manual. This is usually done in a separate workspace to prevent conflicts between versions.
For instructions, see:
Every time a file is saved, a draft version of the file is stored in Skribenta. Normally, the draft versions are stored for a month. It is possible to view the content of a draft file version.
For instructions, see:
It is possible to copy parts of the content in a file version.
For instructions, see:
Every time a file is saved, a draft version of the file is stored in Skribenta. Normally, the draft versions are stored for a month. It is possible to revert to a previously saved draft version.
For instructions, see:
It is possible to compare the content of two consecutive file versions.
For instructions, see:
The file version label, which is for example displayed when viewing the file version tree, can be changed.
For instructions, see:
Cutting and pasting the configuration file
It is possible to modify the structure of the workspace by moving the files and folders.
It is possible to move multiple resources simultaneously.
Moving a resource does not change the resource ID, which means that links to them are not broken. If the resource's parent folders are not working versions, they will be updated to new versions.
For instructions, see:
Copying the configuration file
You can duplicate previously created files and folders by copying them. New resource IDs will be assigned to resource copies.
For instructions, see:
Deleting the configuration file
It is possible to delete files and folders.
For instructions, see:
Moving the configuration file
It is possible to modify the structure of the workspace by moving the files and folders.
It is possible to move multiple resources simultaneously.
Moving a resource does not change the resource ID, which means that links to them are not broken. If the resource's parent folders are not working versions, they will be updated to new versions.
For instructions, see:
Generating a used-by report
It is possible to generate a list of all files that are including and/or linking to your file.
When a file is included in another file, which is used in a publication, the list also shows the publication.
When a file is only linked to from another file, which is used in a publication, the used-by list do not show the publication.
You can also get a list of files using a particular image file.
You can generate a used-by report either from the file itself in the workspace, or from the include, link and image element pointing to a file.
It is possible to generate a list of all files and publications a translation, improvement and extension project is linking to.
A used-by list opens in a new tab. For each listed file in this tab, you can generate a used-by list.
Files in hidden include, link or image element are not shown in the used-by list.
For instructions, see:
Generating an is-using report
It is possible to generate a report of all files that your file are using. The report will show, for example, all files that your file are including.
For instructions, see:
Locate the configuration file in the workspace
The configuration file is located in a folder in the workspace. Skribenta can show you the configuration file in the workspace. Click Location in the configuration file toolbar.
Downloading the configuration file
It is possible to export files and folders to a destination outside Skribenta. A folder is downloaded as a compressed ZIP file.
For instructions, see:
Uploading the configuration file
It is possible to upload external files and folders to Skribenta. To upload a folder and its content, it has to be a compressed ZIP folder.
For instructions, see:
Unlocking the configuration file by force (forced unlock)
It is possible to unlock a file that has been permanently locked.
For instructions, see:
Performing a deep search
It is possible to do a deep search in a file. This means that, besides all content in your file, all nested includes in your file are searched.
For instructions, see:
Searching within the configuration file
It is possible to do a filtered search of content within files in Skribenta. The search will only be done in opened files. When the search in the current file is completed, the search continues in the next opened file.
For instructions, see: