| Re: [hatari-devel] Question on docs building |
[ Thread Index |
Date Index
| More lists.tuxfamily.org/hatari-devel Archives
]
- To: hatari-devel@xxxxxxxxxxxxxxxxxxx
- Subject: Re: [hatari-devel] Question on docs building
- From: benoît tuduri <benoit.tuduri@xxxxxxxxx>
- Date: Sun, 17 May 2020 15:20:06 +0200
- Dkim-signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20161025; h=mime-version:references:in-reply-to:from:date:message-id:subject:to :content-transfer-encoding; bh=F+C+MsHaoibMCsoMAv92LQgJnSacyMVZh10nbuO63vs=; b=Sht8O3j2q1+Vv0WYxWfqWgFgW47FeHDywaizFYZsMImXFsyZiiHUlJrFJJi6xFOS5t NqlfQJ0TwkLb7pj+Ry4PTmPESS2tmDQvL0SfYTY3pZqBYCLOLN05YzpAr+FS/yMEliKX fpEWs2ZUDzA4cSWv3zaAoIK6L/Zzr/GLRknHSi8atH5b76z/xJZM5fqPQbF9k9TIgZIb X6eV3iXoEV61IwXrIyiMQcFdVl6JC4oLI1DCMkxYOirNsN2MBnG1BGptQn6QY/NZDZ5e 2cFZz5TS5OqCT4BQw/unr/dEZZIjDb73Ipl6BMJF7tWibuPhnqAiK++obHMxQtYYGybk z+3A==
Hello Eero,
Yes, I was also thinking about asciidoc because it provides a format
that can be exported everywhere to pdf with an intermediate phase
using pandoc.
I think you and Thomas are right, it may not be essential to make the
documentation with asciidoc.
In any case, thank you for your answers and for shedding light on this subject.
Regards,
Le dim. 17 mai 2020 à 14:11, Eero Tamminen <oak@xxxxxxxxxxxxxx> a écrit :
>
> Hi,
>
> On 5/17/20 1:31 PM, benoît tuduri wrote:
> > First, I'm apologize if this is the wrong place to ask that question.
> > I'd like to know how you write documentation like the manual... on the hand?
>
> It's manually edited HTML and regular ASCII.
>
>
> > If so, wouldn't you like to have a format that is easier to maintain
> > like with asciidoc tools, etc? >
> > Which one would you use if you had to choose one?
>
> The problem with these "easier" formats is
> that there are so many to choose them, they
> come and go. Building the final documentation
> may also be a problem for users, if it e.g.
> requires going through LaTeX.
>
> I've used quite a few documentation systems since
> 90's, starting from TeX & SGML. For longer docs I
> still prefer LaTeX (with LyX GUI), but I don't
> think that really suits Hatari. :-)
>
>
> Of the lightweight markup languages I actually
> prefer AsciiDoc syntax, and looking at this:
> https://en.wikipedia.org/wiki/Lightweight_markup_language
>
> It seems to support:
> * _both_ HTML import & export
> * at least 3 levels of headers
> * text styles including code/monospaced
> * tables
>
> What about:
> * inline images
> * index generation
> * table cell alignment
> ?
>
> - Eero
>
>
>