Readable Editor - Revision history

Tels: use templates, link to I18N

2011-08-21T13:20:39Z

use templates, link to I18N

← Older revision		Revision as of 13:20, 21 August 2011
Line 61:		Line 61:
	Some mappers don't use virtual folders in their XData names, e.g. "readables/MyFM/MyReadable". So, to make the browsing of the XData files easier and quicker, you can open the .xd file(s) of the FM in any texteditor and prepend for example "translation/" before any XData name. All readables you have to translate will then be listed in the virtual "translation" folder in the XData browser of the ''Readable Editor''. But if you want to see those translations ingame afterwards, you'll also have to delete that prefix in all those XData names later again or delete it within the ''Readable Editor''. Please note however, that those definitions will be stored under a different filename then, as explained above. This is no problem though, I just wanted to point it out.		Some mappers don't use virtual folders in their XData names, e.g. "readables/MyFM/MyReadable". So, to make the browsing of the XData files easier and quicker, you can open the .xd file(s) of the FM in any texteditor and prepend for example "translation/" before any XData name. All readables you have to translate will then be listed in the virtual "translation" folder in the XData browser of the ''Readable Editor''. But if you want to see those translations ingame afterwards, you'll also have to delete that prefix in all those XData names later again or delete it within the ''Readable Editor''. Please note however, that those definitions will be stored under a different filename then, as explained above. This is no problem though, I just wanted to point it out.

	[[~~Category:Tutorial~~]]		== See also ==
	~~[[Category:Editing]]~~
			* [[I18N\|Internationalization]] - How to sep. FM content and translatable texts

			{{tutorial}}
			{{editing}}

Grayman: /* Advise for pure Translators */

2011-08-19T13:40:34Z

Advise for pure Translators

