From owner-freebsd-doc Fri Jun 30 1:56: 4 2000 Delivered-To: freebsd-doc@freebsd.org Received: from ns1.sunesi.net (ns1.sunesi.net [196.15.192.194]) by hub.freebsd.org (Postfix) with ESMTP id E676437B7C9; Fri, 30 Jun 2000 01:55:58 -0700 (PDT) (envelope-from nbm@sunesi.net) Received: from nbm by ns1.sunesi.net with local (Exim 3.03 #1) id 137wab-000KJM-00; Fri, 30 Jun 2000 10:55:57 +0200 Date: Fri, 30 Jun 2000 10:55:57 +0200 From: Neil Blakey-Milner To: Nik Clayton Cc: doc@freebsd.org Subject: Re: On embedding 'library' graphics into documentation Message-ID: <20000630105556.A77835@mithrandr.moria.org> References: <20000630035012.A41595@catkin.nothing-going-on.org> Mime-Version: 1.0 Content-Type: text/plain; charset=us-ascii X-Mailer: Mutt 1.0.1i In-Reply-To: <20000630035012.A41595@catkin.nothing-going-on.org>; from nik@freebsd.org on Fri, Jun 30, 2000 at 03:50:12AM +0100 Organization: Sunesi Clinical Systems X-Operating-System: FreeBSD 3.3-RELEASE i386 X-URL: http://rucus.ru.ac.za/~nbm/ Sender: owner-freebsd-doc@FreeBSD.ORG Precedence: bulk X-Loop: FreeBSD.org On Fri 2000-06-30 (03:50), Nik Clayton wrote: > So, unfortunately, each document is going to have to carry its own copy of > the imagelibrary (or rather, those parts of the image library that it > uses) with it. This will bloat the installation area as soon as a reader > installs more than one document, but (1) I don't see a way around that, > and (2) the bloat is minimal. Yes, I agree that this is the best solution. It just keeps things simple for all cases. > 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: "cvs co doc/{share,en_US.ISO_8859-1/{share,books/handbook}}" is my personal sin (: This applies even more if we have cross-language shared graphics too. share/images or even share/imagelib would be the more obvious to me. > 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. > 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. > .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} ? > +.if ${DOCFORMAT} == "html" > +.include "doc.html.mk" > +.endif We should add this already. > + > + (define %graphic-extensions% > + '("jpg" "png" "tex" "gif")) We need to add this already. Neil -- Neil Blakey-Milner Sunesi Clinical Systems nbm@mithrandr.moria.org To Unsubscribe: send mail to majordomo@FreeBSD.org with "unsubscribe freebsd-doc" in the body of the message