DITA Project Configuration - Revision history

Olibouban: /* Resource File Configuration */

2023-12-28T16:09:57Z

Resource File Configuration

← Older revision		Revision as of 16:09, 28 December 2023
Line 39:		Line 39:
	= Resource File Configuration =		= Resource File Configuration =

	Configure the project with the source locale, target locales~~, pseudo-locale if necessary~~ and use customer resource file format for the .dita and .ditmap:		Configure the project with the source locale and target locales and use customer resource file format for the .dita and .ditmap:

	[[File:DITA Resource File Format.png \| 800px]]		[[File:DITA Resource File Format.png \| 800px]]
Line 48:		Line 48:
	Run the project.		Run the project.

	Now add the transform configured above.		Now add the transform configured above and add the pseudo-locale is necessary.

	Run the project again and verify the configuration.		Run the project again and verify the configuration.

	The rest of the DITA configuration is the same as for any other projects.		The rest of the DITA configuration is the same as for any other projects.

Olibouban: /* Illustrative DITA Sample, "Spectrum" */

2023-12-28T16:01:46Z

Illustrative DITA Sample, "Spectrum"

← Older revision		Revision as of 16:01, 28 December 2023
Line 18:		Line 18:
	An illustrative simple example is used to guide the on-boarding. Actual DITA repositories will follow most of the same on-boarding.		An illustrative simple example is used to guide the on-boarding. Actual DITA repositories will follow most of the same on-boarding.

	1. In the repository, the directory under which the locale directories are located is <code>dita/Spectrum</code>		* In the repository, the directory under which the locale directories are located is <code>dita/Spectrum</code>
	2. Under <code>dita/Spectrum</code>, the source locale is <code>en</code> for United States English		* Under <code>dita/Spectrum</code>, the source locale is <code>en</code> for United States English
	3. Under <code>dita/Spectrum/en</code> is the full directory structure for the DITA files. Path to actual .dita and .ditamap can be deep.		* Under <code>dita/Spectrum/en</code> is the full directory structure for the DITA files. Path to actual .dita and .ditamap can be deep.
	4. Translation will be located under <code>dita/Spectrum/fr-FR</code> for France French		* Translation will be located under <code>dita/Spectrum/fr-FR</code> for France French
	5. Pseudo-localization will be located under <code>dita/Spectrum/eo</code> for Esperanto		* Pseudo-localization will be located under <code>dita/Spectrum/eo</code> for Esperanto

	= Create a DITA Transform System File =		= Create a DITA Transform System File =

Olibouban at 16:01, 28 December 2023

2023-12-28T16:01:21Z

← Older revision		Revision as of 16:01, 28 December 2023
Line 7:		Line 7:
	* See: https://www.oxygenxml.com/dita/1.3/specs/archSpec/base/introduction-to-dita.html		* See: https://www.oxygenxml.com/dita/1.3/specs/archSpec/base/introduction-to-dita.html

	DITA uses certain file extensions for topics, maps, and conditional processing profiles. Files that contain DITA content ~~SHOULD~~ use the following file extensions:		DITA uses certain file extensions for topics, maps, and conditional processing profiles. Files that contain DITA content must use the following file extensions:

	* DITA topics		* DITA topics: .dita
	** .dita ~~(preferred)~~		* DITA maps: .ditamap

	* DITA maps
	**.ditamap

	For the purpose of Localyzer on-boarding, the source locale and target locales make up sibling directories under one DITA root. The file structure and files under each locale directory are the same, with .dita and/or .ditamap translated under each target directory.		For the purpose of Localyzer on-boarding, the source locale and target locales make up sibling directories under one DITA root. The file structure and files under each locale directory are the same, with .dita and/or .ditamap translated under each target directory.

Olibouban at 16:00, 28 December 2023

2023-12-28T16:00:42Z

← Older revision		Revision as of 16:00, 28 December 2023
Line 47:		Line 47:

	Note:		Note:
	Make sure to use the <code>file location pattern</code> with the right '-' (dash) or '_' (underscore) depending on the directory naming convention. Here, the targets are '~~fr-FR~~' and 'de-DE', hence the '-' in the <code>l-c-v</code> file name pattern, for both <code>All locales</code>		Make sure to use the <code>file location pattern</code> with the right '-' (dash) or '_' (underscore) depending on the directory naming convention. Here, the targets are 'de' and 'fr-FR', hence the '-' in the <code>l-c-v</code> file name pattern, for both <code>All locales</code>

	Run the project.		Run the project.

