From owner-freebsd-doc Mon Oct 23 6:47:18 2000 Delivered-To: freebsd-doc@freebsd.org Received: from nothing-going-on.demon.co.uk (nothing-going-on.demon.co.uk [193.237.89.66]) by hub.freebsd.org (Postfix) with ESMTP id 1AD4037B479 for ; Mon, 23 Oct 2000 06:47:15 -0700 (PDT) Received: (from nik@localhost) by nothing-going-on.demon.co.uk (8.11.0/8.11.0) id e9NDU7l01050; Mon, 23 Oct 2000 14:30:07 +0100 (BST) (envelope-from nik) Date: Mon, 23 Oct 2000 14:30:06 +0100 From: Nik Clayton To: Nick Rogness Cc: doc@freebsd.org Subject: Re: How To's Message-ID: <20001023143006.A1014@canyon.nothing-going-on.org> References: <20001018070232.C9427@canyon.nothing-going-on.org> Mime-Version: 1.0 Content-Type: text/plain; charset=us-ascii Content-Disposition: inline User-Agent: Mutt/1.2.5i In-Reply-To: ; from nick@rapidnet.com on Wed, Oct 18, 2000 at 02:25:07PM -0600 Organization: FreeBSD Project Sender: owner-freebsd-doc@FreeBSD.ORG Precedence: bulk X-Loop: FreeBSD.org [ cc'd to -doc for the archives ] On Wed, Oct 18, 2000 at 02:25:07PM -0600, Nick Rogness wrote: > On Wed, 18 Oct 2000, Nik Clayton wrote: > > I've posted the URLs to our meta documentation explaining how to write > > documentation elsewhere in this thread. Let me know if that's sufficient, > > and if there's anything else that you guys need to get started. > > I have a lot of documents that contain Images (Visio diagrams > converted to gif's). However, in the online Handbook I see no > nice diagrams that are (IMO) useful...with the exceptions of some > ASCII art. What's the policy on this...??? No pics or what? Image support in the documentation is something that I'm actively working on right now. Basically, use either EPS or PNG as the source format for your image (depending on whether it's line art or a bitmap), and let the Makefiles handle converting the images to other formats as necessary. There's currently no documentation for how you should include images in the documentation. That's because I'm still experimenting with the best way to do it. However, if you take a look at doc/en_US.ISO_8859-1/articles/vm-design/article.sgml you can see how I'm planning on doing it. There will probably only be small changes to that mechanism. The Makefile in that directory should work as well. The only caveat is that you need to install the ImageMagick port to conver the images to the correct format -- ImageMagick is a big port, but it makes writing the Makefiles easier. I plan on reducing the port requirements down to the bare minimum after I've finished this round of development. Hope that helps. Any questions, please ask on -doc, so that they (and the answers) go in to the archives. 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