← Older revision		Revision as of 13:40, 19 August 2011
Line 42:		Line 42:
	If you have any other good ideas, feel free to make a suggestion in the [http://modetwo.net/darkmod/index.php?/forum/54-tdm-editors-guild/ TDM Editors Guild].		If you have any other good ideas, feel free to make a suggestion in the [http://modetwo.net/darkmod/index.php?/forum/54-tdm-editors-guild/ TDM Editors Guild].

	== ~~Advise~~ for pure Translators ==		== Advice for pure Translators ==
	Here are some steps that will make your life easier:		Here are some steps that will make your life easier:
	# '''Creating a .map file and setting up ''Dark Radiant''''':		# '''Creating a .map file and setting up ''Dark Radiant''''':

Stifu: Advise for pure Translators extended

2010-03-12T11:30:37Z

Advise for pure Translators extended

← Older revision		Revision as of 11:30, 12 March 2010
Line 48:		Line 48:
	## Browse to "darkmod/readables" and choose a readable entity to add. It basically doesn't matter which one you pick, but it's always useful to have one that is actually visible.		## Browse to "darkmod/readables" and choose a readable entity to add. It basically doesn't matter which one you pick, but it's always useful to have one that is actually visible.
	## Move the entity directly in front of the camera by draging it on the orthogonal views. You can select an entity be shift+clicking it, deselect by pressing "Escape".		## Move the entity directly in front of the camera by draging it on the orthogonal views. You can select an entity be shift+clicking it, deselect by pressing "Escape".
	## Save the map under a convenient filename like "~~MyAwesomeReadableTranslatingMap~~.map".		## Save the map under a convenient filename like "MyAwesomeReadableTranslationMap.map". You will use this map for all your translations. No need to open the map file of the target FM.
	## Press "P" to bring up the preferences dialog of ''Dark Radiant'', go to "Settings/Map Files" and check "Open last map on startup". Now every time you start your ''Dark Radiant'', your map is loaded and you can directly jump into translating.		## Press "P" to bring up the preferences dialog of ''Dark Radiant'', go to "Settings/Map Files" and check "Open last map on startup". Now every time you start your ''Dark Radiant'', your map is loaded and you can directly jump into translating.
	# '''Making the original Readables available to ''Dark Radiant'' and starting the translation process''':		# '''Making the original Readables available to ''Dark Radiant'' and starting the translation process''':

AluminumHaste: /* Features, Tips and Tricks */

2010-03-11T19:52:03Z

Features, Tips and Tricks

← Older revision		Revision as of 19:52, 11 March 2010
Line 18:		Line 18:

	* '''Appending and prepending pages''': If you're currently editing the first or the last page of your readable and you click on first/previous page respectively last/next page, a small convenient small popup will show up, allowing you to prepend or append a page.		* '''Appending and prepending pages''': If you're currently editing the first or the last page of your readable and you click on first/previous page respectively last/next page, a small convenient small popup will show up, allowing you to prepend or append a page.
	* '''Converting the Page Layout''': No content is discarded when you change the Page Layout of your readable. If you should ~~once feel like~~ the letter you just wrote would be much more suitable as a diary entry, feel free to just convert!		* '''Converting the Page Layout''': No content is discarded when you change the Page Layout of your readable. If you should realize that the letter you just wrote would be much more suitable as a diary entry, feel free to just convert it.
	* '''Choosing Guis''': Just like with XData definitions, you can use one gui per page. You can enter a gui by hand or choose one using the Gui-Browser, which directly previews the selected gui. The browser holds two tabs, one for OneSided- and one for Two-Sided guis. Switching the tab will also change the page layout of your readable and update the preview accordingly.		* '''Choosing Guis''': Just like with XData definitions, you can use one gui per page. You can enter a gui by hand or choose one using the Gui-Browser, which directly previews the selected gui. The browser holds two tabs, one for OneSided- and one for Two-Sided guis. Switching the tab will also change the page layout of your readable and update the preview accordingly.
	* '''Inserting and deleting pages''': When you're writing a Two-sided readable, clicking on either one of these buttons will result in a popup, asking you whether the respective operation should be applied to the left or right side or the whole page.		* '''Inserting and deleting pages''': When you're writing a Two-sided readable, clicking on either one of these buttons will result in a popup, asking you whether the respective operation should be applied to the left or right side or the whole page.

AluminumHaste: /* Features, Tips and Tricks */

2010-03-11T19:51:02Z

Features, Tips and Tricks

← Older revision		Revision as of 19:51, 11 March 2010
Line 15:		Line 15:

	=== Features, Tips and Tricks ===		=== Features, Tips and Tricks ===
	The editing process itself is pretty ~~much~~ straight forward. At this point I would just like to point out a few ~~features, those of which being~~ not so apparent ~~at first~~.		The editing process itself is pretty straight forward. At this point I would just like to point out a few not so apparent features.

	* '''Appending and prepending pages''': If you're currently editing the first or the last page of your readable and you click on first/previous page respectively last/next page, a small convenient small popup will show up, allowing you to prepend or append a page.		* '''Appending and prepending pages''': If you're currently editing the first or the last page of your readable and you click on first/previous page respectively last/next page, a small convenient small popup will show up, allowing you to prepend or append a page.
	* '''Converting the Page Layout''': No content is discarded when you change the Page Layout of your readable. If you should once feel like the letter you just wrote would be much more suitable as a diary entry, feel free to just convert!		* '''Converting the Page Layout''': No content is discarded when you change the Page Layout of your readable. If you should once feel like the letter you just wrote would be much more suitable as a diary entry, feel free to just convert!

AluminumHaste: /* Fine, but where is my new XData Definition stored? */

2010-03-11T19:41:21Z

Fine, but where is my new XData Definition stored?

← Older revision		Revision as of 19:41, 11 March 2010
Line 7:		Line 7:

	=== Fine, but where is my new XData Definition stored? ===		=== Fine, but where is my new XData Definition stored? ===
	The title-bar of the ''Readable Editor'' holds the answer to this question. New XData definitions will be added to an .xd file that is named just like your current map. If you import an existing definition (or again, if you start the Readable Editor on a readable entity already setup with an XData definition) any alterations will be stored in the file the definition originated from. This approach prevents the creation of duplicated XData definitions. As soon as you change the XData Name in the editor ~~- '''this is important''' -~~ a new definition will be created in the file, whose name is again derived from the name of your map.		The title-bar of the ''Readable Editor'' holds the answer to this question. New XData definitions will be added to an .xd file that is named just like your current map. If you import an existing definition (or again, if you start the Readable Editor on a readable entity already setup with an XData definition) any alterations will be stored in the file the definition originated from. This approach prevents the creation of duplicated XData definitions. '''Important: As soon as you change the XData Name in the editor, a new definition will be created in the file, whose name is again derived from the name of your map.'''

	You can specify the storage folder for XData in the Preferences dialog of ''Dark Radiant'' under "Settings/Readable Editor". The pulldown menu offers options to store the files in the "xdata" subfolder of your Mod or Mod Base directory, as well as in a custom folder which can be specified below. Please note that while you can specify any folder you want for exporting, ''Dark Radiant'' and its ''Readable Editor'' can only import XData definitions that are contained in .xd files located somewhere in the "xdata" subfolder of the Base-, Mod- or Mod_Base-directory. Definitions in "base/xdata/myStuff/SomeXData.xd" for example can be found, but not if they are stored in "base/myStuff/SomeXData.xd".		You can specify the storage folder for XData in the Preferences dialog of ''Dark Radiant'' under "Settings/Readable Editor". The pulldown menu offers options to store the files in the "xdata" subfolder of your Mod or Mod Base directory, as well as in a custom folder which can be specified below. Please note that while you can specify any folder you want for exporting, ''Dark Radiant'' and its ''Readable Editor'' can only import XData definitions that are contained in .xd files located somewhere in the "xdata" subfolder of the Base-, Mod- or Mod_Base-directory. Definitions in "base/xdata/myStuff/SomeXData.xd" for example can be found, but not if they are stored in "base/myStuff/SomeXData.xd".

AluminumHaste at 19:39, 11 March 2010

2010-03-11T19:39:41Z

← Older revision		Revision as of 19:39, 11 March 2010
Line 1:		Line 1:
	--[[User:Stifu\|Stifu]] 16:00, 10 March 2010 (UTC)		--[[User:Stifu\|Stifu]] 16:00, 10 March 2010 (UTC)
	[[Image:ReadableEditor.jpg\|300px\|thumb\|right\|The Readable Editor]]The ''Readable Editor'' is a [http://en.wikipedia.org/wiki/What_you_see_is_what_you_get WYSIWYG-Editor] for the readable entities in ''The Dark Mod'' and it is a feature of ''Dark Radiant'' since version 1.2.0 requiring at least version 1.01 of ''The Dark Mod''. Up until now, the workflow for creating readables was tiresome, especially because you had to keep ''Dark Mod'' running in the background in order to be able to check if linebreaks and pagebreaks look alright et cetera. But ~~these~~ days are over, as we decided to provide an easy-to-use graphical user interface for creating such texts.		[[Image:ReadableEditor.jpg\|300px\|thumb\|right\|The Readable Editor]]The ''Readable Editor'' is a [http://en.wikipedia.org/wiki/What_you_see_is_what_you_get WYSIWYG-Editor] for the readable entities in ''The Dark Mod'' and it is a feature of ''Dark Radiant'' since version 1.2.0 requiring at least version 1.01 of ''The Dark Mod''. Up until now, the workflow for creating readables was tiresome, especially because you had to keep ''Dark Mod'' running in the background in order to be able to check if linebreaks and pagebreaks look alright et cetera. But those days are over, as we decided to provide an easy-to-use graphical user interface for creating such texts.

AluminumHaste: /* Is the Preview broken? My Title overlaps with my Body! */

2010-03-11T17:16:16Z

Is the Preview broken? My Title overlaps with my Body!

← Older revision		Revision as of 17:16, 11 March 2010
Line 12:		Line 12:

	=== Is the Preview broken? My Title overlaps with my Body! ===		=== Is the Preview broken? My Title overlaps with my Body! ===
	No, it's not, the preview is very precise. The ~~guis~~ for readables have intentionally been ~~layouted~~ like this to allow writing of continuous texts without titles. You just have to add some line-breaks to your body until it looks right. And since we are talking about presumably faulty previews here, please also note that some titles of ~~guis don't~~ support multiple lines, resulting in some parts of your title not being rendered.		No, it's not, the preview is very precise. The GUIs for readables have intentionally been laid out like this to allow the writing of continuous texts without titles. You just have to add some line-breaks to your body until it looks right. And since we are talking about presumably faulty previews here, please also note that some titles of GUIs do not support multiple lines, resulting in some parts of your title not being rendered.

	=== Features, Tips and Tricks ===		=== Features, Tips and Tricks ===

Stifu at 15:49, 11 March 2010

2010-03-11T15:49:41Z

← Older revision		Revision as of 15:49, 11 March 2010
Line 12:		Line 12:

	=== Is the Preview broken? My Title overlaps with my Body! ===		=== Is the Preview broken? My Title overlaps with my Body! ===
	No, it's not, the preview is very precise. The guis for readables have intentionally been layouted like this to allow writing of continuous texts without titles. You just have to add some line-breaks to your body until it looks right. And since we are talking about ~~the preview~~ here ~~anyway~~, please also note that some titles of guis don't support multiple lines.		No, it's not, the preview is very precise. The guis for readables have intentionally been layouted like this to allow writing of continuous texts without titles. You just have to add some line-breaks to your body until it looks right. And since we are talking about presumably faulty previews here, please also note that some titles of guis don't support multiple lines, resulting in some parts of your title not being rendered.

	=== Features, Tips and Tricks ===		=== Features, Tips and Tricks ===

Stifu: Added passage about titles overlapping bodies.

2010-03-11T15:46:34Z

Added passage about titles overlapping bodies.

← Older revision		Revision as of 15:46, 11 March 2010
Line 9:		Line 9:
	The title-bar of the ''Readable Editor'' holds the answer to this question. New XData definitions will be added to an .xd file that is named just like your current map. If you import an existing definition (or again, if you start the Readable Editor on a readable entity already setup with an XData definition) any alterations will be stored in the file the definition originated from. This approach prevents the creation of duplicated XData definitions. As soon as you change the XData Name in the editor - '''this is important''' - a new definition will be created in the file, whose name is again derived from the name of your map.		The title-bar of the ''Readable Editor'' holds the answer to this question. New XData definitions will be added to an .xd file that is named just like your current map. If you import an existing definition (or again, if you start the Readable Editor on a readable entity already setup with an XData definition) any alterations will be stored in the file the definition originated from. This approach prevents the creation of duplicated XData definitions. As soon as you change the XData Name in the editor - '''this is important''' - a new definition will be created in the file, whose name is again derived from the name of your map.

	You can specify the storage folder for XData in the Preferences dialog of ''Dark Radiant'' under "Settings/Readable Editor". The pulldown menu offers options to store the files in the "xdata" subfolder of your Mod or Mod Base directory, as well as in a custom folder which can be specified below. Please note that while you can specify any folder you want for exporting, ''Dark Radiant'' and its ''Readable Editor'' can only import XData definitions that are contained in .xd files located somewhere in the "xdata" subfolder of the Base-, Mod- or Mod_Base-directory. Definitions in "base/xdata/myStuff/SomeXData.xd" for example can be found, but not if they are stored in "base/myStuff/SomeXData.xd" .		You can specify the storage folder for XData in the Preferences dialog of ''Dark Radiant'' under "Settings/Readable Editor". The pulldown menu offers options to store the files in the "xdata" subfolder of your Mod or Mod Base directory, as well as in a custom folder which can be specified below. Please note that while you can specify any folder you want for exporting, ''Dark Radiant'' and its ''Readable Editor'' can only import XData definitions that are contained in .xd files located somewhere in the "xdata" subfolder of the Base-, Mod- or Mod_Base-directory. Definitions in "base/xdata/myStuff/SomeXData.xd" for example can be found, but not if they are stored in "base/myStuff/SomeXData.xd".

			=== Is the Preview broken? My Title overlaps with my Body! ===
			No, it's not, the preview is very precise. The guis for readables have intentionally been layouted like this to allow writing of continuous texts without titles. You just have to add some line-breaks to your body until it looks right. And since we are talking about the preview here anyway, please also note that some titles of guis don't support multiple lines.

	=== Features, Tips and Tricks ===		=== Features, Tips and Tricks ===