ntg-context - mailing list for ConTeXt users
 help / color / mirror / Atom feed
* Documentation of change / Evolving documents
@ 2019-01-19  8:06 Axel Kielhorn
  2019-09-29  6:59 ` Axel Kielhorn
  0 siblings, 1 reply; 6+ messages in thread
From: Axel Kielhorn @ 2019-01-19  8:06 UTC (permalink / raw)
  To: ntg-context

Hi,

I often have documents that are not finished but need to change over time.
A client changes their mind, laws are changed, …

While working with the document, I want to see the changes.
When the document is finally finished, I only want to see the change history.

I came up with the following.
When the mode is „change“  the date (or version) is shown in the margin and the change is printed in red.
Without mode „change“ only the change history is printed.

What I want now is to change the layout of the register.
Adding some vspace around the date and printing the date in bold.
Is there a way to achieve this or am I on the wrong way?
(Should the date be the indicator, thus giving me the layout I want?)

\enablemode[change]

\setuppapersize [A4][A4]
\setuplayout    [width=middle,  backspace=1.5in, cutspace=1.5in,
                 height=middle, topspace=0.75in, bottomspace=0.75in]

\setupbodyfont[11pt]

\defineregister [change]
\setupregister  [change] [
  indicator=no          %% no letter
      style=sansbold,   %% headings
  textstyle=slanted,    %% entries
  pagestyle=bolditalic, %% page refs
          n=1,          %% columns
]

\def\ChangeV#1#2{\change{#1+#2}\doifmode{change}{\inmargin{\tx #1}{\red #2\par}}}
\def\ChangeD#1#2{\change{#1+#2}\doifmode{change}{\inmargin{\tx #1}{\red #2\par}}}

\starttext

\ChangeV{V. 1.0}{Fertig!}
\input knuth

\ChangeD{2018-12-22}{Fertig!}

\ChangeD{2018-12-23}{Letzter Fehler beseitigt.}
\input knuth

\ChangeD{2018-12-23}{Allerletzter Fehler beseitigt.}

Ende

\startsection[title={History}]

\placechange

\stopsection

\stoptext


___________________________________________________________________________________
If your question is of interest to others as well, please add an entry to the Wiki!

maillist : ntg-context@ntg.nl / http://www.ntg.nl/mailman/listinfo/ntg-context
webpage  : http://www.pragma-ade.nl / http://context.aanhet.net
archive  : https://bitbucket.org/phg/context-mirror/commits/
wiki     : http://contextgarden.net
___________________________________________________________________________________

^ permalink raw reply	[flat|nested] 6+ messages in thread

* Re: Documentation of change / Evolving documents
  2019-01-19  8:06 Documentation of change / Evolving documents Axel Kielhorn
@ 2019-09-29  6:59 ` Axel Kielhorn
  2019-09-29  8:36   ` Henning Hraban Ramm
  0 siblings, 1 reply; 6+ messages in thread
From: Axel Kielhorn @ 2019-09-29  6:59 UTC (permalink / raw)
  To: ntg-context

[-- Attachment #1: Type: text/plain, Size: 982 bytes --]


> Am 19.01.2019 um 09:06 schrieb Axel Kielhorn <tex@axelkielhorn.de>:

Earlier this year I wrote a first attempt to document evolving documents.
In the meantime this document has evolved and I included the current version here.

There is only one thing I don’t like:

Currently I write:

\ChangeA{V. 2.0}{Mit den Befehlen \type{\Changea}, \type{\Changer} und \type{\Changec} werden hinzugefügte, gelöschte oder geänderte Satzteile gekennzeichnet. Der Befehl \type{\Changec} hat zwei Argumente: alter Text und neuer Text.}

But I would prefer to write

\startChangeA{V. 2.0}
Mit den Befehlen \type{\Changea}, \type{\Changer} und \type{\Changec} werden hinzugefügte, gelöschte oder geänderte Satzteile gekennzeichnet. Der Befehl \type{\Changec} hat zwei Argumente: alter Text und neuer Text.
\stopChangeA

Or maybe:
\startChangeA[version={V. 2.0}]

Once this is fixed I’d like to translate it to english and put it into the Wiki.

Greetings
Axel


[-- Attachment #2: context_change.tex --]
[-- Type: application/octet-stream, Size: 2823 bytes --]

% !TEX TS-program = ConTeXt (LuaTeX 1.0.9)
% !TEX encoding = UTF-8 Unicode

% Copyright 2018 - 2019 Axel Kielhorn
% Lizenz: CC-BY-SA 4.0 Unported http://creativecommons.org/licenses/by-sa/4.0/deed.de

\enablemode[change]
\setuphyphenation[method=expanded]

\language[de]
\mainlanguage[de]
\setbreakpoints[compound]

\setuppapersize [A4][A4]
\setuplayout    [width=middle,  backspace=1.5in, cutspace=1.5in,
                 height=middle, topspace=0.75in, bottomspace=0.75in]

\setupbodyfont[11pt]

% Register für Version

\defineregister [changev]
\setupregister  [changev] [
  indicator=no          %% no letter
      style=sansbold,   %% headings
  textstyle=slanted,    %% entries
  pagestyle=bolditalic, %% page refs
          n=1,          %% columns
]

% Register für Datum

\defineregister [changed]
\setupregister  [changed] [
  indicator=no          %% no letter
      style=sansbold,   %% headings
  textstyle=slanted,    %% entries
  pagestyle=bolditalic, %% page refs
          n=1,          %% columns
]

\def\ChangeV#1#2{\changev{#1+#2}\doifmode{change}{\inmargin{\tx #1}{\blue #2\par}}}
\def\ChangeD#1#2{\changed{#1+#2}\doifmode{change}{\inmargin{\tx #1}{\blue #2\par}}}

% Paragraph added
\def\ChangeA#1#2{\doifmode{change}{\inmargin{\tx #1}\startsidebar[rulecolor=darkgreen]}#2\doifmode{change}{\stopsidebar}}
% Paragraph removed
\def\ChangeR#1#2{\doifmode{change}{\inmargin{\tx #1}\startsidebar[rulecolor=red]#2\stopsidebar}}

\def\Changer#1{{\doifmode{change}{\red #1}}}
\def\Changea#1{{\doifmode{change}{\darkgreen}#1}}
\def\Changec#1#2{{\doifmode{change}{\red #1\darkgreen}#2}}

\starttext

\ChangeV{V. 1.0}{Fertig!}
\ChangeR{V. 2.0}{\input knuth}

\ChangeD{2018-12-22}{Fertig!}

\ChangeD{2018-12-23}{Letzter Fehler beseitigt.}
\ChangeA{V. 2.0}{\input knuth}

\ChangeD{2018-12-23}{Allerletzter Fehler beseitigt.}

In diesem Satz war ein \Changec{Fähler}{Fehler}.

\ChangeV{V. 2.0}{Farben geändert}
\ChangeA{V. 2.0}{Die Änderungskommentare werden jetzt in {\blue blau} ausgegeben, da {\red rot} für gelöschte Texte und {\darkgreen grün} für hinzugefügte Texte verwendet wird.}

\ChangeV{V. 2.0}{Neue Befehle \type{ChangeA}, \type{ChangeR}, \type{Changea}, \type{Changer} und \type{Changec}}
\ChangeA{V. 2.0}{Mit den Befehlen \type{\ChangeA} und \type{\ChangeR} werden hinzugefügte bzw. gelöschte Absätze gekennzeichnet.}

\ChangeA{V. 2.0}{Mit den Befehlen \type{\Changea}, \type{\Changer} und \type{\Changec} werden hinzugefügte, gelöschte oder geänderte Satzteile gekennzeichnet. Der Befehl \type{\Changec} hat zwei Argumente: alter Text und neuer Text.}

Ende

\startsection[title={History}]

Nach Versionsnummer:

\placechangev

\blank[big]
Nach Datum:

\placechanged

\stopsection

\stoptext

[-- Attachment #3: Type: text/plain, Size: 3 bytes --]





[-- Attachment #4: Type: text/plain, Size: 493 bytes --]

___________________________________________________________________________________
If your question is of interest to others as well, please add an entry to the Wiki!

maillist : ntg-context@ntg.nl / http://www.ntg.nl/mailman/listinfo/ntg-context
webpage  : http://www.pragma-ade.nl / http://context.aanhet.net
archive  : https://bitbucket.org/phg/context-mirror/commits/
wiki     : http://contextgarden.net
___________________________________________________________________________________

^ permalink raw reply	[flat|nested] 6+ messages in thread

* Re: Documentation of change / Evolving documents
  2019-09-29  6:59 ` Axel Kielhorn
