[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
Re: [seul-edu] HowTo Draft
* Bill Tihen -- TECHNOLOGY (bill@mail.tasis.ch) [991019]:%y14Tue, Oct 19, 1999 at 04:50:00PM +0200]:
> I thought I posted it to the list -- but perhaps I was
> wrong. At the moment I don't have it on a webpage.
> Guess I should do that.
You did post it, I've just been too busy to reply yet ;)...
>
> In anycase -- Here is a copy.
>
> <!doctype book PUBLIC "-//Davenport//DTD DocBook
> V3.0//EN []>
3.1 ... The CVS version of sgmltools works with it (as do other tools, I
hear) and it has some options that are usefull (like questionandanswerset
or something like that).
>
> <book>
would we rather have them as articles, since they rarely are that long
(books are usually split to start a new page in the beginning of each
chapter).
> <bookinfo>
> <date>1999-10-08</date>
> <title>SEUL-EDU HowTos</title>
> <subtitle>Installation, Template &
> Expectations</subtitle>
> <authorgroup>
> <author>
>
> <firstname>Bill</firstname>
>
> <surname>Tihen</surname>
> CONTACT - Info (email)?
Use:
<affiliation><orgname>ramin@cs.joensuu.fi</orgname></affiliation>
(From Norm's examples... you could use <address><email> </email></address>
instead of <orgname>... (I haven't tested it to see if Norm's stylesheets
support it, but it is in the DTD.)
> </author>
</authorgroup>
>
Inside
<legalnotice>
> <copyright>&SEUL-EDU-Copyright;</copyright>
Where is the entity defined?
</legalnotice>
>
> <legalnotice>&SEUL-EDU-Legal-Notice;</legalnotice>
Where is the entity defined?
Should this be in the same as the above?
> </authorgroup>
Remove from here (legalnotice is not allowed in authorgroup).
> AUDIENCE?
Hmm?!
> </bookinfo>
>
> <toc></toc>
For articles this isn't generated automatically, I'm still trying to get
my customizations to the stylesheets to work. When I get that done I'll
post the info to the list on how to do it. (If anyone knows, please
tell me!)
>
> <chapter>
Use id's in the attributes to sections and chapters. It makes life a lot
easier on the long run.
> <title>Introduction</title>
> <para>This document is intended for
> people who want to
> write </para>
> <sect1>
> <title>Document Purpose</title>
> <para></para>
> </sect1>
> <sect1>
> <title>Intended
> Audience</title>
> <para></para>
> </sect1>
> <sect1>
> <title>Background Information &
> History</title>
> <para></para>
> </sect1>
> </chapter>
>
> <chapter>
> <title>Obtaining & Installing
> DocBook</title>
> <para>This<para>
> <sect1>
> <title></title>
> <para></para>
> </sect1>
> </chapter>
>
> <chapter>
> <title>Getting Started</title>
> <para>This<para>
> <sect1>
> <title>Template</title>
> <para></para>
> </sect1>
> <sect1>
> <title>Editing</title>
> <para></para>
> </sect1>
> <sect1>
> <title>Syntax Checking</title>
> <para></para>
> </sect1>
> <sect1>
> <title>Output</title>
> <para></para>
> </sect1>
> </chapter>
>
> <chapter>
> <title>Expectations</title>
> <para>This<para>
> <sect1>
> <title>Structure</title>
> <para></para>
> <sect2>
>
> <title>Coverpage</title>
> <para></para>
> </sec2>
> <sect2>
>
> <title>Introduction</title>
> <para></para>
> </sec2>
> <sect2>
> <title>Chapters</title>
> <para></para>
> </sec2>
> <sect2>
> <title>Sections</title>
> <para></para>
> </sec2>
> <sect2>
> <title>Appendix</title>
> <para></para>
> </sec2>
> <sect2>
> <title>Glossary -
> optional</title>
> <para></para>
> </sec2>
> <sect2>
> <title>Index</title>
> <para></para>
> </sec2>
> </sect1>
> <sect1>
> <title>Presentation</title>
> <para></para>
> <sect2>
> <title>Examples</title>
> <para>example,
> title</para>
For examples use Example and InformalExample (see reference for more details,
I don't have the reference on my at the moment and can't remember the
details). (The main difference is, that example requires a title, whereas
informalexample doesn't.)
> </sec2>
> <sect2>
> <title>Screen
> Text</title>
> <para>prompt,
> userinput</para>
This stuff should go in a <screen> tag, which is exactly what it's for.
> </sec2>
> <sect2>
> <title>Code
> Samples</title>
> <para>programlisting
> role="C"</para>
<programlisting> for all of this... A good idea is to encase them in
To avoid using entities in the code you can either use:
<programlisting> <!-- or screen, or whatever -->
<![CDATA[
myclass->myfield
]]>
</programlisting>
, where the only thing that you can't have in the code is "]]>".
Or then you can get the code from a separate file:
<programlisting>
<inlinegraphic format='linespecific' fileref='program.c'></inlinegraphic>
</programlisting>
Yes, this is a hack which will be better supported in following versions
of DocBook (or so I hear ;).
> </sec2>
> <sect2>
> <title>Tables</title>
> <para>table frame,
> tgroup, thead, tbody, row, entry,
> align</para>
Read the docs for how to use tables, I haven't for quite some time and
figuring it out from the DTD is tiresome. If needed I'll dig around for
my code which used many of these features and try to describe them here.
> </sec2>
> <sect2>
> <title>Graphics</title>
> <para>
> html -- gifs &
> jpgs
> printed -- ps
> conditional
> content -- include, ignore
> </para>
Multiple options, but <graphic fileref="foobar"></graphic> will give you a
reference to foobar.eps in print versions and foobar.gif in the HTML version.
Using an extension means that the default functionality will not be used.
Other options are also available, but inlineGraphic's should not be used
(they will be removed in 4.0)!
I'll continue from here sometime when I have the reference handy (or Norm's
book which can be downloaded now) and I've gotten some sleep...
hope this helps, more to come later (I've been through the pain of learning
the stuff from old docs, the dtd, and trial and error, so I'm really glad
if I can help).
ramin
--
Ramin Miraftabi Student of Computer Science
email: ramin@cs.joensuu.fi University of Joensuu
WWW: http://dawn.joensuu.fi/~ramin/ Joensuu, Finland
- GPG public key ID 49C9CFF7 -- (c) Copyright 1999 -