User manual changes for 4.5

Dirk Hohndel dirk at hohndel.org
Fri Apr 24 10:57:38 PDT 2015


On Fri, Apr 24, 2015 at 07:13:22PM +0200, Willem Ferguson wrote:
> I will fix up the manual this week end. I need to know what the final
> configuration of the manual will be like. Can I assume that the directory
> structure will be as previously, i.e. more or less as follows?
> 
> Documentation directory containing usermanual.txt
>     Images
>         Icons

I haven't forgotten your email about the file system layout. I just
haven't gotten around to looking into this. :^)

Yes, my plan is to make things work so that both in the build directory
and in an installed version of the manual we have a layout that's similar
to what we had previously.

> This means the Documentation folder in the build directory is not relevant
> for building the user manual ?? But where do the HTM user manuals in
> build/Documentation get their images from? I probably sound brainless but I
> do not yet totally understand the process.

No, your comment is important since I didn't completely get this right so
far and need to find the time to fix it.

> On the other hand if there are changes, then the URLs to images within the
> user-manual need to point somewhere else, so this is an important thing to
> know about.
> 
> Also, if there are any new developments with respect to location coordinate
> handling, please make it explicit to me?? At the moment it is just the
> actions associated with selecting the "manage" button under the Location
> heading. If there is anything that I may overlook, I would appreciate being
> reminded.

The big questions is how we handle the transition. Once Tomaz is back
online this is something he and I need to discuss. My suggestion would be
that we figure this out once I'm ready to cut a first beta. Looking at the
calendar I think I need to adjust what I said about the release timeframe.
Let's aim for "second half of May" :-)

> The other issue is "recreational" dive planning. Robert are you prepared at
> all to give me some telegram-style comments on rec planning that may not be
> overtly obvious?

Yeah, that's one of the other feature changes... I need to go through the
changelog. While it seems that half the commits are caused by cmake (ok,
that may be an exaggeration) I'm pretty sure there are several other
feature improvements...

- image import and management
- undo/redo
- new file formats for import (or did we have all these and it's just fixes?)
- better and more flexible GPS coordinate parsing
- OSTCTools support

In order for this not to get lost I did an early first stab at release
notes :-)

/D


More information about the subsurface mailing list