Difference between revisions of "Command/setupcomment"

From Wiki
Jump to navigation Jump to search
m (Text replace - "== Help from ConTeXt-Forum ==" to "== Help from ConTeXt-Mailinglist/Forum ==")
(4 intermediate revisions by 3 users not shown)
Line 3: Line 3:
 
|attributes=
 
|attributes=
 
}}
 
}}
 +
 +
== [[Help:Reference|Syntax]] (autogenerated) ==
 +
<syntax>setupcomment</syntax>
  
 
== [[Help:Reference|Syntax]] ==
 
== [[Help:Reference|Syntax]] ==
Line 12: Line 15:
 
     <td class="cmd">[[Command/keyword:state|state]]</td>
 
     <td class="cmd">[[Command/keyword:state|state]]</td>
 
     <td>[[Command/value:start|start]] [[Command/value:stop|stop]] </td>
 
     <td>[[Command/value:start|start]] [[Command/value:stop|stop]] </td>
 +
  </tr>
 +
  <tr valign="top" class="first">
 +
    <td class="cmd">[[Command/keyword:method|method]]</td>
 +
    <td>[[Command/value:normal|normal]] [[Command/value:hidden|hidden]] </td>
 
   </tr>
 
   </tr>
 
   <tr valign="top" class="first">
 
   <tr valign="top" class="first">
 
     <td class="cmd">[[Command/keyword:width|width]]</td>
 
     <td class="cmd">[[Command/keyword:width|width]]</td>
     <td>[[Command/value:dimension|dimension]] </td>
+
     <td>[[Command/value:dimension|dimension]] [[Command/value:fit|fit]]</td>
 
   </tr>
 
   </tr>
 
   <tr valign="top" class="first">
 
   <tr valign="top" class="first">
 
     <td class="cmd">[[Command/keyword:height|height]]</td>
 
     <td class="cmd">[[Command/keyword:height|height]]</td>
     <td>[[Command/value:dimension|dimension]] </td>
+
     <td>[[Command/value:dimension|dimension]] [[Command/value:fit|fit]]</td>
 +
  </tr>
 +
  <tr valign="top" class="first">
 +
    <td class="cmd">[[Command/keyword:depth|depth]]</td>
 +
    <td>[[Command/value:dimension|dimension]] [[Command/value:fit|fit]]</td>
 +
  </tr>
 +
  <tr valign="top" class="first">
 +
    <td class="cmd">[[Command/keyword:nx|nx]]</td>
 +
    <td>[[Command/value:number|number]]</td>
 +
  </tr>
 +
  <tr valign="top" class="first">
 +
    <td class="cmd">[[Command/keyword:ny|ny]]</td>
 +
    <td>[[Command/value:number|number]]</td>
 +
  </tr>
 +
  <tr valign="top" class="first">
 +
    <td class="cmd">[[Command/keyword:textlayer|textlayer]]</td>
 +
    <td>[[Command/value:name|name]]</td>
 +
  </tr>
 +
  <tr valign="top" class="first">
 +
    <td class="cmd">[[Command/keyword:location|location]]</td>
 +
    <td>[[Command/value:high|high]] [[Command/value:none|none]] [[Command/value:text|text]] [[Command/value:leftedge|leftedge]] [[Command/value:rightedge|rightedge]] [[Command/value:inmargin|inmargin]] [[Command/value:leftmargin|leftmargin]] [[Command/value:rightmargin|rightmargin]] </td>
 
   </tr>
 
   </tr>
 
   <tr valign="top" class="first">
 
   <tr valign="top" class="first">
Line 27: Line 54:
 
   <tr valign="top" class="first">
 
   <tr valign="top" class="first">
 
     <td class="cmd">[[Command/keyword:title|title]]</td>
 
     <td class="cmd">[[Command/keyword:title|title]]</td>
 +
    <td>[[Command/value:text|text]] </td>
 +
  </tr>
 +
  <tr valign="top" class="first">
 +
    <td class="cmd">[[Command/keyword:subtitle|subtitle]]</td>
 +
    <td>[[Command/value:text|text]] </td>
 +
  </tr>
 +
  <tr valign="top" class="first">
 +
    <td class="cmd">[[Command/keyword:author|author]]</td>
 
     <td>[[Command/value:text|text]] </td>
 
     <td>[[Command/value:text|text]] </td>
 
   </tr>
 
   </tr>