@ 2019-09-29  8:36   ` Henning Hraban Ramm
  2019-09-29  8:50     ` Wolfgang Schuster
  0 siblings, 1 reply; 6+ messages in thread
From: Henning Hraban Ramm @ 2019-09-29  8:36 UTC (permalink / raw)
  To: mailing list for ConTeXt users


> Am 2019-09-29 um 08:59 schrieb Axel Kielhorn <tex@axelkielhorn.de>:
> 
> But I would prefer to write
> 
> \startChangeA{V. 2.0}
> Mit den Befehlen \type{\Changea}, \type{\Changer} und \type{\Changec} werden hinzugefügte, gelöschte oder geänderte Satzteile gekennzeichnet. Der Befehl \type{\Changec} hat zwei Argumente: alter Text und neuer Text.
> \stopChangeA

See https://wiki.contextgarden.net/Command/definestartstop

> Or maybe:
> \startChangeA[version={V. 2.0}]

This could help: https://wiki.contextgarden.net/System_Macros/Handling_Arguments

> Once this is fixed I’d like to translate it to english and put it into the Wiki.

Looking forward to it.


Grüßlinge, Hraban
---
https://www.fiee.net
http://wiki.contextgarden.net
https://www.dreiviertelhaus.de
GPG Key ID 1C9B22FD

