Plugin:Variables - Revision history

Dart Raiden: /* `string` */

2022-02-12T18:14:09Z

`string`

← Older revision		Revision as of 21:14, 12 February 2022
Line 64:		Line 64:
	This will not parse the given string, any function, field or special character in the string will shown in the result without being translated. Example:		This will not parse the given string, any function, field or special character in the string will shown in the result without being translated. Example:
	<pre style="overflow:auto;">		<pre style="overflow:auto;">
	Use `%~~mirandapath~~%` to show the installation path.		Use `%miranda_path%` to show the installation path.
	</pre>		</pre>
	It's usually a good idea to put any non-special keyword between ` characters.		It's usually a good idea to put any non-special keyword between ` characters.

Dart Raiden: Undo revision 38409 by Dart Raiden (talk)

2020-08-20T23:22:08Z

Undo revision 38409 by Dart Raiden (talk)

← Older revision		Revision as of 02:22, 21 August 2020
Line 142:		Line 142:
	</translate>		</translate>
	{\|		{\|
	\|d\|\|~~<translate>~~Day of month as digits with no leading zero for single-digit days.~~</translate>~~		\|d\|\|Day of month as digits with no leading zero for single-digit days.
	\|-		\|-
	\|dd\|\|~~<translate>~~Day of month as digits with leading zero for single-digit days.~~</translate>~~		\|dd\|\|Day of month as digits with leading zero for single-digit days.
	\|-		\|-
	\|ddd\|\|~~<translate>~~Day of week as a three-letter abbreviation.~~</translate>~~		\|ddd\|\|Day of week as a three-letter abbreviation.
	\|-		\|-
	\|dddd\|\|~~<translate>~~Day of week as its full name.~~</translate>~~		\|dddd\|\|Day of week as its full name.
	\|-		\|-
	\|M\|\|~~<translate>~~Month as digits with no leading zero for single-digit months.~~</translate>~~		\|M\|\|Month as digits with no leading zero for single-digit months.
	\|-		\|-
	\|MM\|\|~~<translate>~~Month as digits with leading zero for single-digit months.~~</translate>~~		\|MM\|\|Month as digits with leading zero for single-digit months.
	\|-		\|-
	\|MMM\|\|~~<translate>~~Month as a three-letter abbreviation.~~</translate>~~		\|MMM\|\|Month as a three-letter abbreviation.
	\|-		\|-
	\|MMMM\|\|~~<translate>~~Month as its full name.~~</translate>~~		\|MMMM\|\|Month as its full name.
	\|-		\|-
	\|~~yyyy~~\|\|~~<translate>~~Year ~~represented by full four~~ digits.~~</translate>~~		\|y\|\|Year as last two digits, but with no leading zero for years less than 10.
	\|-		\|-
	\|gg\|\|~~<translate>~~Period/era string. This element is ignored if the date to be formatted does not have an associated era or period string.~~</translate>~~		\|yy\|\|Year as last two digits, but with leading zero for years less than 10.
			\|-
			\|yyyy\|\|Year represented by full four digits.
			\|-
			\|gg\|\|Period/era string. This element is ignored if the date to be formatted does not have an associated era or period string.
	\|}		\|}

Dart Raiden at 23:21, 20 August 2020

2020-08-20T23:21:32Z

← Older revision		Revision as of 02:21, 21 August 2020
Line 142:		Line 142:
	</translate>		</translate>
	{\|		{\|
	\|d\|\|Day of month as digits with no leading zero for single-digit days.		\|d\|\|<translate>Day of month as digits with no leading zero for single-digit days.</translate>
	\|-		\|-
	\|dd\|\|Day of month as digits with leading zero for single-digit days.		\|dd\|\|<translate>Day of month as digits with leading zero for single-digit days.</translate>
	\|-		\|-
	\|ddd\|\|Day of week as a three-letter abbreviation.		\|ddd\|\|<translate>Day of week as a three-letter abbreviation.</translate>
	\|-		\|-
	\|dddd\|\|Day of week as its full name.		\|dddd\|\|<translate>Day of week as its full name.</translate>
	\|-		\|-
	\|M\|\|Month as digits with no leading zero for single-digit months.		\|M\|\|<translate>Month as digits with no leading zero for single-digit months.</translate>
	\|-		\|-
	\|MM\|\|Month as digits with leading zero for single-digit months.		\|MM\|\|<translate>Month as digits with leading zero for single-digit months.</translate>
	\|-		\|-
	\|MMM\|\|Month as a three-letter abbreviation.		\|MMM\|\|<translate>Month as a three-letter abbreviation.</translate>
	\|-		\|-
	\|MMMM\|\|Month as its full name.		\|MMMM\|\|<translate>Month as its full name.</translate>
	\|-		\|-
	\|y\|\|Year ~~as last two~~ digits~~, but with no leading zero for years less than 10~~.		\|yyyy\|\|<translate>Year represented by full four digits.</translate>
	\|-		\|-
	~~\|yy\|\|Year as last two digits, but with leading zero for years less than 10.~~		\|gg\|\|<translate>Period/era string. This element is ignored if the date to be formatted does not have an associated era or period string.</translate>
	\|-
	~~\|yyyy\|\|Year represented by full four digits.~~
	\|-
	\|gg\|\|Period/era string. This element is ignored if the date to be formatted does not have an associated era or period string.
	\|}		\|}

Dart Raiden: Marked this version for translation

2020-08-20T23:18:59Z

Marked this version for translation

← Older revision		Revision as of 02:18, 21 August 2020
Line 20:		Line 20:
	A formatting string consists of "tokens", special keywords which are translated by the Variables plugin into some text. Popular use of Variables is to show the currently playing song in your away message. If your away message module (like {{Plugin\|NewAwaySys}}) supports the Variables plugin, you can enter a text like the following to show your current Winamp song in your away message:		A formatting string consists of "tokens", special keywords which are translated by the Variables plugin into some text. Popular use of Variables is to show the currently playing song in your away message. If your away message module (like {{Plugin\|NewAwaySys}}) supports the Variables plugin, you can enter a text like the following to show your current Winamp song in your away message:

			<!--T:8-->
	<pre style="overflow:auto;">		<pre style="overflow:auto;">
	Hi, I'm listening to %winampsong%.		Hi, I'm listening to %winampsong%.
Line 25:		Line 26:
	In this example, the token '%winampsong%' will be translated by the Variables plugin into the current song. Please see [[#Notes\|Notes]] for more details.		In this example, the token '%winampsong%' will be translated by the Variables plugin into the current song. Please see [[#Notes\|Notes]] for more details.

			<!--T:9-->
	Such special keywords, or tokens, are there in two flavors. First, there are ''fields'', the syntax for a field is %fieldname%, an example is the already shown %winampsong% field. A field takes no arguments. But more advanced is the second flavor, ''functions''. Functions are usually accessed by "?functionname(argument1,argument2,...)", a function can take zero or more arguments. An example of a function is "?add(1,1)", this function will, as you can guess, be replaced by the number "2".		Such special keywords, or tokens, are there in two flavors. First, there are ''fields'', the syntax for a field is %fieldname%, an example is the already shown %winampsong% field. A field takes no arguments. But more advanced is the second flavor, ''functions''. Functions are usually accessed by "?functionname(argument1,argument2,...)", a function can take zero or more arguments. An example of a function is "?add(1,1)", this function will, as you can guess, be replaced by the number "2".

			<!--T:10-->
	A complete list of tokens can be found by pressing "Help…" on the {{Menu\|Services\|Variables}} options screen.		A complete list of tokens can be found by pressing "Help…" on the {{Menu\|Services\|Variables}} options screen.

			<!--T:11-->
	Next to the % and ? character, there are a few others which have a special meaning, these are:		Next to the % and ? character, there are a few others which have a special meaning, these are:
	</translate>		</translate>
Line 35:		Line 39:

	<translate>		<translate>
			<!--T:12-->
	This will parse the function given the arguments, but the result will not be parsed again. Example:		This will parse the function given the arguments, but the result will not be parsed again. Example:
	<pre style="overflow:auto;">		<pre style="overflow:auto;">
Line 56:		Line 61:

	<translate>		<translate>
			<!--T:13-->
	This will not parse the given string, any function, field or special character in the string will shown in the result without being translated. Example:		This will not parse the given string, any function, field or special character in the string will shown in the result without being translated. Example:
	<pre style="overflow:auto;">		<pre style="overflow:auto;">
Line 66:		Line 72:

	<translate>		<translate>
			<!--T:14-->
	This will add a comment in the formatting string. Everything from the <nowiki>#</nowiki> character to the end of the line will be removed. Example:		This will add a comment in the formatting string. Everything from the <nowiki>#</nowiki> character to the end of the line will be removed. Example:
	<pre style="overflow:auto;">		<pre style="overflow:auto;">
Line 71:		Line 78:
	</pre>		</pre>

			<!--T:15-->
	The Variables plugin allows you to build much more complex formatting strings than the one shown above. Please refer to the [[#Additional help\|Additional help]] and [[#Notes\|Notes]] sections for more information.		The Variables plugin allows you to build much more complex formatting strings than the one shown above. Please refer to the [[#Additional help\|Additional help]] and [[#Notes\|Notes]] sections for more information.

			<!--T:16-->
	There are a few settings in the options dialog:		There are a few settings in the options dialog:
	;Automatically strip "end of line" characters		;Automatically strip "end of line" characters
Line 87:		Line 96:
	: Pressing this button shows up a list of available functions and fields.		: Pressing this button shows up a list of available functions and fields.

	== Additional help ==		== Additional help == <!--T:17-->
	As stated before, this plugin can be quite complicated to use, here follows some addition help for some of the complex functions.		As stated before, this plugin can be quite complicated to use, here follows some addition help for some of the complex functions.
	</translate>		</translate>
Line 94:		Line 103:

	<translate>		<translate>
			<!--T:18-->
	The Variables has several functions based on logics. The if function will show string y in case x evaluates to true, and z otherwise. The return values of the several logic functions can be found in the help dialog. Also, a string x is false in case an error occurs while parsing it. Example:		The Variables has several functions based on logics. The if function will show string y in case x evaluates to true, and z otherwise. The return values of the several logic functions can be found in the help dialog. Also, a string x is false in case an error occurs while parsing it. Example:
	<pre style="overflow:auto;">		<pre style="overflow:auto;">
Line 103:		Line 113:

	<translate>		<translate>
			<!--T:19-->
	* x specifies the contact (see [[#Notes\|Notes]]).		* x specifies the contact (see [[#Notes\|Notes]]).
	* y specifies the info you want to retrieve, the following values are possible:		* y specifies the info you want to retrieve, the following values are possible:
Line 111:		Line 122:
	</pre>		</pre>

			<!--T:20-->
	Example:		Example:
	<pre style="overflow:auto;">		<pre style="overflow:auto;">
Line 120:		Line 132:

	<translate>		<translate>
			<!--T:21-->
	These functions require {{Plugin\|SeenPlugin\|LastSeen}} to be installed.		These functions require {{Plugin\|SeenPlugin\|LastSeen}} to be installed.
	<pre style="overflow:auto;">		<pre style="overflow:auto;">
Line 125:		Line 138:
	</pre>		</pre>

			<!--T:22-->
	The format argument can be formatted using the following:		The format argument can be formatted using the following:
	</translate>		</translate>

Dart Raiden at 23:18, 20 August 2020

2020-08-20T23:18:53Z

← Older revision		Revision as of 02:18, 21 August 2020
Line 118:		Line 118:

	=== lsdate(x,y), lstime(x,y), lsstatus(x) ===		=== lsdate(x,y), lstime(x,y), lsstatus(x) ===

			<translate>
	These functions require {{Plugin\|SeenPlugin\|LastSeen}} to be installed.		These functions require {{Plugin\|SeenPlugin\|LastSeen}} to be installed.
	<pre style="overflow:auto;">		<pre style="overflow:auto;">
Line 124:		Line 126:

	The format argument can be formatted using the following:		The format argument can be formatted using the following:
			</translate>
	{\|		{\|
	\|d\|\|Day of month as digits with no leading zero for single-digit days.		\|d\|\|Day of month as digits with no leading zero for single-digit days.
Line 151:		Line 154:

	=== lstime(x,y), ctime(x) ===		=== lstime(x,y), ctime(x) ===

	The format parameter can be formatted using the following:		The format parameter can be formatted using the following:
	{\|		{\|

Dart Raiden at 23:18, 20 August 2020

2020-08-20T23:18:09Z

← Older revision		Revision as of 02:18, 21 August 2020
Line 19:		Line 19:
	<!--T:7-->		<!--T:7-->
	A formatting string consists of "tokens", special keywords which are translated by the Variables plugin into some text. Popular use of Variables is to show the currently playing song in your away message. If your away message module (like {{Plugin\|NewAwaySys}}) supports the Variables plugin, you can enter a text like the following to show your current Winamp song in your away message:		A formatting string consists of "tokens", special keywords which are translated by the Variables plugin into some text. Popular use of Variables is to show the currently playing song in your away message. If your away message module (like {{Plugin\|NewAwaySys}}) supports the Variables plugin, you can enter a text like the following to show your current Winamp song in your away message:
	~~</translate>~~

	<pre style="overflow:auto;">		<pre style="overflow:auto;">
Line 31:		Line 30:

	Next to the % and ? character, there are a few others which have a special meaning, these are:		Next to the % and ? character, there are a few others which have a special meaning, these are:
			</translate>

	=== !function ===		=== !function ===

			<translate>
	This will parse the function given the arguments, but the result will not be parsed again. Example:		This will parse the function given the arguments, but the result will not be parsed again. Example:
	<pre style="overflow:auto;">		<pre style="overflow:auto;">
Line 49:		Line 51:
	Message waiting: You should use the string DJ Mike Llama - Llama Whippin' Intro to get the song.		Message waiting: You should use the string DJ Mike Llama - Llama Whippin' Intro to get the song.
	</pre>		</pre>
			</translate>

	=== `string` ===		=== `string` ===

			<translate>
	This will not parse the given string, any function, field or special character in the string will shown in the result without being translated. Example:		This will not parse the given string, any function, field or special character in the string will shown in the result without being translated. Example:
	<pre style="overflow:auto;">		<pre style="overflow:auto;">
Line 56:		Line 61:
	</pre>		</pre>
	It's usually a good idea to put any non-special keyword between ` characters.		It's usually a good idea to put any non-special keyword between ` characters.
			</translate>

	=== #comment ===		=== #comment ===

			<translate>
	This will add a comment in the formatting string. Everything from the <nowiki>#</nowiki> character to the end of the line will be removed. Example:		This will add a comment in the formatting string. Everything from the <nowiki>#</nowiki> character to the end of the line will be removed. Example:
	<pre style="overflow:auto;">		<pre style="overflow:auto;">
