next up previous contents index
Next: \design_date Up: Diagram header specific operators Previous: \color_front   Contents   Index

Subsections

\comment

Description 

Operator to free comment the diagram. It can contain history of the model or global indications (paper size, colors etc ...). Operator takes a string parameter which is the comment. Comments are written in the first page of the diagram, after authors name and title. Only three lines of comments is enabled, if the parser finds more than three occurrences of \comment in the diagram header a warning is produced and only the three first comments are considered.

Usage

\diagram_header {
  ...
  \comment("I'm proud to present my first origami creation.");
  \comment("Difficulty : intermediate.");
  \comment("Use a 30 cm paper, 70gr.");
  \comment("This comment won't appear on diagram");
  ...
}

Formal structure

  \comment(COMMENT_STRING);

Parameters

  COMMENT_STRING
  Description    : Indicates the comment string. 
  Type           : String.
  Allowed values : Any well formed string (between two double-quotes (")).



Doodle reference manual HTML version generated using LaTeX2HTML by Jérôme Gout, 2001-10-29
Doodle is hosted by Sourceforge, go to SourceForge Logo for more information
©2000-2001 Doodle