View Issue Details

IDProjectCategoryView StatusLast Update
0001731ardourfeaturespublic2008-11-21 00:28
Reporterdeva Assigned Totimbyr  
PrioritynormalSeverityminorReproducibilityalways
Status closedResolutionfixed 
Product Version2.0 
Summary0001731: Versioning Of The Ardour Manual
DescriptionI would very much like the online manual to have some sort of version number in order to follow the development.

It could for instance be the compilation date or svn revision number, or even better a version number of its own reflecting the magnitude of change since last release.

Is this something that might be added in some future relase?
Additional InformationA reference to the forum: http://ardour.org/node/1028
TagsNo tags attached.

Activities

2007-07-18 08:28

 

0001-Use-scons-to-generate-manual-entities-so-the-manual.patch (5,070 bytes)   
From 3e30bc214b01543197f85364274650b85ca56361 Mon Sep 17 00:00:00 2001
From: Tim Mayberry <mojofunk@gmail.com>
Date: Tue, 17 Jul 2007 23:30:52 +1000
Subject: [PATCH] Use scons to generate manual entities so the manual version is consistant with the Ardour version

---
 SConstruct                 |    6 ++++--
 manual/SConscript          |   11 +++++++++++
 manual/xml/book_info.xml   |   10 +++++-----
 manual/xml/entities.ent    |   22 ----------------------
 manual/xml/entities.ent.in |   22 ++++++++++++++++++++++
 5 files changed, 42 insertions(+), 29 deletions(-)
 create mode 100644 manual/SConscript
 delete mode 100644 manual/xml/entities.ent
 create mode 100644 manual/xml/entities.ent.in