Line 81:		Line 89:
	== Additional help ==		== Additional help ==
	As stated before, this plugin can be quite complicated to use, here follows some addition help for some of the complex functions.		As stated before, this plugin can be quite complicated to use, here follows some addition help for some of the complex functions.
			</translate>

	=== if(x,y,z) ===		=== if(x,y,z) ===

			<translate>
	The Variables has several functions based on logics. The if function will show string y in case x evaluates to true, and z otherwise. The return values of the several logic functions can be found in the help dialog. Also, a string x is false in case an error occurs while parsing it. Example:		The Variables has several functions based on logics. The if function will show string y in case x evaluates to true, and z otherwise. The return values of the several logic functions can be found in the help dialog. Also, a string x is false in case an error occurs while parsing it. Example:
	<pre style="overflow:auto;">		<pre style="overflow:auto;">
	!if(%winampsong%,`winamp is running`,`winamp is not running`)		!if(%winampsong%,`winamp is running`,`winamp is not running`)
	</pre>		</pre>
			</translate>

	=== cinfo(x,y) ===		=== cinfo(x,y) ===

			<translate>
	* x specifies the contact (see [[#Notes\|Notes]]).		* x specifies the contact (see [[#Notes\|Notes]]).
	* y specifies the info you want to retrieve, the following values are possible:		* y specifies the info you want to retrieve, the following values are possible:
Line 101:		Line 115:
	!cinfo(<ICQ:12345678>,nick)		!cinfo(<ICQ:12345678>,nick)
	</pre>		</pre>
			</translate>

	=== lsdate(x,y), lstime(x,y), lsstatus(x) ===		=== lsdate(x,y), lstime(x,y), lsstatus(x) ===

Dart Raiden: Marked this version for translation

2020-08-20T23:13:48Z

Marked this version for translation

← Older revision		Revision as of 02:13, 21 August 2020
Line 7:		Line 7:
	This plugin is a service plugin other plugins can use it to format a string which contains variables. Variables can be used to show the currently playing song in Winamp, the last message you received, the status of a certain contact and much more. The Variables plugin allows you to use special formatting strings within plugins that process their strings using this plugin. Examples of such plugins are {{Plugin\|Tipper}} and {{Plugin\|StatusManager}}.		This plugin is a service plugin other plugins can use it to format a string which contains variables. Variables can be used to show the currently playing song in Winamp, the last message you received, the status of a certain contact and much more. The Variables plugin allows you to use special formatting strings within plugins that process their strings using this plugin. Examples of such plugins are {{Plugin\|Tipper}} and {{Plugin\|StatusManager}}.

	== About ==		== About == <!--T:3-->

			<!--T:4-->
	This plugin doesn't add any functionality on itself. But other plugins can use it to format a string which contains variables. Since this plugin can be quite complicated to use, please read this document carefully before reporting any problems.		This plugin doesn't add any functionality on itself. But other plugins can use it to format a string which contains variables. Since this plugin can be quite complicated to use, please read this document carefully before reporting any problems.

	== Usage ==		== Usage == <!--T:5-->

			<!--T:6-->
	The Variables plugin allows you to use special formatting of strings within plugins that process their strings using this plugin. Examples of such plugins are {{While\|tpl=Plugin\|NewAwaySys\|Tipper\|SimpleStatusMsg\|StatusManager}}. Please refer to the documentation of the plugin whether or not Variables is supported. Usually, there is no special action needed to use a formatting string instead of a normal string.		The Variables plugin allows you to use special formatting of strings within plugins that process their strings using this plugin. Examples of such plugins are {{While\|tpl=Plugin\|NewAwaySys\|Tipper\|SimpleStatusMsg\|StatusManager}}. Please refer to the documentation of the plugin whether or not Variables is supported. Usually, there is no special action needed to use a formatting string instead of a normal string.

			<!--T:7-->
	A formatting string consists of "tokens", special keywords which are translated by the Variables plugin into some text. Popular use of Variables is to show the currently playing song in your away message. If your away message module (like {{Plugin\|NewAwaySys}}) supports the Variables plugin, you can enter a text like the following to show your current Winamp song in your away message:		A formatting string consists of "tokens", special keywords which are translated by the Variables plugin into some text. Popular use of Variables is to show the currently playing song in your away message. If your away message module (like {{Plugin\|NewAwaySys}}) supports the Variables plugin, you can enter a text like the following to show your current Winamp song in your away message:
	</translate>		</translate>

Dart Raiden at 23:13, 20 August 2020

2020-08-20T23:13:41Z

← Older revision		Revision as of 02:13, 21 August 2020
Line 6:		Line 6:
	<!--T:2-->		<!--T:2-->
	This plugin is a service plugin other plugins can use it to format a string which contains variables. Variables can be used to show the currently playing song in Winamp, the last message you received, the status of a certain contact and much more. The Variables plugin allows you to use special formatting strings within plugins that process their strings using this plugin. Examples of such plugins are {{Plugin\|Tipper}} and {{Plugin\|StatusManager}}.		This plugin is a service plugin other plugins can use it to format a string which contains variables. Variables can be used to show the currently playing song in Winamp, the last message you received, the status of a certain contact and much more. The Variables plugin allows you to use special formatting strings within plugins that process their strings using this plugin. Examples of such plugins are {{Plugin\|Tipper}} and {{Plugin\|StatusManager}}.
	~~</translate>~~

	== About ==		== About ==

	This plugin doesn't add any functionality on itself. But other plugins can use it to format a string which contains variables. Since this plugin can be quite complicated to use, please read this document carefully before reporting any problems.		This plugin doesn't add any functionality on itself. But other plugins can use it to format a string which contains variables. Since this plugin can be quite complicated to use, please read this document carefully before reporting any problems.

	~~Many thanks to {{Developer\|HeikoH}} and {{Developer\|DeathDemon}} for their suggestions and help.~~		== Usage ==

	~~== Usage ==~~
	The Variables plugin allows you to use special formatting of strings within plugins that process their strings using this plugin. Examples of such plugins are {{While\|tpl=Plugin\|NewAwaySys\|Tipper\|SimpleStatusMsg\|StatusManager}}. Please refer to the documentation of the plugin whether or not Variables is supported. Usually, there is no special action needed to use a formatting string instead of a normal string.		The Variables plugin allows you to use special formatting of strings within plugins that process their strings using this plugin. Examples of such plugins are {{While\|tpl=Plugin\|NewAwaySys\|Tipper\|SimpleStatusMsg\|StatusManager}}. Please refer to the documentation of the plugin whether or not Variables is supported. Usually, there is no special action needed to use a formatting string instead of a normal string.

	A formatting string consists of "tokens", special keywords which are translated by the Variables plugin into some text. Popular use of Variables is to show the currently playing song in your away message. If your away message module (like {{Plugin\|NewAwaySys}}) supports the Variables plugin, you can enter a text like the following to show your current Winamp song in your away message:		A formatting string consists of "tokens", special keywords which are translated by the Variables plugin into some text. Popular use of Variables is to show the currently playing song in your away message. If your away message module (like {{Plugin\|NewAwaySys}}) supports the Variables plugin, you can enter a text like the following to show your current Winamp song in your away message:
			</translate>

	<pre style="overflow:auto;">		<pre style="overflow:auto;">
	Hi, I'm listening to %winampsong%.		Hi, I'm listening to %winampsong%.

Dart Raiden: /* get(x), put(x,y), puts(x,y) */

2020-08-20T22:28:11Z

get(x), put(x,y), puts(x,y)

← Older revision		Revision as of 01:28, 21 August 2020
Line 164:		Line 164:
	Put and puts will store string y under name x. Puts will return nothing, while put returns the string stored. Get will retrieve the value stored earlier with put or puts.		Put and puts will store string y under name x. Puts will return nothing, while put returns the string stored. Get will retrieve the value stored earlier with put or puts.

	{{Note\|The stored string is first parsed, this means calling for example !puts(time,!ctime()) and later !get(time) will always return the time at which puts was called. Use !alias(x,y) to store 'unparsed strings'.		{{TNT\|Note\|The stored string is first parsed, this means calling for example !puts(time,!ctime()) and later !get(time) will always return the time at which puts was called. Use !alias(x,y) to store 'unparsed strings'.
	Strings stored using put and puts can always be accessed (they are shared amongst instances). So beware you don't modify a variable in two places (unless you want that to happen).}}		Strings stored using put and puts can always be accessed (they are shared amongst instances). So beware you don't modify a variable in two places (unless you want that to happen).}}

Dart Raiden at 17:14, 10 April 2020

2020-04-10T17:14:19Z

← Older revision		Revision as of 20:14, 10 April 2020
Line 213:		Line 213:
	== Notes ==		== Notes ==
	# Whenever a function requires a contact as an argument, you can specify it in two ways:		# Whenever a function requires a contact as an argument, you can specify it in two ways:
	#* Using a unique ID (UIN for ICQ, JID for Jabber) or, a protocol ID followed by a unique ID in the form <PROTOID:UNIQUEID>, for example <JABBER:miranda@~~jabber~~.com> or <ICQ:123456789>.		#* Using a unique ID (UIN for ICQ, JID for Jabber) or, a protocol ID followed by a unique ID in the form <PROTOID:UNIQUEID>, for example <JABBER:miranda@example.com> or <ICQ:123456789>.
	#* Using the contact function:<!--		#* Using the contact function:<!--
	--><p>'''contact(x,y)'''</p><!--		--><p>'''contact(x,y)'''</p><!--
Line 219:		Line 219:
	--><p><pre style="overflow:auto;">first, last, nick, email, id, display</pre></p><!--		--><p><pre style="overflow:auto;">first, last, nick, email, id, display</pre></p><!--
	--><p>Example:</p><!--		--><p>Example:</p><!--
	--><p><pre style="overflow:auto;">?contact(miranda@~~hotmail~~.com,email)</pre></p><!--		--><p><pre style="overflow:auto;">?contact(miranda@example.com,email)</pre></p><!--
	--><p>or</p><!--		--><p>or</p><!--
	--><p><pre style="overflow:auto;">?contact(Miranda,nick).</pre></p><!--		--><p><pre style="overflow:auto;">?contact(Miranda,nick).</pre></p><!--