Commit graph

29 commits

Author SHA1 Message Date
Nik Clayton
de9128a949 Define new LANGCODE variable, which should contain the language name
and encoding for the documentation that's currently being built (e.g.,
'en_US.ISO_8859-1', or 'es_ES.ISO_8859-1').  Used when building packages
to create part of the package file name.  Setting this involves an
'interesting' kludge -- suggestions for how better to achieve this within
make(1) welcomed.

package-*:
    No need to remove PLIST, it's always overwritten.

    Create empty COMMENT and DESCR files if they don't exist.  Makes it
    easier to test this, without committing COMMENT and DESCR files all
    over the tree.

    Use the ${LANGCODE} variable in the package name.  For example,
    the HTML pkg for the FAQ now looks like faq.en_US.ISO_8859-1.html.tgz,
    instead of just faq.html.tgz.
1999-08-28 09:50:49 +00:00
Nik Clayton
ee685fdd2c 1. Fix a subtle bug in the use of ${DOC}. If you ran make(1) and defined
${FORMATS} on the command line then it would assume that you wanted to
   build a document in the current directory, based on the setting of ${DOC}.
   If ${DOC} wasn't set, it defaulted to the name of the current directory.

   Any Makefile that includes this, and expects to have documentation built
   in the current directory must now explicitly define DOC.  All the current
   ones do anyway.  This should be a non-problem when docproj.docbook.mk is
   split out in to smaller, more modular files.

   Move the comments for DOC from the non-mandatory to the mandatory
   section.

2. Clarify the meaning of DESTDIR, it's changed a little bit since it was
   first documented.

3. Initial, tentative support for building pkg_* packages from the
   formatted documentation.  Needs work, but I've had the patch out for
   review for a couple of days, and no comments either way -- so if
   people hate it, this should at least spur them on to say so.

       # cd /path/to/doc/to/turn/into/a/package
       # touch COMMENT DESCR
       # make 'FORMATS=this that and the other' package

   to build 'n' packages, one per format.  "make install" is run as part
   of the package dependency, so this will overwrite documentation you
   have already got installed.

4. Remove DOC_INSTALL_PREFIX.  Should have been DOCDIR from the start.
1999-08-26 19:37:13 +00:00
Nik Clayton
e1302f8644 Remove the comment about <FAQList>, that's been obsoleted by DocBook 3.1.
Default to labelling questions with "Q:" and answers with "A:" when
processing <qandaset>s.  In the HTML output, render questions in a larger,
bolder font than the answers.  Requested by several people on -doc.

Default to numbering sections. Requested by one person on -doc, who
seemed somewhat confused that I hadn't read his mind and done this three
months previously.
cvs: ----------------------------------------------------------------------
1999-08-23 21:02:01 +00:00
Nik Clayton
c98917fd5d Use a conditional assignment "?=" when defining DOC_INSTALL_PREFIX 1999-08-19 00:07:09 +00:00
Nik Clayton
77ab53e851 "-chown" was falling over when ${FORMAT} == html-split. Move the "-" to
the surrounding "for" loop.
1999-08-18 18:46:58 +00:00
Nik Clayton
7fc8947ce8 The new Makefile framework. Does the right thing (pretty much) except
in the case of */FAQ/Makefile, because the FAQs are all in the wrong
place.  Things still install properly, but some of the directory paths
are hardcoded.  This will be going away ASAP.
1999-08-16 22:09:20 +00:00
Nik Clayton
28ded3fede Add DESTDIR and DOC_INSTALL_PREFIX variables.
Pull in ../Makefile.inc if it exists.

Don't use install(1), use cp(1), chmod(1), and chown(1).  That way non-root
users can install the files without install(1) complaining about the
inability to change the owners.

Nuke the "distribute" target.  We don't need it where we're going. . .
1999-08-16 21:08:12 +00:00
Nik Clayton
537037f404 Make ${INSTALL_COMPRESSED} and ${INSTALL_ONLY_COMPRESSED} truly optional.
PR:             docs/12978
Submitted by:   John Baldwin <jobaldwi@vt.edu>
1999-08-05 20:22:49 +00:00
Nik Clayton
e9b420e0d1 D'oh. Add refs for loader.conf(5), boot(8), and loader(8), required
by the recently committed "Serial Console" section.  I had these in my
local tree, and they slipped off my "list of things to commit" somehow.

Prompted by:	Kazutaka YOKOTA <yokota@zodiac.mech.utsunomiya-u.ac.jp>
1999-07-28 07:27:59 +00:00
Nik Clayton
a826cfbdf3 Add entries for gzip(1), lndir(1), uname(1), execve(2), crypt(3),
cvsupd(8).
1999-06-07 22:33:12 +00:00
Nik Clayton
6dd20feada Change ${DOCBOOKCATALOG} to point at the master catalog for all the
DocBook DTDs, not just the 3.0 one.
1999-06-03 19:39:29 +00:00
Nik Clayton
078cacb295 Switch to using DocBook 3.1. Pull out the FreeBSD specific FAQList*
elements, they are obsoleted by the DocBook QAndASet element (and
sub-elements).
1999-06-03 19:37:49 +00:00
Nik Clayton
73d9f92018 Change the FPI to show this is now a DocBook 3.1 based extension. 1999-06-03 19:35:48 +00:00
Nik Clayton
ef198ce9f1 Be smarter about setting DOC_PREFIX to /usr/doc. Only do it if
/usr/doc/share/mk/docproj.docbook.mk exists.  Otherwise, warn the
user they need to set it, and exit.
1999-05-18 17:51:40 +00:00
Jesus Rodriguez Cuesta
7293b4083d Show pkg_add(1) and pkg_create(1) instead pkg.add(1) and pkg.create(1)
Added entry for pkg_delete(1).

Submmitted by: cjc@cc942873-a.ewndsr1.nj.home.com
Right patch by: chris@calldei.com
1999-05-15 16:25:25 +00:00
Nik Clayton
33837abfa5 Added a validate target to check that the SGML markup is valid without
the overhead of running Jade.

Added an ${EXTRA_CATALOGS} variable if your document needs to be
processed with additional SGML catalogs (currently not used by anything,
but might be some day).

Switched the meaning of ${JADEFLAGS} and ${JADEOPTS} for consistency.  All
user-tweakable program options now match ${*FLAGS}.
1999-05-05 20:16:46 +00:00
Nik Clayton
c70f469739 Added many comments explaining what this file is and what it should
contain.

Define an FPI for ../../en/share/sgml/bookinfo.ent.  Explain how to add
other language specific FPIs.
1999-05-05 20:14:34 +00:00
Joseph Koshy
7c0fa1b1fd Add an entity for ppp(8). 1999-05-04 05:12:09 +00:00
Nik Clayton
b796c77807 Add a definition for &man.lynx.1; 1999-04-29 19:50:18 +00:00
Jun Kuriyama
8bdee18bd8 Add ${TIDYFLAGS} to use -raw option for building Japanese handbook. 1999-04-20 15:58:36 +00:00
Nik Clayton
ed34512f59 Includable Makefile, contains most of the logic for converting DocBook
into a variety of different formats.  Contains a lot of code that used
to be in doc/en/handbook/Makefile, the commit log for that file will
probably prove useful as well.
1999-04-14 22:13:59 +00:00
Nik Clayton
5dffdeac60 Add some more references to manual pages. Not yet used by Handbook,
but soon to be committed docs use them.
1999-04-12 22:22:21 +00:00
Jun Kuriyama
fad371fe20 Add temporary option %lang.ja.dsssl;.
Current version of dsssl-docbook-modular has Japanese option, but
this doesn't satisfy our needs.
Until I write a patch, Japanese stylesheet should be off.
1999-04-08 14:17:50 +00:00
Nik Clayton
46ad10792f Hmm. I already committed this remotely, it doesn't seem to have 'stuck'.
Explicitly set %lang.ja to "IGNORE", it will need to be turned on with
something like

    jade -ilang.ja ...
1999-04-05 17:24:40 +00:00
Nik Clayton
a49230e352 Remove old hack to indent verbatim environments, and use new, Norm Walsh
sanctioned hack to indent verbatim environments :-)

Explicitly turn off formatting a <variablelist> as a table, it's still
buggy.

Rename "usen-*" to "en-*", as the usage changed in the underlying
stylesheets.  The leader to a <warning> or <caution> should now have
the ":" in the correct position.
1999-04-04 17:08:20 +00:00
Jun Kuriyama
b859c3ea6b Add Japanese specific definitions. 1999-04-04 15:33:23 +00:00
Nik Clayton
62a7d13816 Created a new set of entities for manual pages.
The construct:

    <citerefentry>
      <refentrytitle>foobar</refentrytitle>
      <manvolnum>1</manvolnum>
    </citerefentry>

is a pain to type, and messes up the pretty-printing of the source code.
Replace every occurence of a entry like that with:

    &man.foobar.1;

Adjusting the manual page name and section number appropriately.

The definitions for these entities are stored in man-refs.ent. This
file is in doc/share/sgml because it is not just specific to the Handbook.
I expect the DocBook'd FAQ and Tutorials (coming RSN) to use them as
well.

A new PUBLIC identifier has been created for these entities, and added to
the catalog file.
1999-03-07 16:32:22 +00:00
Nik Clayton
6c56672923 Removed the reference to handbook.css, that shouldn't be in there yet.
Turned html-manifest from #t to #f. This can be set to #t via an option
to jade(1), but the reverse is not true.
1999-01-27 23:29:14 +00:00
Nik Clayton
99901d638a Move doc/sgml/* to doc/share/sgml/*, so it better follows the layout of
Doc. Proj. related ports under $PREFIX/share. Update en/handbook/Makefile
with the new paths.

Didn't seem worthwhile to do a repository copy for only three files moved.
1999-01-25 21:58:59 +00:00