[drupal-docs] Docbook ++ question

judah judah at drumbeatinsight.com
Fri Apr 22 16:37:25 UTC 2005


I just joined this discussion so I do not have the answers for you but I 
would like to keep this whole project in Drupal personally. If there are 
module developers on this documentation team then we should add the 
features to the book module if they are not there.

I've looked into the phptemplate and I know we could use that to 
generate different document types with ease. We could have a template 
for printerfriendly pages, a template for pdf's, a template of xml etc. 
Or we could create scripts to generate the pdf, ps etc.

I don't know where this whole thing is at in it's progress but it sounds 
like it we are at the discussion table. If it were me I would come up 
with a table of contents and copy and update the content from the main 
site. Have a few editors (I could be one) that have admin control of the 
content. Have a few graphic artists taking stills or videos (I could be 
one of these as well). We don't want to make it harder than it is.

Best Regards,
Judah

vlado wrote:

>What is the aim of having the Drupal docs in Docbook?
>or
>What are the targets?
>
>1. Is it to provide easy to print PDFs?
>2. Is it to provide easy conversion to HTML, PS, LaTeX, many others?
>3. Is it to help authoring?
>4. Is it required to provide documentation in a bundle for offline
>   reading?
>5. Have I missed some answers? possibly, yes
>
>There are a few related questions?
>
>How do the users prefer to have the documentation? What are their
>preferred ways of using the docs, or consulting them?
>
>I think starting from these questions will lead towards the format mix
>for the documentation.
>
>I have a feeling that using the book module on drupal is a good
>solution, but it lacks features. The tools for maintaining the book 
>hierarchy and TOCs are there. There is revision control present. There
>is a shortage of output formats though.
>
>Is the current drupal book module good and comfortable to use to write
>and publish drupal docs?
>please answer this
>
>Why am I asking all of these questions. Well, if the answer to the last
>question is yes. I will volunteer to spend some time on
>producing an add-on to the book module, which will output proper
>docbook xml. Coming from me it is probably a tall promise, but I'll try
>to keep it. From there on, it will be a design matter. I'm not good at
>that unfortunately. At least not feeling comfortable with it.
>
>I'll try and produce template scripts for generating pdf, ps, standalone
>html from the docbook sources. Thsi will probably cover the cases for
>offline documentation. To even go that way, I need to be
>conviced that it will fit the requirements and the working habits of the
>documentation team. Otherwise I will be wasting my efforts and time.
>
>Cheers,
>Vlado
>
>  
>


-- 
re·gard
 1. To look at attentively; observe closely.
 2. To look upon or consider in a particular way.
 3. To hold in esteem or respect: She regards her teachers highly.
 4. To relate or refer to; concern: This item regards their liability. 

best
 1. Surpassing all others in excellence, achievement, or quality; most excellent: the best performer; the best grade of ore.
 2. Most satisfactory, suitable, or useful; most desirable: the best solution; the best time for planting.
 3. Greatest; most: He spoke for the best part of an hour.
 4. Most highly skilled: the best doctor in town.



-- 
No virus found in this outgoing message.
Checked by AVG Anti-Virus.
Version: 7.0.308 / Virus Database: 266.10.2 - Release Date: 4/21/2005




More information about the drupal-docs mailing list