Skip site navigation (1)Skip section navigation (2)
Date:      Fri, 27 Aug 1999 12:12:32 +0100
From:      Nik Clayton <nik@freebsd.org>
To:        Satoshi - Ports Wraith - Asami <asami@freebsd.org>
Cc:        nik@freebsd.org, doc@freebsd.org
Subject:   Re: Default FDP docs installation directory?
Message-ID:  <19990827121232.C15526@kilt.nothing-going-on.org>
In-Reply-To: <199908270024.RAA27527@silvia.hip.berkeley.edu>; from Satoshi - Ports Wraith - Asami on Thu, Aug 26, 1999 at 05:24:48PM -0700
References:  <19990818121931.A4266@kilt.nothing-going-on.org> <19990819131224.A844@kilt.nothing-going-on.org> <vqcemgwm9q1.fsf@silvia.hip.berkeley.edu> <19990825001406.A62322@catkin.nothing-going-on.org> <199908270024.RAA27527@silvia.hip.berkeley.edu>

next in thread | previous in thread | raw e-mail | index | archive | help
On Thu, Aug 26, 1999 at 05:24:48PM -0700, Satoshi - Ports Wraith - Asami wrote:
>  * From: Nik Clayton <nik@freebsd.org>
> 
>  * Please can you look at 
>  * 
>  *     <URL:http://www.freebsd.org/handbook/porting.html>;
>  * 
>  * and let me know if that's the sort of format you want to see.  If you
>  * need any tweaks we should be able to accomodate them.
> 
> Yes, that looks much better.  If you ask me, I'd prefer sections with
> more than one version number component to not have the period at the
> end (e.g., 4.6 instead of 4.6.)  but I can live with what you have
> now.

That's feasible too, although it's more work.

If you take a look in /usr/local/share/sgml/docbook/dsssl/modular/common/,
and the file dbl1en.dsl, you'll see there's a collection of lines that
look like

    ...
    (define en-refsect2-label-title-sep ". ") 
    (define en-refsect3-label-title-sep ". ")
    (define en-sect1-label-title-sep ". ")
    (define en-sect2-label-title-sep ". ")
    (define en-sect3-label-title-sep ". ")
    ...

In this case, en-sect1-label-title-sep is the string that will appear 
between the section label (i.e., '1.1') and the title of the section.  
Currently, with that set to '. ' you get things like

    1.4. The FreeBSD Development Model
       ^^

in the output.  The bit I've underlined is where en-sect1-label-title-sep
is being used.

So, if you were to go and edit doc/share/sgml/freebsd.dsl, and add a line
like

    (define en-sect1-label-title-sep " ")

then the output would be

   1.4 The FreeBSD Development Model

which is what you've asked for.  See the power and flexibility of DocBook,
coupled with Norm Walsh's stylesheets.  You couldn't do this with our old
system.

But (there's always a 'but') if you look at the dbl1en.dsl file that I
mentioned earlier, you'll see that there are about 30 of these -sep 
variables that need to be configured, and that they are duplicated (with
different prefixes) for all the other languages we support as well (ja-,
es-, and so on).

Being candid, I haven't really got the time, or the inclination, to
go through and override the definition of these in our freebsd.dsl, and 
to do it for all the other languages as well.  But, if anyone reading this
feels badly enough about this to actually do the work, I'll cheerfully 
accept patches
 
> Also, glancing around the handbook, I noticed that the "home" and "up"
> links are only at the bottom of each page.  Can you add them to the
> top as well?

The technical answer to this is "yes, it's just a SMOP".

The practical answer is "I don't know DSSSL well enough to be able 
to implement it."

The code that does all this is in .../modular/html/dbnavig.dsl.  It's
on my list of things to get my head around, as one of the things that's
missing from the stylesheets is an easy way to insert your own arbitrary
HTML at the top of the page (this is why the FAQ and the Handbook do not
currently have the "yellow FreeBSD link nav bar" at the top of the page
the way the rest of the FreeBSD site does.

If anyone's reading this, is looking to learn more about DSSSL, and wants
a project to start on, this would be ideal.

N
-- 
 [intentional self-reference] can be easily accommodated using a blessed,
 non-self-referential dummy head-node whose own object destructor severs
 the links.
    -- Tom Christiansen in <375143b5@cs.colorado.edu>


To Unsubscribe: send mail to majordomo@FreeBSD.org
with "unsubscribe freebsd-doc" in the body of the message




Want to link to this message? Use this URL: <https://mail-archive.FreeBSD.org/cgi/mid.cgi?19990827121232.C15526>