Line 35: Line 70:
 
   <tr valign="top" class="first">
 
   <tr valign="top" class="first">
 
     <td class="cmd">[[Command/keyword:symbol|symbol]]</td>
 
     <td class="cmd">[[Command/keyword:symbol|symbol]]</td>
     <td>[[Command/value:normal|normal]] [[Command/value:New|New]] [[Command/value:Balloon|Balloon]] [[Command/value:Addition|Addition]] [[Command/value:Help|Help]] [[Command/value:Paragraph|Paragraph]] [[Command/value:Key|Key]] [[Command/value:name|name]] </td>
+
     <td> [[Command/value:Default|Default]] [[Command/value:Comment|Comment]] [[Command/value:Help|Help]] [[Command/value:Insert|Insert]] [[Command/value:Key|Key]] [[Command/value:Newparagraph|Newparagraph]] [[Command/value:Note|Note]] [[Command/value:Paragraph|Paragraph]] </td>
 
   </tr>
 
   </tr>
 
   <tr valign="top" class="first">
 
   <tr valign="top" class="first">
 
     <td class="cmd">[[Command/keyword:option|option]]</td>
 
     <td class="cmd">[[Command/keyword:option|option]]</td>
     <td>[[Command/value:max|max]] [[Command/value:buffer|buffer]] </td>
+
     <td>[[Command/value:max|max]] [[Command/value:xml|xml]] ([[Command/value:buffer|buffer]]?) </td>
 
   </tr>
 
   </tr>
 
   <tr valign="top" class="first">
 
   <tr valign="top" class="first">
     <td class="cmd">[[Command/keyword:margin|margin]]</td>
+
     <td class="cmd">[[Command/keyword:buffer|buffer]]</td>
     <td>[[Command/value:dimension|dimension]] </td>
+
     <td>[[Command/value:buffer|buffer]] </td>
 
   </tr>
 
   </tr>
 
   <tr valign="top" class="first">
 
   <tr valign="top" class="first">
 
     <td class="cmd">[[Command/keyword:distance|distance]]</td>
 
     <td class="cmd">[[Command/keyword:distance|distance]]</td>
 
     <td>[[Command/value:dimension|dimension]] </td>
 
     <td>[[Command/value:dimension|dimension]] </td>
 +
  </tr>
 +
  <tr valign="top" class="first">
 +
    <td class="cmd">[[Command/keyword:margin|margin]]</td>
 +
    <td>[[Command/value:dimension|dimension]] (MkII?)</td>
 
   </tr>
 
   </tr>
 
</table>
 
</table>
 
  
 
== Description ==  
 
== Description ==  
 +
Set the default settings.
  
 +
== Example ==
 +
<texcode>
 +
\setupcomment[color=blue]
  
 +
Some text to which a comment applies
  
== Example ==
+
\startcomment[symbol=Balloon]
<!-- Please fill in an example if you can -->
+
    This is my comment
 +
\stopcomment
 +
</texcode>
  
 
== See also ==
 
== See also ==
<!-- something like [[cmd:goto|\goto]] -->
+
* {{cmd|startcomment}} to create a PDF comment
 +
* {{cmd|comment}} should also create a PDF comment (might not work in MkII).
  
 
== Help from ConTeXt-Mailinglist/Forum ==
 
== Help from ConTeXt-Mailinglist/Forum ==
Line 66: Line 112:
 
{{Forum|{{SUBPAGENAME}}}}
 
{{Forum|{{SUBPAGENAME}}}}
  
[[Category:Commands|setupcomment]]
+
[[Category:Command/Interaction|setupcomment]]

Revision as of 16:14, 11 November 2019

\setupcomment

Syntax (autogenerated)

\setupcomment[...,...][...=...,...]
[...,...]name
statestart stop none
methodnormal hidden
symbolComment Help Insert Key Newparagraph Note Paragraph Default
widthfit dimension
heightfit dimension
depthfit dimension
titletext
subtitletext
authortext
nxnumber
nynumber
colorcolor
optionxml max
textlayername
locationleftedge rightedge inmargin leftmargin rightmargin text high none
distancedimension
spaceyes
bufferbuffer


Syntax

\setupcomment[...,...=...,...]
state start stop
method normal hidden
width dimension fit
height dimension fit
depth dimension fit
nx number
ny number
textlayer name
location high none text leftedge rightedge inmargin leftmargin rightmargin
color name
title text
subtitle text
author text
space yes no
symbol Default Comment Help Insert Key Newparagraph Note Paragraph
option max xml (buffer?)
buffer buffer
distance dimension
margin dimension (MkII?)

Description

Set the default settings.

Example

\setupcomment[color=blue]

Some text to which a comment applies

\startcomment[symbol=Balloon]
    This is my comment
\stopcomment

See also

  • \startcomment to create a PDF comment
  • \comment should also create a PDF comment (might not work in MkII).

Help from ConTeXt-Mailinglist/Forum

All issues with: