Svn:keywords

From The Document Foundation Wiki
Jump to: navigation, search

Most version control systems support the inclusion of information of the state of the file in the version control system. Most of the time this is done by the inclusion of a special tag inside the text. Sometimes (as it is the case for subversion) some special properties have to be set to allow the version control system to fill them with information afterwards.

Showing the svn:keywords and similar tags is supported by LibreOffice if the documents are saved in flat XML format which is a variant of the ordinary open document formats that represents the data in a human-readable form that can be read by the version control system as well

Adding svn:keywords tags to the document

Just type in one or more of the following tags where you want them to appear in the document:

  • $Date: $
  • $Revision: $
  • $Author: $
  • $HeadURL: $
  • $Id: $

For a detailled description of their meening see http://svnbook.red-bean.com/en/1.5/svn.advanced.props.special.keywords.html

Saving the file

The file has to be saved in the flat xml formats to make keyword substitution work. Just choose the right format in the "save" dialogue or replace the ending ".odt" by ".fodt" when typing in the filename.

Telling subversion to fill the tags with life

TortoiseSVN

  • Right-click on the file
  • Press tortoisesvn/properties and add a property named svn:keywords with the value Date Revision Author HeadURL Id.

If you want subversion to automatically add this property to all files that are added to version control this can be done by setting the right auto-properties in the config file (tortoisesvn/settings/general/edit

Setting the property from command line

  • Using the command line the same is done the following way:
svn propedit svn:keywords <filename>

As soon as the file or the change of the property is commited to the server the Tags contain the appropriate information from svn.