Date: Sat, 1 Jul 2000 18:42:21 +0000 From: Nik Clayton <nik@freebsd.org> To: Neil Blakey-Milner <nbm@mithrandr.moria.org> Cc: Nik Clayton <nik@freebsd.org>, doc@freebsd.org Subject: Re: On embedding 'library' graphics into documentation Message-ID: <20000701184220.A267@kilt.nothing-going-on.org> In-Reply-To: <20000630105556.A77835@mithrandr.moria.org>; from nbm@mithrandr.moria.org on Fri, Jun 30, 2000 at 10:55:57AM %2B0200 References: <20000630035012.A41595@catkin.nothing-going-on.org> <20000630105556.A77835@mithrandr.moria.org>
next in thread | previous in thread | raw e-mail | index | archive | help
On Fri, Jun 30, 2000 at 10:55:57AM +0200, Neil Blakey-Milner wrote:
> On Fri 2000-06-30 (03:50), Nik Clayton wrote:
> > Having decided to do that, things become somewhat simpler. Attached are
> > a variety of patches and related files for inspection which do just that.
> >
> > 1. imagelib.tar.gz should be extracted in the en_US.ISO_8859-1
> > directory. This should give you an imagelib/ directory at the
> > same level as the books/ and articles/ directories. It contains
> > one sub-directory, for the callout bugs, and 10 PNG files.
>
> I would have thought that 'share' would be the place to put this, but
> I'd be happy with 'images'. 'share' also means I don't have to relearn
> my bad habits:
Yep, you're right. I think that under share/ it can be called images/.
However, that's probably too generic when copied under the documentation,
so there it can be called imagelib/.
> > I don't think this will be a big problem. Some images will almost certainly
> > contain text, or other content that will need to be translated. The easiest
> > way to handle this would be a mechanism in doc.imagelib.mk that looks for
> > the images first in the language specific imagelib/ directory (I assume
> > each language will have one), and if it can't find it there then it copies
> > it from the English imagelib/ directory. I'd do this now, but it's 3.50am,
> > and I need to be up in about 4 hours time. . .
>
> I prefer IMAGES to IMAGELIB for the variable name, since it makes more
> sense. We might want to have support for LOCAL_IMAGES too. LIB_IMAGES
> or LIBRARY_IMAGES are also alternatives. IMAGELIB sounds like you're
> chosing which image library you want to use.
Yep. At the back of my mind is the awareness that we'll need to extend
this to images that are part of a document (screenshots, and so on), so a
generic "IMAGES" variable isn't appropriate. I like "LIB_IMAGES".
> > IMAGELIB_DIR?= ${.CURDIR}/../../imagelib
>
> This could be replaced by:
>
> ${DOC_PREFIX}/${LANGCODE}/imagelib, much like our DSLHTML and DSLPRINT
> stuff will be soon (when I remember why it works for all cases). It
> could also possibly be multiple directories, but that'd require a bit
> more work.
>
> It might be an idea to make a variable ${LOCAL_SHARE} equal to
> ${DOC_PREFIX}/${LANGCODE}/share in the future. LANGCODEs one vice is
> that it resolves to '.' in external documents, and that means
> introducing another hack to remove it later. I'll have a quick write-up
> on how to do external documents with our wonderful build system in the
> next day or so. It may entail rewriting some stuff (like the
> auto-footer) to depend on the non-existance of "EXTERNAL_DOCUMENT" or
> similar, but it'll be way worth it.
OK. I'll let you thrash that out -- if it's finished before I commit this
then fine, if not it can get fixed up afterwards, depending on the schemes
you come up with.
> > .for _curimage in ${IMAGELIB}
> > ${_curimage}: ${IMAGELIB_DIR}/${_curimage}
> > [ -d ${_curimage} ] || ${MKDIR} -p ${_curimage:H}
> > ${CP} ${IMAGELIB_DIR}/${_curimage} ${_curimage}
> > .endfor
>
> Shouldn't this be:
> [ -d ${_curimage:H} ] || ${MKDIR} -p ${_curimage:H}
> ?
Yes. Fixed :-)
> > +.if ${DOCFORMAT} == "html"
> > +.include "doc.html.mk"
> > +.endif
>
> We should add this already.
Ah. Looks like that's a commit I've forgotten to make. Well spotted.
> > + <!-- The stylesheets need to know about the graphic formats we
> > + use. In particular, PNG isn't supported "out of the box." -->
> > + (define %graphic-extensions%
> > + '("jpg" "png" "tex" "gif"))
>
> We need to add this already.
Not yet. This is related to the wider issue of including images in the docs.
The callout stuff is unrelated as far as I can tell.
N
--
Internet connection, $19.95 a month. Computer, $799.95. Modem, $149.95.
Telephone line, $24.95 a month. Software, free. USENET transmission,
hundreds if not thousands of dollars. Thinking before posting, priceless.
Somethings in life you can't buy. For everything else, there's MasterCard.
-- Graham Reed, in the Scary Devil Monastery
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?20000701184220.A267>