[syslinux] RFC:documents for new modules; Interest in rewriting exiting documentation
Ady
ady-sf at hotmail.com
Mon Sep 3 04:12:26 PDT 2012
Date sent: Sun, 2 Sep 2012 22:38:10 -0400
From: Gene Cumm <gene.cumm at gmail.com>
To: For discussion of Syslinux and tftp-hpa
<syslinux at zytor.com>
Subject: Re: [syslinux] RFC:documents for new modules;
Interest in rewriting exiting documentation
> On Sun, Sep 2, 2012 at 3:16 PM, Ady Ady <ady-sf at hotmail.com> wrote:
> >
> >
> >> Date: Sun, 2 Sep 2012 12:04:10 -0400
> >> From: gene.cumm at gmail.com
> >> To: syslinux at zytor.com
> >> Subject: Re: [syslinux] RFC:documents for new modules; Interest in rewriting exiting documentation
> >>
> >> On Sun, Sep 2, 2012 at 10:20 AM, Ady Ady <ady-sf at hotmail.com> wrote:
> >> >
> >> > For doc/pxechn.txt:
> >> >
> >> > Whenever possible, use shorter line lengths (less than 78 characters).
> >>
> >> Noted already.
> >>
> >
> > For the AsciiDoc compatibility, you have 80 columns and immediately you get
> > to the next line (when the file is displayed) even if in the file itself
> > you keep writing. So by using less than 80 columns (for the "real text to
> > be displayed") and "forcing" a line feed (press <enter>) you waste at most
> > 1 column for each text line, but you also get a "content" that is similar
> > to the displayed text (plus the formatting characters, of course). Thus,
> > the lines in the text file are not so long.
>
> Depends on output format but for text, that should be true. HTML
> should not be limited however.
>
Aren't those suppose to be text files first, in the "doc" directory,
before they are html elsewhere?
>
> https://sites.google.com/site/genecsyslinux/pxechn.html
>
In that html, the source says (sorry if the email changes the format
of the original text or the original line length):
<h2 id="_synopsis">SYNOPSIS</h2>
<div class="sectionbody">
<div class="paragraph"><p><strong>pxechn.c32</strong> [-h | --help
| -?]
<strong>pxechn.c32</strong> -r <em>FILE</em>
<strong>pxechn.c32</strong> <em>FILE</em>
[<em>OPTIONS</em>]</p></div>
</div>
but it probably needs to be something similar to:
<h2 id="_synopsis">SYNOPSIS</h2>
<div class="sectionbody">
<div class="paragraph"><p><strong>pxechn.c32</strong> [-h | --help
| -?]<br/>
<strong>pxechn.c32</strong> -r <em>FILE</em><br/>
<strong>pxechn.c32</strong> <em>FILE</em>
[<em>OPTIONS</em>]</p></div>
</div>
(adding "br's" to the end of 2 of the lines, or some alternative
method so to
get 3 separated lines for the synopsis).
More information about the Syslinux
mailing list