Template:Activate Living/doc

This template is used for branches that activate a {{LivingStory}}.
Usage: {{Activate Living|<params>}}

The following parameters are available (note that all of them are case-sensitive):

Image

Image is an optional parameter to specify an image file to use for the template.

For example, {{Activate Living|Story=Remembering Millicent|image=Deportestration}} becomes

A living story will begin soon. (Activates the Living story Remembering Millicent; this message is not displayed.)

Note: The image name automatically has "small.png" appended.

Story

Story is a parameter that specifies which living story is activated, if it's known.

Example: {{Activate Living|Story=Remembering Millicent}} becomes

A living story will begin soon. (Activates the Living story Remembering Millicent; this message is not displayed.)

Unknown

Unknown is a parameter that is used when we know that a living story is activated, but do not yet know what the story is titled. This happens when we observe the activation of a new living story, but the living story has not yet triggered. This parameter suppresses the link that would otherwise be created.

Example: {{Activate Living|Unknown=yes}} becomes

A living story will begin soon. (Activates an unknown Living story; this message is not displayed.)

Display

Usually, the activation message of the living story is not shown. Set Display to yes if it is.

Example: {{Activate Living|Display=yes|Story=Remembering Millicent}} becomes

A living story will begin soon. (Activates the Living story Remembering Millicent)

Message

If Message is given, the contents of it will replace the normal "A living story will begin soon." text. Either Story or Unknown must still be given.

Example: {{Activate Living|Message=All shall be well.|Unknown=yes}} becomes

All shall be well. (Activates an unknown Living story; this message is not displayed.)

Example: {{Activate Living|Message=All shall be well.|Story=Remembering Millicent}} becomes

All shall be well. (Activates the Living story Remembering Millicent; this message is not displayed.)

This template is used for branches that activate a {{LivingStory}}.

Template parameters

Parameter		Description	Type	Status
Image	image Image	Icon file name (hidden unless in mail or web traffic) Default icon of the story if the page exists Example forest.png	Line	optional
Is the title unknown?	Unknown	If yes, will not link the living story. Use when title is unknown. Either this or {{{Story}}} is required. Overridden if {{{Story}}} is defined. Example yes	Unknown	optional
Message	Message	Message delivered by the game (often hidden) Example Strands of the could-have-been and never-were cling to you like vines. The Waswood’s influence is slow to fade."	String	suggested
Story	Story	Name of Living Story; either this or Unknown=yes is required Example Remembering Millicent	Page	required
Is the message displayed?	Display	If not "yes", will add "This message is not displayed." Default no Example yes	Boolean	optional