On Mon, 5 Dec 2011, Stuart Rackham wrote:
On 05/12/11 18:56, Lex Trotman wrote:
On Mon, Dec 5, 2011 at 3:47 PM, Stuart Rackham<[email protected]> wrote:
> Here's my question: if you are are authoring a document using asciidoc
> (i.e.
> not lowriter) what is the point of passing comments through to ODF?
I think there is a good use-case for comment type content that is
optionally visible in the output (eg "this multi-line list of things
need to be done before release") and content that is never visible in
the output (eg commenting out sections that don't apply yet).
Since this is "out-of-band" content, if it is visible it should be
visually distinct from normal annotations (at least it should allow it
to be styled as such) and so using standard annotations isn't
appropriate.
In standard asciidoc, comment blocks are never visible, whilst the
comment lines are optionally visible. So all that is missing is an
optional multiline entity. I don't see a problem with this being in
the form of another annotation with a "comment" style generating
<remark role="comment-annotation"> for docbook,<office:annotation>
for ODT and<p class="comment-annotation"> for HTML if :showcomments:
is set.
I think you're probably right Lex. I just wonder if using the existing
comment block syntax might add a bit of consistency e.g.
[annotation,dag,2011-12-03]
/////////////////////////////////////////////////////////
FIXME: Insert the various features from the Release Notes
include the information from the presentations
/////////////////////////////////////////////////////////
Lex got it :) Often when you work (together) on producing a document (eg.
a reference architecture or customer proposal) you need to communicate
what parts are not finished or need review. So the process consists of two
stages, one where all output produced contains the comments/annotations
and a second where the output does not contain any 'inside' information to
the final reader.
That's why I like the fact that inline comments or quite similar to
annotations when enabling 'showcomments' and in fact that was my intention
from the start. But at the moment I have 'showcomments' and
'hideannotations', where comments are not enabled in the output by default
(for ODF) while annotations are (because they are not printed by default).
Even better would be to influence the ODF (using config elements) to
enable or disable the printing of annotations, which I think is possible.
That way you can control whether they are in the PDF too, or not.
My preference is your example. As this merges the concepts and annotations
better. I guess that needs a change to AsciiDoc as commentblocks are now
being ignored, or am I wrong (again) ? :)
--
-- dag wieers, [email protected], http://dag.wieers.com/
-- dagit linux solutions, [email protected], http://dagit.net/
[Any errors in spelling, tact or fact are transmission errors]
--
You received this message because you are subscribed to the Google Groups
"asciidoc" group.
To post to this group, send email to [email protected].
To unsubscribe from this group, send email to
[email protected].
For more options, visit this group at
http://groups.google.com/group/asciidoc?hl=en.
