Text formatting - Revision history

imported>LassiPulkkinen: /* Content fields */

2024-03-13T23:04:36Z

Content fields

← Older revision		Revision as of 23:04, 13 March 2024
Line 19:		Line 19:
	These fields specify the component's content.		These fields specify the component's content.

	The full content of a component consists of its direct content, immediately followed by the full contents of all its child components concatenated in order. A component's styling affects both its direct content and children, but child components may ~~explicitly~~ override parts or all of it.		The full content of a component consists of its direct content, immediately followed by the full contents of all its child components concatenated in order. A component's styling affects both its direct content and children, but child components may locally override parts or all of it.

	;<code>type</code>		;<code>type</code>

imported>LassiPulkkinen: /* Content fields */ Make less obtuse.

2024-03-13T23:02:05Z

Content fields: Make less obtuse.

← Older revision		Revision as of 23:02, 13 March 2024
Line 19:		Line 19:
	These fields specify the component's content.		These fields specify the component's content.

	The full content of ~~the~~ component ~~is the concatenation~~ of its direct content, ~~to which the component's styling directly applies, and~~ the full contents of all its child components~~, which inherit~~ styling ~~from their parent~~, ~~in that order~~.		The full content of a component consists of its direct content, immediately followed by the full contents of all its child components concatenated in order. A component's styling affects both its direct content and children, but child components may explicitly override parts or all of it.

	;<code>type</code>		;<code>type</code>
	:''Optional String''. The ~~content~~ type ~~of this component, specifying what kind~~ of direct content ~~it includes~~. If omitted, each of the content types is tried in the listed order until one for which the component is valid is found.		:''Optional String''. The type of direct content the component contains. If omitted, each of the content types is tried in the listed order until one for which the component is valid is found.
	;<code>extra</code>		;<code>extra</code>
	:''Optional Array of Text Component''. The child components of ~~this~~ component. If present, cannot be empty. Somewhat confusingly, these may also be thought of as siblings to the direct content of their parent component.		:''Optional Array of Text Component''. The child components of the component. If present, cannot be empty. Somewhat confusingly, these may also be thought of as siblings to the direct content of their parent component.

	Additionally, the component must contain the fields of its content type (refer to the table below).		Additionally, the component must contain the fields of its content type (refer to the table below).

imported>LassiPulkkinen: /* Translatable content */ Use `.`

2024-03-13T22:43:46Z

Translatable content: Use <var>.

← Older revision		Revision as of 22:43, 13 March 2024
Line 121:		Line 121:
	:''Optional Array of Text Component''. Replacements for placeholders in the translation text.		:''Optional Array of Text Component''. Replacements for placeholders in the translation text.

	The translation text may contain any number of the placeholder tokens <code>%s</code>, <code>%''n''$s</code> (where ''n'' is a one-based index) and <code>%%</code>.		The translation text may contain any number of the placeholder tokens <code>%s</code>, <code>%<var>n</var>$s</code> (where <var>n</var> is a one-based index) and <code>%%</code>.

	Each <code>%s</code> is replaced by the element of <code>with</code> corresponding to the placeholder's index among all <code>%s</code>'s (excluding <code>%''n''$s</code>) in the string.		Each <code>%s</code> is replaced by the element of <code>with</code> corresponding to the placeholder's index among all <code>%s</code>'s (excluding <code>%<var>n</var>$s</code>) in the string.

	Each <code>%''n''$s</code> is replaced by the ''n''th element of <code>with</code>.		Each <code>%<var>n</var>$s</code> is replaced by the <var>n</var>th element of <code>with</code>.

	Each <code>%%</code> is replaced by a literal % symbol.		Each <code>%%</code> is replaced by a literal % symbol.

imported>LassiPulkkinen: /* Styling fields */ s/JSON chat/over the network/g, since that's what it meant in this case. Should these inaccessible implementation details even be documented here, though?

2024-03-13T22:40:03Z

Styling fields: s/JSON chat/over the network/g, since that's what it meant in this case. Should these inaccessible implementation details even be documented here, though?

