Latest revision as of 19:12, 31 July 2021

DiaryConfig

The xml element DiaryConfig defines the diary system properties.

The diary is defined with the following properties :


Property	Value
ReceiveMessageSound	The sound that are played when a role receive a diary note. The audio file should be located in the audio directory <C3FIRE-AUDIO> located at <C3FIRE-WWW- ROOT>/audio/. Value example = "sound.wav"
LineWrap	The text on a row in the diary box are automatically line wraped if the text is longer than the line. Value example= "true", "false" />

<Source>
 <DiaryConfig     
  ReceiveMessageSound = "bottle-open.wav" 
  LineWrap = "true" />
</Source>

@@ Line 1: / Line 1: @@
 {{DISPLAYTITLE:Diary Configuration}}
+=DiaryConfig=
+The xml element DiaryConfig defines the diary system properties.
+The diary is defined with the following properties :
+{| class="wikitable"
+|+
+|-
+!style="text-align: left;" |
+Property
+!style="text-align: left;" |
+Value
+|-
+|style="background-color:#bbeeff; vertical-align: text-top;"|
+ReceiveMessageSound
+|style="vertical-align: text-top;"|
+The sound that are played when a role receive a diary note.<br>
+The audio file should be located in the audio directory <C3FIRE-AUDIO> located at <C3FIRE-WWW-<br>ROOT>/audio/.
+Value example = "sound.wav"
+|-
+|style="background-color:#bbeeff; vertical-align: text-top;"|
+LineWrap
+|style="vertical-align: text-top;"|
+The text on a row in the diary box are automatically line wraped if the text is longer than the line.
+Value example= "true", "false" />
+|-
+|}
+<syntaxhighlight lang="xml">
+<Source>
+ <DiaryConfig
+  ReceiveMessageSound = "bottle-open.wav"
+  LineWrap = "true" />
+</Source>
+</syntaxhighlight>