First login?
Lost password?
 
 
 
mailing-list for TeXmacs Users

Text archives Help


facilities to comment documents


Chronological Thread 
  • From: Massimiliano Gubinelli <address@hidden>
  • To: texmacs-users <address@hidden>
  • Subject: facilities to comment documents
  • Date: Fri, 4 Dec 2020 08:08:47 +0100
Dear all,
discussing with some friends I became aware of some advantage of
unstructured editing for which we should provide some alternative. This is
the possibility (common in programming, but also in some research workflow)
to add comments on a document which will not appear in the final version
(i.e. in the PDF, on in the HTML or LaTeX export -- In some sense, the dual
of literate programming, maybe we can call it co-literate editing :)).

These comments can be parts of the document one do not want to make to the
final version, or just reminders to explore some directions, or parts one has
to cut because of editorial constraints or referees comments, but anyway one
wants to keep in place and not just delete them (because maybe the paper has
a short and long versions). These comments can also be simply discussion
between various co-authors, so it would be nice if they carry tags, like the
name of the author. And then have a macro facility to view only certain
subclasses of comments and make them invisible (i.e. just leave a flag or
some other indicator which do not modify the typesetting) if the user wants.
This should not be difficult to code, is something similar to the versioning
markup we already have, but I think it would be a useful addition to everyday
workflows.
It could also be a way to edit the metadata in the document.

Of course one has (at least) two options to design such a facility: make the
additional content editable as part of the document (as in the proposal
above), or keep it in the document as always invisible and make it editable
only via some separate GUI element, i.e. a dialog with an embedded editor
(like we have now for search and replace, for example, or for the macro
editor). I think I would prefer the first approach, though.

Thoughts, ideas, comments, on such a facility?

Max

ps: on a similar direction a document can have a "draft" mode where markups
like \todo or these comments are visible and a "final" mode, where they are
invisible.


Archive powered by MHonArc 2.6.19.

Top of page