Difference between revisions of "Command/ startcomment"

From Wiki
Jump to navigation Jump to search
(Created page with "Documentation for \start<i>comment</i> ... \stop<i>comment</i>")
 
 
Line 4: Line 4:
 
<cd:shortdesc>
 
<cd:shortdesc>
 
<!-- a short command summary goes here -->
 
<!-- a short command summary goes here -->
The instances of  <tt>\start<i>comment</i> ... \stop<i>comment</i></tt> are used for ...
+
The instances of  <tt>\start<i>comment</i> ... \stop<i>comment</i></tt> create PDF comments: little balloon or text icons that one can click to reveal the comment.
 
</cd:shortdesc>
 
</cd:shortdesc>
 
<cd:sequence>
 
<cd:sequence>
Line 27: Line 27:
 
</cd:variants>
 
</cd:variants>
 
<cd:description>
 
<cd:description>
<!-- the long description of the command goes here -->
+
Create PDF comments: little balloon or text icons that one can click to reveal the comment.
 +
If there is no text around the place the command is invoked, one needs to add {{cmd|dontleavehmode}} before {{cmd|startcomment}} (or before {{cmd|comment}}).
 +
 
 +
There is also a command form of this environment: {{gen|comment}}.
 
</cd:description>
 
</cd:description>
 
<cd:examples>
 
<cd:examples>
<!--  command example(s)
 
 
<cd:example title="">
 
<cd:example title="">
 +
<texcode>
 +
This is a text.
 +
\startcomment[hello]
 +
  [symbol=Balloon, % can be omitted for the default 'note-pinned-to-something' icon
 +
    color=red, % colour of the background of the note icon
 +
    width=4cm, % dimensions of the textbox
 +
    height=3cm]
 +
 +
  hello \leftguillemot\ \'e\'erste \rightguillemot\ test
 +
  beautiful
 +
 +
  world
 +
\stopcomment
 +
</texcode>
 
</cd:example>
 
</cd:example>
-->
 
 
</cd:examples>
 
</cd:examples>
 
<cd:notes>
 
<cd:notes>

Latest revision as of 10:14, 21 August 2020


\startcomment ... \stopcomment

Summary

The instances of \startcomment ... \stopcomment create PDF comments: little balloon or text icons that one can click to reveal the comment.

Instances

\startcomment ... \stopcomment

Settings instance

\startCOMMENT[...][...=...,...] ... \stopCOMMENT
[...]text
...=...,...inherits from \setupcomment

Description

Create PDF comments: little balloon or text icons that one can click to reveal the comment. If there is no text around the place the command is invoked, one needs to add \dontleavehmode before \startcomment (or before \comment).

There is also a command form of this environment: comment.

Examples

Example 1

This is a text.
\startcomment[hello]
   [symbol=Balloon, % can be omitted for the default 'note-pinned-to-something' icon
    color=red, % colour of the background of the note icon
    width=4cm, % dimensions of the textbox
    height=3cm]

  hello \leftguillemot\ \'e\'erste \rightguillemot\ test
  beautiful

  world
\stopcomment

Notes

See also

Help from ConTeXt-Mailinglist/Forum

All issues with: