Re: Documentation files in html format?

["Jesper Juhl" <jesper.juhl@gmail.com>]

On 09/08/07, Stephen Hemminger <shemminger@linux-foundation.org> wrote:
> Since the network device documentation needs a rewrite, I was thinking
> of using basic html format instead of just plain text. But since this would
> be starting an new precedent for kernel documentation, some it seemed
> like a worthwhile topic for discussion.
>
> Advantages of html:
>   * basic formatting like lists, italics, etc

 - List item 1
 - List item 2
 - List item 3

/italic text/
*bold text*
_underlined text_


>   * easier to integrate into other places and retain formatting

Hmm, I'm not sure I agree, generally plain tet integrates easily into
everything, html not so. As for formatting, you usually always have to
tweak that by hand anyway, might as well leave it as plain text..

>   * ability to link documents and to external sources easier

How is <a href="http://kernel.org/";>kernel.org</a> easier to handle
than plain http://kernel.org/ ?

>
> Downsides:
>   * can become too formatted and unclear

Yup.

>   * accessibility and translation issues?

Those exist whatever format you pick.

>   * even more style issues

Indeed.


I for one vote for just keeping things as plain text, it's so much
easier work with - grep, sed, awk etc...


-- 
Jesper Juhl <jesper.juhl@gmail.com>
Don't top-post  http://www.catb.org/~esr/jargon/html/T/top-post.html
Plain text mails only, please      http://www.expita.com/nomime.html
-
To unsubscribe from this list: send the line "unsubscribe linux-kernel" in
the body of a message to majordomo@vger.kernel.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html
Please read the FAQ at  http://www.tux.org/lkml/