doc/main/editing/man-versioning.en.tm

   1 <TeXmacs|1.0.7.4>
   2
   3 <style|tmdoc>
   4
   5 <\body>
   6   <tmdoc-title|Versioning tools>
   7
   8   When writing documents in collaboration with other authors, it frequently
   9   arises that one wants to go through changes made by the other authors, and
  10   either accept, discard or further correct them. After enabling the
  11   versioning tool through <menu|Edit|Preferences|Utilities|Versioning tool>,
  12   a<nbsp>special menu <menu|Version> appears in the main menu bar, which
  13   makes this process automatic. Let us describe in more detail how this tool
  14   works.
  15
  16   For the moment, automatic version control systems such as <name|Subversion>
  17   are not yet supported. In the future, we intend to include support for such
  18   systems and the operation of merging two different new versions.
  19
  20   <paragraph|Comparing two versions>
  21
  22   Assume that we have two versions <verbatim|old.tm> and <verbatim|new.tm> of
  23   the same document. In order to see the changes, first load the newest
  24   version <verbatim|new.tm>, then click on <menu|Version|File|Compare> and
  25   select the oldest version <verbatim|old.tm>. The buffer will still be named
  26   <verbatim|new.tm>, and the changes between both versions will be indicated
  27   by special markup. If there are any changes, then the cursor will be
  28   positioned at the first difference.
  29
  30   It is possible to go through all the differences between the old and new
  31   versions either from the items in the submenu <menu|Version|Move>, or using
  32   the keyboard shortcuts <key|C-up> and <key|C-down>. One may also use the
  33   more general structured navigation shortcuts <key|C-home>, <key|C-end>,
  34   <key|C-pageup> and <key|C-pagedown>.
  35
  36   <paragraph|Visualization of the differences>
  37
  38   Differences between the two versions can be displayed in three ways: by
  39   showing only the old version, only the new version, or both versions
  40   simultaneously. In all cases, the old version is displayed in dark red and
  41   the new version in dark green.
  42
  43   The visualization style can be specified individually for each individual
  44   change, via <menu|Version|Show> or the keyboard shortcuts <key|C-left> (old
  45   version), <key|C-right> (new version) and <key|C-\|> (both versions). One
  46   may also cycle through the different style using the structured variant key
  47   <key|C-tab>. If you selected some text, then the above actions will apply
  48   to the whole selection. The visualization style may also be specified
  49   globally, using <menu|Version|File|Show old version>,
  50   <menu|Version|File|Show new version> and <menu|Version|File|Show both
  51   versions>.
  52
  53   <paragraph|Retaining a specific version>
  54
  55   It often occurs that we want to go through the changes between two versions
  56   and progressively retain either one or the other version for each
  57   individual difference. Assuming that the cursor is inside a given
  58   difference, this can be done from entries in the submenu
  59   <menu|Version|Retain>. Alternatively, one may use the shortcuts <key|C-1>,
  60   <key|C-2> and <key|C-return> to retain the old, new and currently displayed
  61   version, respectively. If both versions are displayed, then <key|C-return>
  62   retains the new version. After retaining one of the versions, we
  63   automatically jump to the next difference, which can then be processed. If
  64   you selected some text, then any of the above action will retain the
  65   appropriate version for each of the differences in the selection.
  66
  67   It is also possible to globally select the old, new or current version
  68   using <menu|Version|File|Retain old version>, <menu|Version|File|Retain new
  69   version>, <abbr|resp.> <menu|Version|File|Retain current version>. A
  70   convenient alternative way to process all differences is to use <key|C-up>
  71   and <key|C-down> to go through the differences, use <key|C-left> and
  72   <key|C-right> to select the preferred version, and then click on
  73   <menu|Version|File|Retain current version> as soon as all differences have
  74   been processed.
  75
  76   <tmdoc-copyright|2010|Joris van der Hoeven>
  77
  78   <tmdoc-license|Permission is granted to copy, distribute and/or modify this
  79   document under the terms of the GNU Free Documentation License, Version 1.1
  80   or any later version published by the Free Software Foundation; with no
  81   Invariant Sections, with no Front-Cover Texts, and with no Back-Cover
  82   Texts. A copy of the license is included in the section entitled "GNU Free
  83   Documentation License".>
  84 </body>
  85
  86 <\initial>
  87   <\collection>
  88     <associate|language|english>
  89   </collection>
  90 </initial>