Print

Print


I have to say I like the cosmetic appearance of the documentation... It's much less '90s' :)

You never know; cleaner more modern-looking documentation may help the longevity of Starlink.

Ed


On Thu, Aug 28, 2014 at 1:41 AM, David Berry <[log in to unmask]> wrote:
Hi Sarah,
                So what are the specific issues that you are trying to
fix? The new version looks fine, but it's not obvious to me why it is
any better than the old version. A list of specific benefits would be
interesting...

David

On 28 August 2014 04:38, Sarah Graves <[log in to unmask]> wrote:
> Hi All,
>
> I've recently been taking a look to see if there is anyway to improve the
> starlink latex documentation appearance, and to make it easier to write and
> maintain.
>
> If anyone's interested in the results, I've put up the versions I've made of
> sun95 and sc21 as latex, html and pdf on:
>
> http://www.jach.hawaii.edu/~sgraves/starlink-docupdate/
>
>
> This was done by creating a draft starlink.cls file so we don't have to keep
> replicating all the formatting defintions in every latex file, and hopefully
> encourage a little more separation of style and content.
>
> I've also played about with using tex4ht instead of latex2html so we can
> generate html output that is better looking, easier to use and doesn't
> require lots of content repeated in latexonly/htmlonly sections of the
> texfiles.
>
> I'm using mathjax for the maths, but tex4ht can generate images instead if
> mathjax isn't well supported enough.
>
> I copied the formatting that Holly and Malcolm had used in sc21's most
> recent pdf version for the style of both the pdf and html output. The html
> output is still rather crude, but I find it easier for me to use than the
> current output.
>
> The cookbooks might take a bit of manual tweaking to look good in a new
> system, but I think most of the documents with less complex formatting would
> be pretty straightforward to adjust. (sun95 didn't take very long to get it
> working.)
>
> If anyone wants it, the code is on the docupdate branch on my fork of
> starlink:
>
> http://github.com/sfgraves/starlink
> branch: docupdate
>
> But I haven't tried to integrate any of this with the build system yet.
> (I've just been running the commands manually, using the tex4ht provided by
> texlive on my computer).
>
> It'd be great to hear what people think of this,
>
> Cheers,
>
> Sarah