___________________________________________________________________________________
If your question is of interest to others as well, please add an entry to the Wiki!

maillist : ntg-context@ntg.nl / http://www.ntg.nl/mailman/listinfo/ntg-context
webpage  : http://www.pragma-ade.nl / http://context.aanhet.net
archive  : https://bitbucket.org/phg/context-mirror/commits/
wiki     : http://contextgarden.net
___________________________________________________________________________________

^ permalink raw reply	[flat|nested] 6+ messages in thread

* Re: Documentation of change / Evolving documents
  2019-09-29  8:36   ` Henning Hraban Ramm
@ 2019-09-29  8:50     ` Wolfgang Schuster
  2019-09-29 12:34       ` Axel Kielhorn
  0 siblings, 1 reply; 6+ messages in thread
From: Wolfgang Schuster @ 2019-09-29  8:50 UTC (permalink / raw)
  To: mailing list for ConTeXt users, Henning Hraban Ramm

Henning Hraban Ramm schrieb am 29.09.2019 um 10:36:
>> Am 2019-09-29 um 08:59 schrieb Axel Kielhorn <tex@axelkielhorn.de>:
>>
>> But I would prefer to write
>>
>> \startChangeA{V. 2.0}
>> Mit den Befehlen \type{\Changea}, \type{\Changer} und \type{\Changec} werden hinzugefügte, gelöschte oder geänderte Satzteile gekennzeichnet. Der Befehl \type{\Changec} hat zwei Argumente: alter Text und neuer Text.
>> \stopChangeA
> See https://wiki.contextgarden.net/Command/definestartstop

Another option: https://wiki.contextgarden.net/Command/startuserdata

Wolfgang

___________________________________________________________________________________
If your question is of interest to others as well, please add an entry to the Wiki!

maillist : ntg-context@ntg.nl / http://www.ntg.nl/mailman/listinfo/ntg-context
webpage  : http://www.pragma-ade.nl / http://context.aanhet.net
archive  : https://bitbucket.org/phg/context-mirror/commits/
wiki     : http://contextgarden.net
___________________________________________________________________________________

^ permalink raw reply	[flat|nested] 6+ messages in thread

* Re: Documentation of change / Evolving documents
  2019-09-29  8:50     ` Wolfgang Schuster
