====== Text guidelines reference document ======

Rules and information used in [[en:primitive:mission:start|mission creation]].

See [[en:primitive:mission:rite_nomenclature_guidelines|nomenclature guidelines reference document]] for help on creating tags for rites.

===== Generic phrase requirements =====

  * Using directly a phrase tag that refers to an existing string in the translated file.
<WRAP box 95%>
Example:
\\ **PHRASE_TAG**
\\ There must be a phrase in the translated file with the “PHRASE_TAG” tag.
</WRAP>
<WRAP clear></WRAP>

For objectives with several items (kill different creatures, forage different MPs …) the nomenclature would be the following:
<WRAP box 95%>
**PHRASE_TAG _1
\\ PHRASE_TAG _2
\\ PHRASE_TAG _3
\\ … **
</WRAP>


  * Using a variable. All that is needed is to have declared the variable, and set it.
<WRAP box 95%>
Example:
\\ **$variable$**
</WRAP>

  * Using directly a written phrase and a suffix. In that case the compiler will generate an entry in the phrase file with a tag of this structure:
<WRAP box 95%>
Entered info: **“This is the phrase that will be showed to the happy players” MY_PHRASE_SUFFIX**
\\ Generated phrase tag: **Mission_name_MY_PHRASE_SUFFIX**
</WRAP>
 

  * Using variables in a written phrase is possible, whether the variable is custom or default.
<WRAP box 95%>
Example: for a Give_to mission with 2 objects of one type needed for the npc which name is declared in the $receiver$ custom variable.
\\ Entered info: **“You have to bring back $qt1$ $i1$ to $receiver$, the wise man that lives in the other city.” MY_PHRASE_SUFFIX**
\\ Generated phrase tag: **Mission_name_MY_PHRASE_SUFFIX**
</WRAP>


For objectives with several items (kill different creatures, forage different MPs …) the nomenclature would be the following.
<WRAP box 95%>
<WRAP column 30%>
Entered info:
\\ **“phrase one”
\\ “phrase two”
\\ “phrase three”
\\ MY_PHRASE_SUFFIX**
</WRAP>

<WRAP column 60%>
Generated tags:
\\ **Mission_name_MY_PHRASE_SUFFIX_1
\\ Mission_name_MY_PHRASE_SUFFIX_2
\\ Mission_name_MY_PHRASE_SUFFIX_3**
</WRAP>
</WRAP>
 
===== Text overload =====

All text can be overloaded in case the default phrase doesn’t fit. To do so, you can enter your own phrase in the phrase field. But in case you are using default instruction variable it is recommended that you use the exact spelling of the variable. For any custom variable that you may have, use its own spelling.

See each parameter description for information on related default parameters.

<WRAP box 95%>
Example:
\\ For a forage where you need to forage 3 MPs of a kind without need for a specific quality, and 1 MP of another kind but with a quality minimum.
\\ Entered info:     **“You have to forage $qt1$ pieces of $i1$, and one piece of $i2$ of $qual2$ quality.” MY_PHRASE_SUFFIX**
\\ Generated phrase tag: **Mission_name_MY_PHRASE_SUFFIX**
</WRAP>
 

 
===== Important notes =====

  * The compiler doesn’t interpret carrier returns in plain text. If you want to skip to the next line, you have to use the “\n” instruction in your text.
  * Of course, each suffix needs to be unique for a given mission.


{{tag>primitives ryzom_core}}