<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta content="text/html; charset=ISO-8859-1"
http-equiv="Content-Type">
</head>
<body text="#000000" bgcolor="#ffffff">
<br>
Thanks Frank for digging into this.<br>
My comments inline.<br>
<br>
On 1/07/2011 5:42 PM, Frank Gasdorf wrote:
<blockquote
cite="mid:BANLkTi=eWjWG1QbwcfguAOLJE6p1x-uPgg@mail.gmail.com"
type="cite">Hello,
<div><br>
</div>
<div>I'd like to get feedback for little enhancements for the
OSGeo Live Documentation.</div>
<div><br>
</div>
<div>Right now Makefile for the online docs replaces "OSGeo-Live"
with OSGeo-Live <versionnumber> in all resulting html
files as a post process after sphinx generated html files. After
a grep of all *.rst files in the English sub folder with the
regular expression "OSGeo.Live" the resulting list has two
different versions of this String : OSGeo-Live and OSGeo Live.</div>
<div><br>
</div>
<div>Therefor not everywhere is the version number concatenated,
which leads me directly to the proposal:</div>
<div><br>
</div>
<div>First I'd like to update the Makefile in a way, that the
predefined variables release and version should be used to build
html's [1]. <br>
</div>
</blockquote>
<br>
Good idea. Feel free to implement this.<br>
<blockquote
cite="mid:BANLkTi=eWjWG1QbwcfguAOLJE6p1x-uPgg@mail.gmail.com"
type="cite">
<div>Second I'd like to discuss, whether it is required to have
the version number everywhere.</div>
</blockquote>
<br>
Again, good idea to only use the version in the title. Feel free to
implement.<br>
<br>
<blockquote
cite="mid:BANLkTi=eWjWG1QbwcfguAOLJE6p1x-uPgg@mail.gmail.com"
type="cite">
<div> IMHO we should use the <b>html_title</b> option (Default is
"<project> v<release> documentation" and change it
to "<project> <version> documentation".</div>
</blockquote>
<br>
I'm not sure how this works, but if you have worked it out, I trust
your judgement. <br>
<br>
<blockquote
cite="mid:BANLkTi=eWjWG1QbwcfguAOLJE6p1x-uPgg@mail.gmail.com"
type="cite">
<div><br>
</div>
<div>Third I'd like to ask you, what is :Version: in most of the
rst-files for? Some have osgeo-live4.0, some osgeo-live4.5 and
some files don't have this metadata at all. Maybe we could synch
all files and update to :Version: |version|</div>
</blockquote>
<br>
They were originally to note what was the version of osgeo-live when
the docs were created. However, as you have picked up, the field has
not been getting updated.<br>
I suspect it would be better to remove this field all together from
all docs. If no one else objects within 48 hours. Feel free to
remove this field in all docs.<br>
<br>
<blockquote
cite="mid:BANLkTi=eWjWG1QbwcfguAOLJE6p1x-uPgg@mail.gmail.com"
type="cite">
<div><br>
</div>
<div>Correct me, if I'm wrong: Is it right that the online docs
are build with the Makefile in this way:</div>
<blockquote class="webkit-indent-blockquote" style="margin: 0pt
0pt 0pt 40px; border: medium none; padding: 0px;">
<div><font class="Apple-style-span" face="'courier new',
monospace">make html <br>
</font></div>
</blockquote>
</blockquote>
<br>
docs are made by calling:<br>
bin/install_main_docs.sh<br>
which calls "make html"<br>
<br>
<blockquote
cite="mid:BANLkTi=eWjWG1QbwcfguAOLJE6p1x-uPgg@mail.gmail.com"
type="cite">
<div>in the root doc folder? Is the conf.py still required or just
an old artifact not used anymore?</div>
</blockquote>
<br>
I'm not sure. If you remove it, and the build still works, then it
probably isn't being used and can be removed.<br>
<br>
<blockquote
cite="mid:BANLkTi=eWjWG1QbwcfguAOLJE6p1x-uPgg@mail.gmail.com"
type="cite">
<div>
<br>
</div>
<div>And what do you think about a version number in the header
(right behind the banner) or footer. Nobody has to care about
|version| right behind OSGeo-Live/OSGeo Live in the rst files
anymore, translators should not care about these details ...</div>
<div><br>
</div>
<div>To get a clue what I'm writing about I attached a patch for
you of the Makefile to review. I'm looking for your feedback!</div>
</blockquote>
<br>
Feel free to commit your proposed fixes to svn. If there are issues,
then we have enough time correct them.<br>
I'll check the docs and comment after you have committed the
changes.<br>
<br>
<blockquote
cite="mid:BANLkTi=eWjWG1QbwcfguAOLJE6p1x-uPgg@mail.gmail.com"
type="cite">
<div><br>
</div>
<div>Thanks,</div>
<div>Frank</div>
<div><br>
</div>
<div>
<br>
</div>
<div>[1] : <a moz-do-not-send="true"
href="http://sphinx.pocoo.org/config.html#project-information">http://sphinx.pocoo.org/config.html#project-information</a></div>
<pre wrap="">
<fieldset class="mimeAttachmentHeader"></fieldset>
_______________________________________________
Live-demo mailing list
<a class="moz-txt-link-abbreviated" href="mailto:Live-demo@lists.osgeo.org">Live-demo@lists.osgeo.org</a>
<a class="moz-txt-link-freetext" href="http://lists.osgeo.org/mailman/listinfo/live-demo">http://lists.osgeo.org/mailman/listinfo/live-demo</a>
<a class="moz-txt-link-freetext" href="http://wiki.osgeo.org/wiki/Live_GIS_Disc">http://wiki.osgeo.org/wiki/Live_GIS_Disc</a></pre>
</blockquote>
<br>
<br>
<pre class="moz-signature" cols="72">--
Cameron Shorter
Geospatial Solutions Manager
Tel: +61 (0)2 8570 5050
Mob: +61 (0)419 142 254
Think Globally, Fix Locally
Geospatial Solutions enhanced with Open Standards and Open Source
<a class="moz-txt-link-freetext" href="http://www.lisasoft.com">http://www.lisasoft.com</a>
</pre>
</body>
</html>