← Older revision		Revision as of 22:40, 13 March 2024
Line 74:		Line 74:
	::Opens the given URL in the default web browser. Ignored if the player has opted to disable links in chat; may open a GUI prompting the user if the setting for that is enabled. The link's protocol must be set and must be <code>http</code> or <code>https</code>, for security reasons.		::Opens the given URL in the default web browser. Ignored if the player has opted to disable links in chat; may open a GUI prompting the user if the setting for that is enabled. The link's protocol must be set and must be <code>http</code> or <code>https</code>, for security reasons.
	:;<s><code>open_file</code></s>		:;<s><code>open_file</code></s>
	::<strong>Cannot be used ~~within JSON chat~~</strong>. Opens a link to any protocol, but cannot be used in ~~JSON chat~~ for security reasons. Only exists to internally implement links for screenshots.		::<strong>Cannot be used over the network</strong>. Opens a link to any protocol, but cannot be used in text components sent over the network for security reasons. Only exists to internally implement links for screenshots.
	:;<code>run_command</code>		:;<code>run_command</code>
	::Runs the given command. Not required to be a command - clicking this only causes the client to send the given content as a chat message, so if not prefixed with <code>/</code>, they will say the given text instead. If used in a book GUI, the GUI is closed after clicking.		::Runs the given command. Not required to be a command - clicking this only causes the client to send the given content as a chat message, so if not prefixed with <code>/</code>, they will say the given text instead. If used in a book GUI, the GUI is closed after clicking.
	:;<s><code>twitch_user_info</code></s>		:;<s><code>twitch_user_info</code></s>
	::<strong>No longer supported; cannot be used ~~within JSON chat~~</strong>. Only usable in 1.8 and below; twitch support was removed in 1.9. Additionally, this is only used internally by the client. On click, opens a twitch user info GUI screen. Value should be the twitch user name.		::<strong>No longer supported; cannot be used over the network</strong>. Only usable in 1.8 and below; twitch support was removed in 1.9. Additionally, this is only used internally by the client. On click, opens a twitch user info GUI screen. Value should be the twitch user name.
	:;<code>suggest_command</code>		:;<code>suggest_command</code>
	::Only usable for messages in chat. Replaces the content of the chat box with the given text - usually a command, but it is not required to be a command (commands should be prefixed with <code>/</code>).		::Only usable for messages in chat. Replaces the content of the chat box with the given text - usually a command, but it is not required to be a command (commands should be prefixed with <code>/</code>).

imported>LassiPulkkinen: /* Text components */ Fix outdated type links (my bad).

2024-03-13T22:26:58Z

Text components: Fix outdated type links (my bad).

