Editing Template:Tact/doc

{{Anchor|anchor-example}}
{{Documentation}}

The '''tact''', or ''transcript action'', template is used on transcript pages for consistent styling on actions, as well as consistent wording on certain phrases.

==Usage==
<pre>
* Example text
* {{Tact|Description of an action.}}
* Example text
</pre>

This will result in: 
* Example text
* {{Tact|Description of an action.}}
* Example text

==Automatic options==
The template also has some options that will automatically fill in the desired text:

===Specific actions===
{{T|Tact|end}} will result in {{Tact|end}}

{{T|Tact|pop-up}} and {{T|Tact|popup}} will result in {{Tact|popup}}. Used in conjunction with {{T|Pop-up|Text in the popup}} on the following line.

{{T|Tact|opens=The Frequently Fresh Fish Stall}} will result in {{Tact|opens=The Frequently Fresh Fish Stall}}

Should the page name not match the interface then a {{T|!}} pipe can be used {{T|Tact|opens=The Frequently Fresh Fish Stall<nowiki>{{!}}</nowiki>Interface name}} which results in {{Tact|opens=The Frequently Fresh Fish Stall{{!}}Interface name}}


{{T|Tact|receives=Common Guard Elegant Shield}} will result in {{Tact|receives=Common Guard Elegant Shield}}

The above does not automatically link due to sometimes requiring additional words such as a, an, or the: {{T|Tact|receives=the [[Common Guard Elegant Shield]]}} resulting in {{Tact|receives=the [[Common Guard Elegant Shield]]}}

Similarly, {{T|Tact|removes=Common Guard Elegant Shield}} will result in {{Tact|removes=Common Guard Elegant Shield}}.

===Text ordering===
These parameters can be used to omit repeating text and options within the transcript.

{{T|Tact|previous}} will result in {{Tact|previous}}

{{T|Tact|previous2}} will result in {{Tact|previous2}}

{{T|Tact|initial}} will result in {{Tact|initial}}

{{T|Tact|other}} will result in {{Tact|other}}

{{T|Tact|above}} will result in {{Tact|above}}

{{T|Tact|below}} will result in {{Tact|below}}

{{T|Tact|above2}} will result in {{Tact|above2}}

{{T|Tact|below2}} will result in {{Tact|below2}}

{{T|Tact|continue}} will result in {{Tact|continue}}

{{T|Tact|continuea}} will result in {{Tact|continuea}}

{{T|Tact|continue2|anchor-example}} will result in {{Tact|continue2|anchor-example}} An anchor should be provided as the second parameter.

{{T|Tact|see|Captain Jal Degreene}} will result in {{Tact|see|Captain Jal Degreene}} A transcript name should be provided as the second parameter.

{{T|Tact|see|Captain Jal Degreene#Using an item on her}} will result in {{Tact|see|Captain Jal Degreene#Using an item on her}}

====Anchors====
Using an additional parameter with the text ordering parameters will pass that parameter as a link to a previously defined anchor within the transcript.

For example, putting {{T|anchor|anchor-example}} somewhere in the transcript and using {{T|Tact|above2|anchor-example}} will result in {{Tact|above2|anchor-example}}, a link that points to that part in the transcript.

The anchor parameter can also be used to link to a section within the page. The following use of the template will link to the section specified in the anchor:
<pre>
{{Tact|below2|Section Two}}

==Section Two==
</pre>

Be aware that if multiple sections have the same title, to link to an equally-named section other than the first, a space and a number must be appended to the anchor name in the template. The number is the position of the equally-named section within the page. So, in the following example, to link to the second equally-named section, a <code>2</code> would be used:
<pre>
{{Tact|below2|Section Two 2}}

==Section Two==
===Block Three===
====Section Two====
</pre>

{{TemplateData|<templatedata>
{
	"params": {
		"1": {
			"aliases": [
				"description",
				"action"
			],
			"label": "Description/Action",
			"description": "Description to add, or a keyword to expand on",
			"example": "end, previous, previous2, initial, other, above, below, above2, below2, continue, Description of an action.",
			"type": "string",
			"suggested": true
		},
		"2": {
			"aliases": [
				"link"
			],
			"label": "Link",
			"description": "The anchor/section link to use when this option is clicked on",
			"example": "Section Two, anchor-example",
			"type": "string",
			"suggested": true
		},
		"opens": {
			"label": "Open",
			"description": "Used when a transcript opens an interface. ",
			"example": "The Frequently Fresh Fish Stall",
			"type": "wiki-page-name"
		},
		"receives": {
			"label": "Player Receives",
			"description": "An option to specify if a player receives an item",
			"example": "the [[Excalibur]]",
			"type": "string"
		}
	},
	"description": "A template to provide consistent styling for common transcript notations and actions.\n\nThis can be used to merely indicate an action happening, but can also be used to describe the specific interactions of the transcript, such navigating to an earlier or later part of the transcript, or the transcript ending.\n\nThese are the keywords that will generate the following text-ordering text in italics:\n\n'end' will result in '(Dialogue ends).' 'previous' will result in '(Shows previous options).' 'previous2' will result in '(Shows previous-to-previous options).' 'initial' will result in '(Shows initial options).' other: '(Shows other options).' 'above' will result in '(Same as above).' 'below':  '(Same as below).' 'above2' will result in '(See above).' 'below2' will result in '(See below).' 'continue' will result in '(Continues below).'\n\nAny other text supplied as the first parameter will show the text, as-is.\n\nThe second, optional parameter is used to turn the words into a link to some anchor or section on the current page. An anchor can be created by using the anchor template. For example adding {{anchor|anchor-example}} to the transcript somewhere would allow you to specify \"anchor-example\" as the second parameter to the Tact template, and it will show a link to that section of the page.\n\nThere are also two other named parameters that allow specific text to be inserted when an interface opens, and when the player receives an item. These are: 'opens=' and 'receives='. 'opens' will generate text like this:'(The Frequently Fresh Fish Stall interface opens.)' if The Frequently Fresh Fish Stall was specified: open=The Frequently Fresh Fish Stall. 'receives' will generate something like this: 'Player receives bronze sword.', assuming 'receives=bronze sword' was specified",
	"format": "inline"
}
</templatedata>}}

<includeonly>[[Category:Formatting templates]][[Category:Transcript templates|{{PAGENAME}}]]</includeonly>