View source for Comments

Sometimes it is helpful to document or explain parts of your blazon, or to temporarily ignore parts, or to include parts of the blazon which cannot actually be drawn by <ds/> but you still want to have present. You may also wish to include the name of the armiger within the blazon text but obviously this should be considered part of the blazon to be drawn. <ds/> supports several mechanisms for this purpose.

===Indicating the Armiger===

To show to whom a particular coat of arms belongs to we often find the convention that the holder's name is shown after the blazon, and separated from it by one or two dashes. <ds/> support this, as for example in <example>Azure semy of fleur-de-lys or -- France Ancient</example>. Note that it is only dashes on their own that are recognised for this purpose, those within words are treated as spaces.

===Words to Ignore===

If there are particular words or phrases that appear in a blazon but are not supported by <ds/> they can be surrounded by round brackets, and are then ignored. For example, <example>azure (diapered)</example> will just be drawn as azure.

<note>The parts of the blazon within round brackets are considered part of the blazon, so they are included in error messages and wherever the blazon itself is shown as text.</note>

===Program Style Comments===

Sometimes when trying to get <ds/> to do what we want it is easiest if we can start small - perhaps by ignoring large parts of a complex blazon. There may also be times that we want to write short notes to ourselves to remind us of something we intend to add later. For these, and other purposes, <ds/> supports various types of comments commonly found in programming languages.

There are two methods to make <ds/> ignore the rest of the current line. All characters including and after a '#' (hash character) are ignored, as are all characters including and after '//' (two forward slash characters).

To remove longer sections of text, or to remove shorter parts within a single line we can use the commenting style used in Java and 'C/C++' programs and enclose unwanted text between the characters '/*' and '*/'.

If you are using the "fancy" editor on the '''Create from a blazon''' page then all these types of program-style comment will be highlighted in pink.

<note>Text within program style comments is stripped out at a very early stage of processing and never appears in error messages or anywhere else the blazon is shown as text.</note>


[[Category:Grammar]]