[Date Prev][Date Next] [Thread Prev][Thread Next] [Date Index] [Thread Index]

Re: Install manual, Finnish translation STARTED

Adam Di Carlo <adam@onshore.com> writes:
> Then I munge the files and move them (notably, move index.en.html to
> dselect-beginner.en.html).  Also I have to make symlinks for content
> negotiation, but I don't think that should be your problem:

That's something for a Makefile, I guess.

> Ok, so what's my point.  My point is that you don't currently give
> enough control over HTML file naming in debiandoc2html.

Or for any of the other formats.

> I suggest you use the scheme adopted by the docbook folks.  They use
> processing instructions in the SGML:
>   html-basename -- base filename for HTML, would be 'dselect-beginner' in my example
>   html-filename -- name for the top-level file, would be
>       'dselect-beginner.html' (um, but need to work out lang naming here...
>   html-dir      -- name for directory to put files in, probably would be '.'
> PIs in SGML are specified like so:
>   <?html-dir html>

I prefer to make this more general, i.e. usable for other formats as
well, and propose:

    basename -- base filename without extension; for HTML this would
                be the basename of the directory to put the file in
                and for the other formats the basename of the target file

    topname  -- name for the top-level file without extension and only 
                used for HTML (for now at least)

For the ultimate flexibility we could even provide an 'extension' PI
with appropriate defaults (see below).

> I think you should keep the *default* naming semantics just as they
> are in potato.  Add a switch for debiandoc2* to use LANG naming.  Add
> support for these PIs above, or alternatively, the equivalent as flags
> to the programs.

Then I would like to take this even one step further and provide both
with the flags overwriting the PIs.  For the flags I propose

    -c -- content-negotiation
    -b -- basename
    -t -- topname
    -e -- extension

Somewhere in the future I would like to support long names for these

Note that the "default" naming semantics still have in them the issue
of source file names with a language indicator (as Tapio is planning
to use) resulting in target file names with this language indicator if
none of the PIs are set and no command line flag is given.  But hey,
its their choice to do so.

Speaking about the extensions, I would like to make the defaults as

    HTML    -> .html
    LaTeX2E -> .tex (was .latex2e)
    Lout    -> .lout
    Texinfo -> .texinfo
    Text    -> .txt (was .text)
    TextOV  -> .tov (was .textov)

    DVI     -> .dvi 
    PS      -> .ps  (irrespective of intermediate format)
    PDF     -> .pdf (idem)

If someone e.g. wants to compare the PostScript generated via LaTeX2e
and Lout, she can always use the command line flags.

The names of the script will stay the same.

Ardo van Rangelrooij
home email: avrangel@flevonet.nl, ardo@debian.org
home page:  http://www.tip.nl/users/ardo.van.rangelrooij
PGP fp:     3B 1F 21 72 00 5C 3A 73  7F 72 DF D9 90 78 47 F9

Reply to: