XmlTools - Revision history

Iritscen: using hatnote template

2022-07-02T21:52:16Z

using hatnote template

← Older revision		Revision as of 21:52, 2 July 2022
Line 1:		Line 1:
	~~:''~~This documentation uses many technical [[~~wikipedia~~:XML\|XML]]-related expressions such as: element, parent element, node, attribute. Therefore it is highly recommended that you have a basic background in XML before using XmlTools or reading its documentation. You'll find a good quick tutorial to familiarize yourself with these terms and XML itself [https://www.w3schools.com/xml/xml_whatis.asp on this page].''		{{Hatnote\|This documentation uses many technical [[wp:XML\|XML]]-related expressions such as: element, parent element, node, attribute. Therefore it is highly recommended that you have a basic background in XML before using XmlTools or reading its documentation. You'll find a good quick tutorial to familiarize yourself with these terms and XML itself [https://www.w3schools.com/xml/xml_whatis.asp on this page].}}
			XmlTools is a command-line modding tool developed by [[User:Script 10k\|s10k]] to operate on XML files, especially those exported by [[OniSplit#XML\|OniSplit]]. It supports many basic operations, and allows more complex programmable operations through [[wp:JavaScript\|JavaScript]]. It is written in C++, works in both macOS and Windows, and is currently very efficient in terms of performance.
	XmlTools is a command-line modding tool developed by [[User:Script 10k\|s10k]] to operate on XML files, especially those exported by [[OniSplit#XML\|OniSplit]]. It supports many basic operations, and allows more complex programmable operations through [[~~wikipedia~~:JavaScript\|JavaScript]]. It is written in C++, works in both macOS and Windows, and is currently very efficient in terms of performance.

	The initial version was written to help with the development of the Old China level mod and was written in C# previous to v2.0, but later was rewritten in C++ for performance and cross-platform reasons. It was then developed further for the purposes of the [[AE]] so that resources could be patched smartly.		The initial version was written to help with the development of the Old China level mod and was written in C# previous to v2.0, but later was rewritten in C++ for performance and cross-platform reasons. It was then developed further for the purposes of the [[AE]] so that resources could be patched smartly.
Line 116:		Line 115:

	==Patch file operations==		==Patch file operations==
	Patch files are primarily used to create a list of commands within one file that you can pass to XmlTools to execute all at once, to insert blocks of XML into existing nodes, and to use ~~[[wikipedia:~~JavaScript~~\|JavaScript]]~~ code to modify the XML.		Patch files are primarily used to create a list of commands within one file that you can pass to XmlTools to execute all at once, to insert blocks of XML into existing nodes, and to use JavaScript code to modify the XML.

	To make a patch, create a plain-text file that uses the following commands and pass it to XmlTools using the <tt>patchfile</tt> command documented above. See [[Making a patch mod\|HERE]] for instructions on making a patch mod package for the AE and [[Anniversary Edition/Framework#Installation\|HERE]] to learn how the [[AEI]] handles patch mods.		To make a patch, create a plain-text file that uses the following commands and pass it to XmlTools using the <tt>patchfile</tt> command documented above. See [[Making a patch mod\|HERE]] for instructions on making a patch mod package for the AE and [[Anniversary Edition/Framework#Installation\|HERE]] to learn how the [[AEI]] handles patch mods.
Line 138:		Line 137:

	<tt>[[XmlTools/Full_documentation#.40CUSTOM_CODE\|@CUSTOM_CODE]]</tt>		<tt>[[XmlTools/Full_documentation#.40CUSTOM_CODE\|@CUSTOM_CODE]]</tt>
	:Executes the following ~~[[wikipedia:~~JavaScript~~\|JavaScript]]~~ code for the purpose of editing the XML. If you are creating a patch mod for the AE, <u>you should try to avoid this operation as much as possible</u> because it is much slower than the native XmlTools commands.		:Executes the following JavaScript code for the purpose of editing the XML. If you are creating a patch mod for the AE, <u>you should try to avoid this operation as much as possible</u> because it is much slower than the native XmlTools commands.

	===Command options===		===Command options===

Iritscen: link fixes

2021-04-05T01:52:48Z

link fixes

← Older revision		Revision as of 01:52, 5 April 2021
Line 118:		Line 118:
	Patch files are primarily used to create a list of commands within one file that you can pass to XmlTools to execute all at once, to insert blocks of XML into existing nodes, and to use [[wikipedia:JavaScript\|JavaScript]] code to modify the XML.		Patch files are primarily used to create a list of commands within one file that you can pass to XmlTools to execute all at once, to insert blocks of XML into existing nodes, and to use [[wikipedia:JavaScript\|JavaScript]] code to modify the XML.

	To make a patch, create a plain-text file that uses the following commands and pass it to XmlTools using the <tt>patchfile</tt> command documented above. See [[Making a patch mod\|HERE]] for instructions on making a patch mod package for the AE and [[Anniversary Edition/Framework#~~XML patching~~\|HERE]] to learn how the [[AEI]] handles patch mods.		To make a patch, create a plain-text file that uses the following commands and pass it to XmlTools using the <tt>patchfile</tt> command documented above. See [[Making a patch mod\|HERE]] for instructions on making a patch mod package for the AE and [[Anniversary Edition/Framework#Installation\|HERE]] to learn how the [[AEI]] handles patch mods.

	Comments in patch files begin with a '#'.		Comments in patch files begin with a '#'.
Line 138:		Line 138:

	<tt>[[XmlTools/Full_documentation#.40CUSTOM_CODE\|@CUSTOM_CODE]]</tt>		<tt>[[XmlTools/Full_documentation#.40CUSTOM_CODE\|@CUSTOM_CODE]]</tt>
	:Executes the following [[wikipedia:JavaScript\|JavaScript]] code for the purpose of editing the XML. If you are creating a ~~[[Anniversary_Edition/Framework#XML_patching\|~~patch mod]] for the AE, <u>you should try to avoid this operation as much as possible</u> because it is much slower than the native XmlTools commands.		:Executes the following [[wikipedia:JavaScript\|JavaScript]] code for the purpose of editing the XML. If you are creating a patch mod for the AE, <u>you should try to avoid this operation as much as possible</u> because it is much slower than the native XmlTools commands.

	===Command options===		===Command options===

ValBot: changing link from http->https

2021-02-07T02:53:42Z

changing link from http->https

← Older revision		Revision as of 02:53, 7 February 2021
Line 1:		Line 1:
	:''This documentation uses many technical [[wikipedia:XML\|XML]]-related expressions such as: element, parent element, node, attribute. Therefore it is highly recommended that you have a basic background in XML before using XmlTools or reading its documentation. You'll find a good quick tutorial to familiarize yourself with these terms and XML itself [~~http~~://www.w3schools.com/xml/xml_whatis.asp on this page].''		:''This documentation uses many technical [[wikipedia:XML\|XML]]-related expressions such as: element, parent element, node, attribute. Therefore it is highly recommended that you have a basic background in XML before using XmlTools or reading its documentation. You'll find a good quick tutorial to familiarize yourself with these terms and XML itself [https://www.w3schools.com/xml/xml_whatis.asp on this page].''

	XmlTools is a command-line modding tool developed by [[User:Script 10k\|s10k]] to operate on XML files, especially those exported by [[OniSplit#XML\|OniSplit]]. It supports many basic operations, and allows more complex programmable operations through [[wikipedia:JavaScript\|JavaScript]]. It is written in C++, works in both macOS and Windows, and is currently very efficient in terms of performance.		XmlTools is a command-line modding tool developed by [[User:Script 10k\|s10k]] to operate on XML files, especially those exported by [[OniSplit#XML\|OniSplit]]. It supports many basic operations, and allows more complex programmable operations through [[wikipedia:JavaScript\|JavaScript]]. It is written in C++, works in both macOS and Windows, and is currently very efficient in terms of performance.

ValBot: changing link from http->https

2021-02-07T02:53:29Z

changing link from http->https

← Older revision		Revision as of 02:53, 7 February 2021
Line 46:		Line 46:
	\|<span style="background:rgb(175,175,255); border-radius:0.33em;">'''Option'''</span>\|\|The command to perform. Note that commands are prefaced by a <tt>--</tt>; some commands also have a short version which is composed of a single <tt>-</tt> followed by a letter.		\|<span style="background:rgb(175,175,255); border-radius:0.33em;">'''Option'''</span>\|\|The command to perform. Note that commands are prefaced by a <tt>--</tt>; some commands also have a short version which is composed of a single <tt>-</tt> followed by a letter.
	\|-		\|-
	\|<span style="background:rgb(156,255,156); border-radius:0.33em;">'''Option Value'''</span>\|\|This is where you supply the value that this specific command needs. As seen below, '''--element-name''' requires the XML element name, so we provide that here. Quotes should be used when the value has spaces or to avoid [~~http~~://tldp.org/LDP/Bash-Beginners-Guide/html/sect_03_04.html Unix shell expansion].		\|<span style="background:rgb(156,255,156); border-radius:0.33em;">'''Option Value'''</span>\|\|This is where you supply the value that this specific command needs. As seen below, '''--element-name''' requires the XML element name, so we provide that here. Quotes should be used when the value has spaces or to avoid [https://tldp.org/LDP/Bash-Beginners-Guide/html/sect_03_04.html Unix shell expansion].
	\|- valign="top"		\|- valign="top"
	\|}		\|}

Iritscen: link fix

2020-08-20T14:20:53Z

link fix

← Older revision		Revision as of 14:20, 20 August 2020
Line 107:		Line 107:

	<tt>-x, --xpath-expression <xpath-expression></tt>		<tt>-x, --xpath-expression <xpath-expression></tt>
	:[~~http~~://www.w3.org/TR/xpath/ XPath 1.0] expression (used as filter)		:[https://www.w3.org/TR/1999/REC-xpath-19991116/ XPath 1.0] expression (used as filter)

	<tt>--no-backups</tt>		<tt>--no-backups</tt>

Iritscen: link fixes

2020-03-21T00:13:13Z

link fixes

← Older revision		Revision as of 00:13, 21 March 2020
Line 141:		Line 141:

	===Command options===		===Command options===
	The values supplied for the following options must <u>always</u> be inside quotes (""). The option names use [http://c2.com/~~cgi/wiki~~?PascalCase Pascal case].		The values supplied for the following options must <u>always</u> be inside quotes (""). The option names use [http://wiki.c2.com/?PascalCase Pascal case].

	<tt>Files</tt>		<tt>Files</tt>
	:[~~http~~://www.computerhope.com/jargon/w/wildcard.htm Wildcard] that matches the file(s) that you want to edit		:[https://www.computerhope.com/jargon/w/wildcard.htm Wildcard] that matches the file(s) that you want to edit

	<tt>ElementName</tt>		<tt>ElementName</tt>

Script 10k: english fix?

2016-10-13T11:08:59Z

english fix?

← Older revision		Revision as of 11:08, 13 October 2016
Line 1:		Line 1:
	:''This documentation uses many technical [[wikipedia:XML\|XML]]-related expressions such as: element, parent element, node, attribute. ~~Because of this,~~ it is highly recommended that you have a basic background in XML before using XmlTools or reading its documentation. You'll find a good quick tutorial to familiarize yourself with these terms and XML itself [http://www.w3schools.com/xml/xml_whatis.asp on this page].''		:''This documentation uses many technical [[wikipedia:XML\|XML]]-related expressions such as: element, parent element, node, attribute. Therefore it is highly recommended that you have a basic background in XML before using XmlTools or reading its documentation. You'll find a good quick tutorial to familiarize yourself with these terms and XML itself [http://www.w3schools.com/xml/xml_whatis.asp on this page].''

	XmlTools is a command-line modding tool developed by [[User:Script 10k\|s10k]] to operate on XML files, especially those exported by [[OniSplit#XML\|OniSplit]]. It supports many basic operations, and allows more complex programmable operations through [[wikipedia:JavaScript\|JavaScript]]. It is written in C++, works in both macOS and Windows, and is currently very efficient in terms of performance.		XmlTools is a command-line modding tool developed by [[User:Script 10k\|s10k]] to operate on XML files, especially those exported by [[OniSplit#XML\|OniSplit]]. It supports many basic operations, and allows more complex programmable operations through [[wikipedia:JavaScript\|JavaScript]]. It is written in C++, works in both macOS and Windows, and is currently very efficient in terms of performance.

Iritscen: Mac OS X -> macOS

2016-10-11T00:43:24Z

Mac OS X -> macOS

← Older revision		Revision as of 00:43, 11 October 2016
Line 1:		Line 1:
	:''This documentation uses many technical [[wikipedia:XML\|XML]]-related expressions such as: element, parent element, node, attribute. Because of this, it is highly recommended that you have a basic background in XML before using XmlTools or reading its documentation. You'll find a good quick tutorial to familiarize yourself with these terms and XML itself [http://www.w3schools.com/xml/xml_whatis.asp on this page].''		:''This documentation uses many technical [[wikipedia:XML\|XML]]-related expressions such as: element, parent element, node, attribute. Because of this, it is highly recommended that you have a basic background in XML before using XmlTools or reading its documentation. You'll find a good quick tutorial to familiarize yourself with these terms and XML itself [http://www.w3schools.com/xml/xml_whatis.asp on this page].''

	XmlTools is a command-line modding tool developed by [[User:Script 10k\|s10k]] to operate on XML files, especially those exported by [[OniSplit#XML\|OniSplit]]. It supports many basic operations, and allows more complex programmable operations through [[wikipedia:JavaScript\|JavaScript]]. It is written in C++, works in both ~~Mac OS X~~ and Windows, and is currently very efficient in terms of performance.		XmlTools is a command-line modding tool developed by [[User:Script 10k\|s10k]] to operate on XML files, especially those exported by [[OniSplit#XML\|OniSplit]]. It supports many basic operations, and allows more complex programmable operations through [[wikipedia:JavaScript\|JavaScript]]. It is written in C++, works in both macOS and Windows, and is currently very efficient in terms of performance.

	The initial version was written to help with the development of the Old China level mod and was written in C# previous to v2.0, but later was rewritten in C++ for performance and cross-platform reasons. It was then developed further for the purposes of the [[AE]] so that resources could be patched smartly.		The initial version was written to help with the development of the Old China level mod and was written in C# previous to v2.0, but later was rewritten in C++ for performance and cross-platform reasons. It was then developed further for the purposes of the [[AE]] so that resources could be patched smartly.

Iritscen: grammar edit and some wiki touch-up

2016-03-16T03:38:11Z

grammar edit and some wiki touch-up

Show changes

Iritscen: /* Features */ typo

2016-01-27T17:34:59Z

Features: typo

← Older revision		Revision as of 17:34, 27 January 2016
Line 25:		Line 25:
	*'''Add new values to a set of XML elements''' (e.g., add the 'unkillable' flag to some characters in a level).		*'''Add new values to a set of XML elements''' (e.g., add the 'unkillable' flag to some characters in a level).
	*'''Remove values from a set of XML elements''' (e.g., remove boss shields from characters in a level).		*'''Remove values from a set of XML elements''' (e.g., remove boss shields from characters in a level).
	*'''Replace values in a set XML elements''' (e.g., increase the health of characters by replacing the old HP value).		*'''Replace values in a set of XML elements''' (e.g., increase the health of characters by replacing the old HP value).
	*'''Patch file support''' that allows the modder to list multiple commands in a file, to all be performed at once.		*'''Patch file support''' that allows the modder to list multiple commands in a file, to all be performed at once.
	*'''Add new XML inside existing nodes''' (patch only).		*'''Add new XML inside existing nodes''' (patch only).