diff --git a/SConstruct b/SConstruct
index d88e898..b289dde 100644
--- a/SConstruct
+++ b/SConstruct
@@ -891,7 +891,8 @@ if env['SYSLIBS']:
                                             CPPPATH='#libs/appleutility')
     
     coredirs = [
-        'templates'
+        'templates',
+        'manual'
     ]
     
     subdirs = [
@@ -955,7 +956,8 @@ else:
 
     coredirs = [
         'libs/soundtouch',
-        'templates'
+        'templates',
+        'manual'
     ]
     
     subdirs = [
diff --git a/manual/SConscript b/manual/SConscript
new file mode 100644
index 0000000..f8a5a12
--- /dev/null
+++ b/manual/SConscript
@@ -0,0 +1,11 @@
+# -*- python -*-
+
+Import('env ardour_version')
+
+manual_subst_dict = { }
+
+manual_subst_dict['%VERSION%'] = ardour_version
+
+entities = env.SubstInFile ('xml/entities.ent', 'xml/entities.ent.in', SUBST_DICT = manual_subst_dict);
+
+Default(entities)
diff --git a/manual/xml/book_info.xml b/manual/xml/book_info.xml
index 06e4cbf..061e2f0 100644
--- a/manual/xml/book_info.xml
+++ b/manual/xml/book_info.xml
@@ -10,13 +10,13 @@
 <bookinfo>
   <title>Ardour Manual</title>
   <issuenum>1.0</issuenum>
-  <productnumber>2.0</productnumber>
+  <productnumber>&ARDOUR_VERSION;</productnumber>
   <abstract>
     <para>
-      This is the manual for &ARDOUR_NAME;, a digital audio workstation for
-      Linux and MacOSX. This manual is jointly created and edited by the
-      &ARDOUR_NAME; community. It may be published in paper format at some
-      time in the future.
+      This is the manual for &ARDOUR_NAME; version &ARDOUR_VERSION;, a
+      digital audio workstation for Linux and MacOSX. This manual is jointly
+      created and edited by the &ARDOUR_NAME; community. It may be published
+      in paper format at some time in the future.
     </para>
   </abstract>
   <isbn>
diff --git a/manual/xml/entities.ent b/manual/xml/entities.ent
deleted file mode 100644
index 0279d77..0000000
--- a/manual/xml/entities.ent
+++ /dev/null
@@ -1,22 +0,0 @@
-<!ENTITY YEAR "2007">
-<!ENTITY BOOKNAME "Ardour Reference Guide">
-<!ENTITY BOOKVERSION "0.01"> <!-- change version here -->
-<!ENTITY BOOKDATE "2007-01-13"> <!-- change revision date here -->
-<!ENTITY BOOKID "&BOOKNAME;-&BOOKVERSION; (&BOOKDATE;)">
-
-<!ENTITY ARDOUR_NAME "ardour">
-<!ENTITY ARDOUR_VERSION "2.0">
-<!ENTITY ARDOUR_COMMAND "<command>ardour-&ARDOUR_VERSION;</command>">
-<!ENTITY ARDOUR_APPLICATION "<application>&ARDOUR_NAME;</application>">
-<!ENTITY COPYRIGHT_HOLDER "&ARDOUR_NAME; Foundation">
-
-<!ENTITY MIX_WIN '<link linkend="sn-mixer-window">Mixer Window</link>'>
-<!ENTITY EDIT_WIN '<link linkend="sn-editor-window">Editor Window</link>'>
-
-<!ENTITY MIXER_STRIP '<link linkend="sn-mixer-strips">Mixer Strip</link>'>
-<!ENTITY MIXER_STRIP_LIST '<link linkend="sn-mixer-strip-list">Mixer Strip List</link>'>
-
-<!ENTITY TRACK_DISPLAY '<link linkend="sn-track-display">Track Display</link>'>
-<!ENTITY TRACK_CONTROLS '<link linkend="sn-track-controls">Track Controls</link>'>
-
-<!ENTITY PLAYLIST '<glossterm linkend="gt-playlist">Playlist</glossterm>'>
diff --git a/manual/xml/entities.ent.in b/manual/xml/entities.ent.in
new file mode 100644
index 0000000..c8f8fe7
--- /dev/null
+++ b/manual/xml/entities.ent.in
@@ -0,0 +1,22 @@
+<!ENTITY YEAR "2007">
+<!ENTITY BOOKNAME "Ardour Reference Guide">
+<!ENTITY BOOKVERSION "0.01"> <!-- change version here -->
+<!ENTITY BOOKDATE "2007-01-13"> <!-- change revision date here -->
+<!ENTITY BOOKID "&BOOKNAME;-&BOOKVERSION; (&BOOKDATE;)">
+
+<!ENTITY ARDOUR_NAME "ardour">
+<!ENTITY ARDOUR_VERSION "%VERSION%">
+<!ENTITY ARDOUR_COMMAND "<command>ardour-&ARDOUR_VERSION;</command>">
+<!ENTITY ARDOUR_APPLICATION "<application>&ARDOUR_NAME;</application>">
+<!ENTITY COPYRIGHT_HOLDER "&ARDOUR_NAME; Foundation">
+
+<!ENTITY MIX_WIN '<link linkend="sn-mixer-window">Mixer Window</link>'>
+<!ENTITY EDIT_WIN '<link linkend="sn-editor-window">Editor Window</link>'>
+
+<!ENTITY MIXER_STRIP '<link linkend="sn-mixer-strips">Mixer Strip</link>'>
+<!ENTITY MIXER_STRIP_LIST '<link linkend="sn-mixer-strip-list">Mixer Strip List</link>'>
+
+<!ENTITY TRACK_DISPLAY '<link linkend="sn-track-display">Track Display</link>'>
+<!ENTITY TRACK_CONTROLS '<link linkend="sn-track-controls">Track Controls</link>'>
+
+<!ENTITY PLAYLIST '<glossterm linkend="gt-playlist">Playlist</glossterm>'>
-- 
1.5.2.2

timbyr

2007-07-18 08:29

developer   ~0004154

I've attached a patch that will generate the manual entities file which results in the version of ardour the manual is intended to document being displayed prominently on the first page of the manual.

The patch only substitutes the ardour version number which I think is by far the most important thing, although it could be modified later to substitute other things like build date or svn revision etc.

If this patch is applied it means that scons must be run before the manual can be built. I was a little wary of this but I don't think it is an issue as eventually the manual should be built as part of the normal build process.

deva

2007-07-18 08:51

reporter   ~0004155

Both revision number and build date would be very handy I think.

My main point was to be able to track the online version of the manual, and both of these will fit nicely as a solution to that.

The Ardour version is also handy though ;)

timbyr

2007-08-16 02:38

developer   ~0004271

patch committed to trunk as rev 2309

Issue History

Date Modified Username Field Change
2007-06-15 13:47 deva New Issue
2007-06-16 22:59 timbyr Status new => assigned
2007-06-16 22:59 timbyr Assigned To => timbyr
2007-07-18 08:28 timbyr File Added: 0001-Use-scons-to-generate-manual-entities-so-the-manual.patch
2007-07-18 08:29 timbyr Note Added: 0004154
2007-07-18 08:30 timbyr Status assigned => feedback
2007-07-18 08:51 deva Note Added: 0004155
2007-08-16 02:38 timbyr Status feedback => resolved
2007-08-16 02:38 timbyr Resolution open => fixed
2007-08-16 02:38 timbyr Note Added: 0004271
2008-11-21 00:28 seablade Status resolved => closed