← Older revision		Revision as of 22:26, 13 March 2024
Line 5:		Line 5:
	A text component is a recursive structure, usually represented as [[wikipedia:JSON\|JSON]]. For most situations, the JSON is strictly parsed, but [https://www.javadoc.io/doc/com.google.code.gson/gson/latest/com.google.gson/com/google/gson/stream/JsonReader.html#setLenient(boolean) lenient JSON parsing] is used for the Disconnect packet and for written book text.		A text component is a recursive structure, usually represented as [[wikipedia:JSON\|JSON]]. For most situations, the JSON is strictly parsed, but [https://www.javadoc.io/doc/com.google.code.gson/gson/latest/com.google.gson/com/google/gson/stream/JsonReader.html#setLenient(boolean) lenient JSON parsing] is used for the Disconnect packet and for written book text.

	Versions 1.20.3 and later have the ability to encode text components into [[NBT]] as well, which is utilized in most cases when sending them over the network. This distinction is indicated via the ~~[[Data types#Definitions:chat~~\|~~Chat]]~~ and ~~[[Data types#Definitions:json_chat~~\|~~Json Chat]]~~ data types. Notchian Minecraft uses shared serialization logic for the two formats, so the conversions are mostly self-evident—objects correspond to compounds, etc. As in most contexts, any NBT integer type is accepted in place of an integer. Note, however, that NBT requires all elements of an array to have the same type, limiting flexibility.		Versions 1.20.3 and later have the ability to encode text components into [[NBT]] as well, which is utilized in most cases when sending them over the network. This distinction is indicated via the {{Type\|Text Component}} and {{Type\|JSON Text Component}} data types. Notchian Minecraft uses shared serialization logic for the two formats, so the conversions are mostly self-evident—objects correspond to compounds, etc. As in most contexts, any NBT integer type is accepted in place of an integer. Note, however, that NBT requires all elements of an array to have the same type, limiting flexibility.

	In any situation where a text component is expected, it may be either a string, an array, or an object (the most common choice).		In any situation where a text component is expected, it may be either a string, an array, or an object (the most common choice).

imported>LassiPulkkinen: Add category Minecraft Modern.

2024-02-24T04:53:21Z

Add category Minecraft Modern.

← Older revision		Revision as of 04:53, 24 February 2024
Line 374:		Line 374:
	\| Unused.		\| Unused.
	\|}		\|}

			[[Category:Minecraft Modern]]

imported>LassiPulkkinen: /* Text components */ Link JSON and NBT.

2024-01-16T15:55:39Z

Text components: Link JSON and NBT.

← Older revision		Revision as of 15:55, 16 January 2024
Line 3:		Line 3:
	== Text components ==		== Text components ==

	A text component is a recursive structure, usually represented as JSON. For most situations, the JSON is strictly parsed, but [https://www.javadoc.io/doc/com.google.code.gson/gson/latest/com.google.gson/com/google/gson/stream/JsonReader.html#setLenient(boolean) lenient JSON parsing] is used for the Disconnect packet and for written book text.		A text component is a recursive structure, usually represented as [[wikipedia:JSON\|JSON]]. For most situations, the JSON is strictly parsed, but [https://www.javadoc.io/doc/com.google.code.gson/gson/latest/com.google.gson/com/google/gson/stream/JsonReader.html#setLenient(boolean) lenient JSON parsing] is used for the Disconnect packet and for written book text.

	Versions 1.20.3 and later have the ability to encode text components into NBT as well, which is utilized in most cases when sending them over the network. This distinction is indicated via the [[Data types#Definitions:chat\|Chat]] and [[Data types#Definitions:json_chat\|Json Chat]] data types. Notchian Minecraft uses shared serialization logic for the two formats, so the conversions are mostly self-evident—objects correspond to compounds, etc. As in most contexts, any NBT integer type is accepted in place of an integer. Note, however, that NBT requires all elements of an array to have the same type, limiting flexibility.		Versions 1.20.3 and later have the ability to encode text components into [[NBT]] as well, which is utilized in most cases when sending them over the network. This distinction is indicated via the [[Data types#Definitions:chat\|Chat]] and [[Data types#Definitions:json_chat\|Json Chat]] data types. Notchian Minecraft uses shared serialization logic for the two formats, so the conversions are mostly self-evident—objects correspond to compounds, etc. As in most contexts, any NBT integer type is accepted in place of an integer. Note, however, that NBT requires all elements of an array to have the same type, limiting flexibility.

	In any situation where a text component is expected, it may be either a string, an array, or an object (the most common choice).		In any situation where a text component is expected, it may be either a string, an array, or an object (the most common choice).

imported>LassiPulkkinen: /* Content fields */ Tweak.

2024-01-16T15:48:16Z

Content fields: Tweak.

← Older revision		Revision as of 15:48, 16 January 2024
Line 22:		Line 22:

	;<code>type</code>		;<code>type</code>
	:''Optional String''. The content type of this component, specifying what kind of direct content it includes.		:''Optional String''. The content type of this component, specifying what kind of direct content it includes. If omitted, each of the content types is tried in the listed order until one for which the component is valid is found.
	;<code>extra</code>		;<code>extra</code>
	:''Optional Array of Text Component''. The child components of this component. If present, cannot be empty. Somewhat confusingly, these may also be thought of as siblings to the direct content of their parent component.		:''Optional Array of Text Component''. The child components of this component. If present, cannot be empty. Somewhat confusingly, these may also be thought of as siblings to the direct content of their parent component.

	Additionally, the component must contain the fields of its content type (refer to the table below).		Additionally, the component must contain the fields of its content type (refer to the table below).

	If the component includes a <code>type</code> field, it specifies the component's content type. Otherwise, each of the content types is tried in the listed order until one for which the component is valid is found.

	The following content types are defined:		The following content types are defined:

imported>LassiPulkkinen: s/Current system (text components)/Text components/g; s/Old system/Formatting codes/g; Labeling formatting codes as the "old system", while mostly true, might lead one to falsely assume that it no longer applies. And, of course, "Current system (text components)" is just painfully long.

2024-01-13T18:48:11Z

s/Current system (text components)/Text components/g; s/Old system/Formatting codes/g; Labeling formatting codes as the "old system", while mostly true, might lead one to falsely assume that it no longer applies. And, of course, "Current system (text components)" is just painfully long.

← Older revision		Revision as of 18:48, 13 January 2024
Line 1:		Line 1:
	Minecraft has two separate text formatting systems. The newer [[#~~Current system (text~~ components)\|text component]] system is used in many specific contexts expecting formatted text, including chat messages, written books, death messages, window titles, and the like. In addition, the legacy [[#~~Old system~~\|formatting code]] system applies to more or less all displayed text, and is processed after text components.		Minecraft has two separate text formatting systems. The newer [[#Text components\|text component]] system is used in many specific contexts expecting formatted text, including chat messages, written books, death messages, window titles, and the like. In addition, the legacy [[#Formatting codes\|formatting code]] system applies to more or less all displayed text, and is processed after text components.

	== ~~Current system (text~~ components) ==		== Text components ==

	A text component is a recursive structure, usually represented as JSON. For most situations, the JSON is strictly parsed, but [https://www.javadoc.io/doc/com.google.code.gson/gson/latest/com.google.gson/com/google/gson/stream/JsonReader.html#setLenient(boolean) lenient JSON parsing] is used for the Disconnect packet and for written book text.		A text component is a recursive structure, usually represented as JSON. For most situations, the JSON is strictly parsed, but [https://www.javadoc.io/doc/com.google.code.gson/gson/latest/com.google.gson/com/google/gson/stream/JsonReader.html#setLenient(boolean) lenient JSON parsing] is used for the Disconnect packet and for written book text.
Line 114:		Line 114:

	;<code>text</code>		;<code>text</code>
	:''String''. Set as the content directly, with no additional processing. (But see [[#~~Old system~~]], which still ~~applies~~.)		:''String''. Set as the content directly, with no additional processing. (But see [[#Formatting codes]], which still apply.)

	=== Translatable content ===		=== Translatable content ===
Line 232:		Line 232:
	The <code>chat.type.text</code> translation key becomes <code><nowiki><%s> %s</nowiki></code>, which is then filled in with the player's name and the actual message. Note that the player's name has a click event (which inserts text to message the player), a hover event (which shows the entity ID; also note that <code>type</code> is missing), and an insertion (for the player's name).		The <code>chat.type.text</code> translation key becomes <code><nowiki><%s> %s</nowiki></code>, which is then filled in with the player's name and the actual message. Note that the player's name has a click event (which inserts text to message the player), a hover event (which shows the entity ID; also note that <code>type</code> is missing), and an insertion (for the player's name).

	== ~~Old system~~ ==		== Formatting codes ==

	The client treats certain two-character sequences specially. The first character must be:		The client treats certain two-character sequences specially. The first character must be:

imported>LassiPulkkinen: Restructure to better account for standalone use of the styling fields.

2024-01-13T18:17:59Z

Restructure to better account for standalone use of the styling fields.

← Older revision		Revision as of 18:17, 13 January 2024
Line 13:		Line 13:
	A component specified as an array is interpreted as the first element of the array, with the rest of the elements then appended to the component's <code>extra</code> field. This can produce unusual behavior with style inheritance, but it is still useful shorthand.		A component specified as an array is interpreted as the first element of the array, with the rest of the elements then appended to the component's <code>extra</code> field. This can produce unusual behavior with style inheritance, but it is still useful shorthand.

	A component specified as an object ~~must contain the field(s) corresponding to its~~ [[#Content ~~types~~\|content ~~type~~]], and ~~may additionally contain~~ any number of ~~the~~ [[#~~Fields common to all content types~~\|~~common~~ fields]] ~~listed below~~.		A component specified as an object consists of one or more [[#Content fields\|content fields]], and any number of [[#Styling fields\|styling fields]].

	=== Content ~~types~~ ===		=== Content fields ===

	~~The content type of a~~ component ~~specifies what kind of direct~~ content ~~it includes~~. The full content of a component is the concatenation of its direct content, and the full contents of all its child components ~~(elements~~ of ~~the~~ <code>extra</code> ~~field~~)~~, in that order~~.		These fields specify the component's content.

			The full content of the component is the concatenation of its direct content, to which the component's styling directly applies, and the full contents of all its child components, which inherit styling from their parent, in that order.

			;<code>type</code>
			:''Optional String''. The content type of this component, specifying what kind of direct content it includes.
			;<code>extra</code>
			:''Optional Array of Text Component''. The child components of this component. If present, cannot be empty. Somewhat confusingly, these may also be thought of as siblings to the direct content of their parent component.

			Additionally, the component must contain the fields of its content type (refer to the table below).

	If the component includes a <code>type</code> field, it specifies the component's content type. Otherwise, each of the content types is tried in the listed order until one for which the component is valid is found.		If the component includes a <code>type</code> field, it specifies the component's content type. Otherwise, each of the content types is tried in the listed order until one for which the component is valid is found.
Line 48:		Line 57:
	Content types marked as Resolved By Server are resolved server-side, e.g. in response to commands, and need not be implemented by clients.		Content types marked as Resolved By Server are resolved server-side, e.g. in response to commands, and need not be implemented by clients.

	=== ~~Fields common to all content types~~ ===		=== Styling fields ===

			These fields specify styling and actions to associate with the component's content. They also appear by themselves in some contexts, outside a text component.

			Values for any unspecified fields are either inherited from the nearest parent that does specify them, if one exists, or otherwise assigned default values according to the surrounding context.

	~~;<code>type</code>~~
	~~:''Optional String''. The [[#Content types\|content type]] of this component.~~
	~~;<code>extra</code>~~
	:''Optional Array of Text Component''. The child components of this component. If present, cannot be empty. Somewhat confusingly, these may also be thought of as siblings to the direct content of their parent component. Each child component inherits common fields other than <code>type</code> and <code>extra</code> from its parent, using their values for fields not defined on the child itself.
	;<code>color</code>		;<code>color</code>
	:''Optional String''. The text color, which may be a color name or a #-prefixed hexadecimal RGB specification. See [[#Colors]] below.		:''Optional String''. The text color, which may be a color name or a #-prefixed hexadecimal RGB specification. See [[#Colors]] below.