@ 2019-09-29 12:34       ` Axel Kielhorn
  2019-10-11  8:18         ` Axel Kielhorn
  0 siblings, 1 reply; 6+ messages in thread
From: Axel Kielhorn @ 2019-09-29 12:34 UTC (permalink / raw)
  To: ntg-context


> Am 29.09.2019 um 10:50 schrieb Wolfgang Schuster <wolfgang.schuster.lists@gmail.com>:
> 
> Henning Hraban Ramm schrieb am 29.09.2019 um 10:36:
>>> Am 2019-09-29 um 08:59 schrieb Axel Kielhorn <tex@axelkielhorn.de>:
>>> 
>>> But I would prefer to write
>>> 
>>> \startChangeA{V. 2.0}
>>> Mit den Befehlen \type{\Changea}, \type{\Changer} und \type{\Changec} werden hinzugefügte, gelöschte oder geänderte Satzteile gekennzeichnet. Der Befehl \type{\Changec} hat zwei Argumente: alter Text und neuer Text.
>>> \stopChangeA
>> See https://wiki.contextgarden.net/Command/definestartstop
> 
> Another option: https://wiki.contextgarden.net/Command/startuserdata
> 
> Wolfgang

Thanks!
I’ll look into next weekend.

Greetings Axel

___________________________________________________________________________________
If your question is of interest to others as well, please add an entry to the Wiki!

maillist : ntg-context@ntg.nl / http://www.ntg.nl/mailman/listinfo/ntg-context
webpage  : http://www.pragma-ade.nl / http://context.aanhet.net
archive  : https://bitbucket.org/phg/context-mirror/commits/
wiki     : http://contextgarden.net
___________________________________________________________________________________

^ permalink raw reply	[flat|nested] 6+ messages in thread

* Re: Documentation of change / Evolving documents
  2019-09-29 12:34       ` Axel Kielhorn
@ 2019-10-11  8:18         ` Axel Kielhorn
  0 siblings, 0 replies; 6+ messages in thread
From: Axel Kielhorn @ 2019-10-11  8:18 UTC (permalink / raw)
  To: ntg-context

Hello!

I have added my document about evolving documents to the Wiki at:

https://wiki.contextgarden.net/Changes_Evolution

and included it into the list of sample documents.

Share and enjoy

Axel
___________________________________________________________________________________
If your question is of interest to others as well, please add an entry to the Wiki!

maillist : ntg-context@ntg.nl / http://www.ntg.nl/mailman/listinfo/ntg-context
webpage  : http://www.pragma-ade.nl / http://context.aanhet.net
archive  : https://bitbucket.org/phg/context-mirror/commits/
wiki     : http://contextgarden.net
___________________________________________________________________________________

^ permalink raw reply	[flat|nested] 6+ messages in thread

end of thread, other threads:[~2019-10-11  8:18 UTC | newest]

Thread overview: 6+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2019-01-19  8:06 Documentation of change / Evolving documents Axel Kielhorn
2019-09-29  6:59 ` Axel Kielhorn
2019-09-29  8:36   ` Henning Hraban Ramm
2019-09-29  8:50     ` Wolfgang Schuster
2019-09-29 12:34       ` Axel Kielhorn
2019-10-11  8:18         ` Axel Kielhorn

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).