Template:Tact/doc

From Brighter Shores Wiki
Revision as of 13:32, 7 November 2024 by BlackHawk (talk | contribs) (Created page with "{{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 fil...")
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigation Jump to search

This is a documentation subpage for Template:Tact.
It contains usage information, categories, and other content that is not part of the original template page.

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

* Example text
* {{Tact|Description of an action.}}
* Example text

This will result in:

  • Example text
  • Description of an action.
  • Example text

Automatic options

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

Specific actions

{{Tact|end}} will result in (Dialogue ends.)

{{Tact|pop-up}} and {{Tact|popup}} will result in (Repeated in a pop-up:). Used in conjunction with {{Pop-up|Text in the popup}} on the following line.

{{Tact|opens=The Frequently Fresh Fish Stall}} will result in (The Frequently Fresh Fish Stall interface opens.)

Should the page name not match the interface then a {{!}} pipe can be used {{Tact|opens=The Frequently Fresh Fish Stall{{!}}Interface name}} which results in (Interface name interface opens.)


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

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

Similarly, {{Tact|removes=Common Guard Elegant Shield}} will result in Player has Common Guard Elegant Shield removed from them..

Text ordering

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

{{Tact|previous}} will result in (Shows the previous options.)

{{Tact|previous2}} will result in (Shows the previous-to-previous options.)

{{Tact|initial}} will result in (Shows the initial options.)

{{Tact|other}} will result in (Shows the other options.)

{{Tact|above}} will result in (Same as above.)

{{Tact|below}} will result in (Same as below.)

{{Tact|above2}} will result in (See above.)

{{Tact|below2}} will result in (See below.)

{{Tact|continue}} will result in (Continues below.)

{{Tact|continuea}} will result in (Continues above.)

{{Tact|continue2|anchor-example}} will result in (Click to continue.) An anchor should be provided as the second parameter.

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

{{Tact|see|Captain Jal Degreene#Using an item on her}} will result in (See the transcript for 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 {{anchor|anchor-example}} somewhere in the transcript and using {{Tact|above2|anchor-example}} will result in (See above.), 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:

{{Tact|below2|Section Two}}

==Section Two==

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 2 would be used:

{{Tact|below2|Section Two 2}}

==Section Two==
===Block Three===
====Section Two====

Template data

Show/hide template's data

The following information is used by extensions and applications, such as VisualEditor, to help users implement this template onto pages. Please ensure that it is up-to-date.

A template to provide consistent styling for common transcript notations and actions. This 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. These are the keywords that will generate the following text-ordering text in italics: '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).' Any other text supplied as the first parameter will show the text, as-is. The 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. There 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

Template parameters

This template prefers inline formatting of parameters.

ParameterDescriptionTypeStatus
Description/Action1 description action

Description to add, or a keyword to expand on

Example
end, previous, previous2, initial, other, above, below, above2, below2, continue, Description of an action.
Stringsuggested
Link2 link

The anchor/section link to use when this option is clicked on

Example
Section Two, anchor-example
Stringsuggested
Openopens

Used when a transcript opens an interface.

Example
The Frequently Fresh Fish Stall
Page nameoptional
Player Receivesreceives

An option to specify if a player receives an item

Example
the [[Excalibur]]
Stringoptional