Olibouban: /* Resource File Configuration */

2023-12-28T15:59:47Z

Resource File Configuration

← Older revision		Revision as of 15:59, 28 December 2023
Line 44:		Line 44:
	Configure the project with the source locale, target locales, pseudo-locale if necessary and use customer resource file format for the .dita and .ditmap:		Configure the project with the source locale, target locales, pseudo-locale if necessary and use customer resource file format for the .dita and .ditmap:

	[[File:DITA Resource File Format.png \| ~~600px~~]]		[[File:DITA Resource File Format.png \| 800px]]

	Note:		Note:

Olibouban: /* Resource File Configuration */

2023-12-28T15:59:20Z

Resource File Configuration

← Older revision		Revision as of 15:59, 28 December 2023
Line 41:		Line 41:

	= Resource File Configuration =		= Resource File Configuration =

			Configure the project with the source locale, target locales, pseudo-locale if necessary and use customer resource file format for the .dita and .ditmap:

	[[File:DITA Resource File Format.png \| 600px]]		[[File:DITA Resource File Format.png \| 600px]]

			Note:
			Make sure to use the <code>file location pattern</code> with the right '-' (dash) or '_' (underscore) depending on the directory naming convention. Here, the targets are 'fr-FR' and 'de-DE', hence the '-' in the <code>l-c-v</code> file name pattern, for both <code>All locales</code>

			Run the project.

			Now add the transform configured above.

			Run the project again and verify the configuration.

			The rest of the DITA configuration is the same as for any other projects.

Olibouban: /* Create a DITA Transform System File */

2023-12-28T15:54:48Z

Create a DITA Transform System File

← Older revision		Revision as of 15:54, 28 December 2023
Line 28:		Line 28:

	= Create a DITA Transform System File =		= Create a DITA Transform System File =
	Copy the transform from		Copy the transform from <code>https://github.com/Lingoport/CommandCenterConfig branch main</code> into your own repository and change the configuration file, 'dita_properties.sh' to point to the directory to start from, here <code>dita/Spectrum</code>
	* https://github.com/Lingoport/CommandCenterConfig
	* main

	into your own repository and change the configuration file, 'dita_properties.sh' to point to the directory to start from, here <code>dita/Spectrum</code>
	* DITA_DIR="dita/Spectrum"		* DITA_DIR="dita/Spectrum"

Line 41:		Line 37:

	It should look close to the following:		It should look close to the following:

	[[File:DITA Transform System File.png\|300px]]		[[File:DITA Transform System File.png\|300px]]

Olibouban: /* Create a DITA Transform System File */

2023-12-28T15:53:41Z

Create a DITA Transform System File

← Older revision		Revision as of 15:53, 28 December 2023
Line 41:		Line 41:

	It should look close to the following:		It should look close to the following:
	[[File:DITA Transform System File.png\|~~center~~\|~~300px~~]]		[[File:DITA Transform System File.png\|300px]]

			= Resource File Configuration =

			[[File:DITA Resource File Format.png \| 600px]]

Olibouban: /* Create a DITA Transform System File */

2023-12-28T15:48:31Z

Create a DITA Transform System File

← Older revision		Revision as of 15:48, 28 December 2023
Line 28:		Line 28:

	= Create a DITA Transform System File =		= Create a DITA Transform System File =
	As ~~Adminitrator~~, go to Settings, and add a Transform directory:		Copy the transform from
	*		* https://github.com/Lingoport/CommandCenterConfig
	*		* main
	*
			into your own repository and change the configuration file, 'dita_properties.sh' to point to the directory to start from, here <code>dita/Spectrum</code>
			* DITA_DIR="dita/Spectrum"

			As Administrator, go to Settings, and add a Transform directory, using the following:
			* <your repository with the configured <code>dita_properties.sh</code>
			* <your branch>


	It should look close to the following:		It should look close to the following:
	[[File:DITA Transform System File.png\|center\|300px]]		[[File:DITA Transform System File.png\|center\|300px]]

Olibouban: /* Create a DITA Transform System File */

2023-12-28T15:39:43Z

Create a DITA Transform System File

← Older revision		Revision as of 15:39, 28 December 2023
Line 28:		Line 28:

	= Create a DITA Transform System File =		= Create a DITA Transform System File =
			As Adminitrator, go to Settings, and add a Transform directory:
			*
			*
			*

			It should look close to the following:
			[[File:DITA Transform System File.png\|center\|300px]]