On 09/07/11 01:54, Dag Wieers wrote:
On Fri, 8 Jul 2011, Lex Trotman wrote:
- I still think that the behaviour is very disturbing, even when
documented
- I wonder why comments need to go to the backend, because I do not
expect comments to be processed and translated to a back-end comment
(In fact, I was expecting comments to not appear in the final output,
they may contain confidential or private information !)
Then don't put them in.
Comments (<remarks> in docbook speak) are envisioned by the docbook
creators to be used for editorial purposes such as input from
reviewers, etc. The decision on them appearing in the final output,
eg PDF is determined by the docbook toolchain, usually by options. It
is not an Asciidoc decision.
Is there an alternative for using comments in my documentation for myself only ?
Imagine I write a CV, and I want to add TODO or FIXME items, or indicate that at
some later time I need to update a section.
You don't want that information exposed, ever. So I like to have real comments,
instead of 'remarks'.
Comment lines are only passed to the backend if the 'showcomments' attribute is
defined, comment blocks are never passed to the backend:
http://www.methods.co.nz/asciidoc/userguide.html#X25
Or am I missing something here?
Cheers, Stuart
~
- I could not find any information about inline comments in the AsciiDoc
document or what effect it has, could you elaborate ?
From User Guide 18.3.2 "Comment lines have been implemented as both
block and inline macros so a comment line can appear as a stand-alone
block or within block elements that support inline macro expansion".
I see, I understood something different.
--
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.
