Re: [Firebird-docs] Submitting documentation

[Paul V. <pa...@vi...>]

Hi Claire,

> Does the Firebird project have a set of guidelines, styles,
> recommended fonts, .css files for use with HTML documentation?

In the documentation subproject, the idea is to author everything in
XML, more specific: in DocBook format. This is a great way to
structure content without "polluting" it with presentational
fromatting. The DocBook XML files can then be (auto)converted to PDF,
HTML, PS, etc.

If you're interested in doing it like this, the best thing you can do
is first read this page:

  firebird.sourceforge.net/index.php?op=devel&sub=doc&id=development

After that, checkout the manual module from SourceForge (please read
the thread "manual module" in firebird-docs for a couple of setup
tips!) and build the documentation (almost nothing so far). Any
documentation you write yourself can also be built (and converted to
HTML) with the tools in your lcal copy of the manual tree.

If you want to stick with HTML-only, there is one very basic .css in
the manual tree. I really doubt if this has been painstakingly devised
for Firebird, it might just be a standard stylesheet. I'll attach it
underneath so you don't have to go through the CVS trouble just for
this one file.

> I have started documenting an infrastructure rollout, powered soley
> by Firebird, and I think it'd be helpful to others doing similar
> projects.

Yes, it would be great if you want to share it with others. Again,
DocBook is our preferred format but if you contribute something useful
it HTML, it will also be more than welcome. Maybe you or someone else
can convert it to DocBook later - and then back to HTML to put it on
the web :-)


Greetings,
Paul Vinkenoog


Here's the stylesheet (I broke some long lines):

/* Background */
body { background-color: #ffffff }

/* Font selection */
ul,ol,dt,dl,th,td,h1,h2,h3,h4,p
  { font-family: Verdana, Arial, Helvetica, sans-serif }

/* Font styles */
p {  font-size: 10pt}

td { font-size: 12pt }
th { font-size: 12pt; font-weight: bold}

h1 { font-size: 16pt; font-weight: bold}
h2 { font-size: 14pt; font-weight: bold}
h3 { font-size: 12pt; font-weight: bold}
h4 { font-size: 10pt; font-weight: bold; font-style: italic}

/* Lists */
ul { font-size: 10pt }
ol { font-size: 10pt }

dt { font-size: 10pt }
dl { font-size: 10pt }

/* Classes */
.mediaobject { border: thin; border-style: solid; margin-right: 100% }
.programlisting { padding: 1; width: auto; margin: auto; font-family:
                  Courier; border-style: solid; border-width: 1;
                  white-space: pre; background-color: #fffff7 }
.literallayout { padding: 1; width: auto; margin: auto; border-style:
                 solid; border-width: 1; background-color: #fffff7 }