You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@cocoon.apache.org by Bruno Dumon <br...@outerthought.org> on 2005/06/13 18:21:44 UTC
[docs] import tool for current docs
Thought I'd help out a bit with the documentation effort by writing a
tool to import the current documentation.
The facts:
* it's written in javascript (rhino) to lower the hacking-barrier
* it imports the xdocs starting from the source tree. It translates
them to html with an XSL and cleans them up with the htmlcleaner (so
that they would look as if edited through the daisy-wiki)
* it imports the images
* while creating the documents and images, a mapping between original
filenames and daisy document IDs is kept, and in a second pass the links
in all documents are translated.
What still needs to be done & issues:
* the current XSL just contains the bare minimum to get something done
(I focussed my efforts on the import.js), someone needs to
systematically look at all the tags in the document-v10 dtd to see if
they're handled correctly (e.g. <dl> is still todo).
* testing/verifying of the results
* only document-v10 based documents are supported, if necessary support
for faqs and others could be added (= mainly xsl work)
* Daisy doesn't have a <code>-like tag, we need to decide what to do
with this. Daisy doesn't have this since the Mozilla/IE editor APIs
don't support the creation of this type of tag.
How to use:
* save the two attached files somewhere
* customize the configuration variables on top of import.js
* download/install a daisy distro (version 1.3-M2)
* run with "$DAISY_HOME/bin/daisy-js import.js"
--
Bruno Dumon http://outerthought.org/
Outerthought - Open Source, Java & XML Competence Support Center
bruno@outerthought.org bruno@apache.org
Re: [docs] import tool for current docs
Posted by Steven Noels <st...@outerthought.org>.
On 14 Jun 2005, at 09:23, Steven Noels wrote:
> People commonly use <tt> for <code>-like elements. Unfortunately, both
> Moz and IE don't support creation of <tt> elements in their editor
> APIs.
not installed yet, but:
http://svn.cocoondev.org/viewsvn?view=rev&rev=2054&root=daisy
</Steven>
--
Steven Noels http://outerthought.org/
Outerthought Open Source Java & XML
stevenn at outerthought.org stevenn at apache.org
Re: [docs] import tool for current docs
Posted by Steven Noels <st...@outerthought.org>.
On 14 Jun 2005, at 00:45, Ross Gardler wrote:
> Bruno Dumon wrote:
>> * Daisy doesn't have a <code>-like tag, we need to decide what to do
>> with this. Daisy doesn't have this since the Mozilla/IE editor APIs
>> don't support the creation of this type of tag.
>
> <p class="code"/> ?
<code> is an inline element - what you suggest is <pre>
People commonly use <tt> for <code>-like elements. Unfortunately, both
Moz and IE don't support creation of <tt> elements in their editor
APIs.
</Steven>
--
Steven Noels http://outerthought.org/
Outerthought Open Source Java & XML
stevenn at outerthought.org stevenn at apache.org
Re: [docs] import tool for current docs
Posted by Bruno Dumon <br...@outerthought.org>.
On Tue, 2005-06-14 at 09:24 +0200, Steven Noels wrote:
> On 14 Jun 2005, at 09:12, Bruno Dumon wrote:
>
> > Anyway, I'm thinking that for this and the other issue (anchors), for
> > the moment we could simply make sure they are not lost during the
> > import, and then see afterwards to do something about it.
>
> Would generic support for an inline <span class="xyz"> be an option?
That would not solve the editing problem.
--
Bruno Dumon http://outerthought.org/
Outerthought - Open Source, Java & XML Competence Support Center
bruno@outerthought.org bruno@apache.org
Re: [docs] import tool for current docs
Posted by Steven Noels <st...@outerthought.org>.
On 14 Jun 2005, at 09:12, Bruno Dumon wrote:
> Anyway, I'm thinking that for this and the other issue (anchors), for
> the moment we could simply make sure they are not lost during the
> import, and then see afterwards to do something about it.
Would generic support for an inline <span class="xyz"> be an option?
</Steven>
--
Steven Noels http://outerthought.org/
Outerthought Open Source Java & XML
stevenn at outerthought.org stevenn at apache.org
Re: [docs] import tool for current docs
Posted by Bruno Dumon <br...@outerthought.org>.
On Mon, 2005-06-13 at 23:45 +0100, Ross Gardler wrote:
> Bruno Dumon wrote:
> > * Daisy doesn't have a <code>-like tag, we need to decide what to do
> > with this. Daisy doesn't have this since the Mozilla/IE editor APIs
> > don't support the creation of this type of tag.
>
> <p class="code"/> ?
nope, code is an inline tag.
Anyway, I'm thinking that for this and the other issue (anchors), for
the moment we could simply make sure they are not lost during the
import, and then see afterwards to do something about it.
--
Bruno Dumon http://outerthought.org/
Outerthought - Open Source, Java & XML Competence Support Center
bruno@outerthought.org bruno@apache.org
Re: [docs] import tool for current docs
Posted by Ross Gardler <rg...@apache.org>.
Bruno Dumon wrote:
> * Daisy doesn't have a <code>-like tag, we need to decide what to do
> with this. Daisy doesn't have this since the Mozilla/IE editor APIs
> don't support the creation of this type of tag.
<p class="code"/> ?
Ross
Re: [docs] import tool for current docs
Posted by Bruno Dumon <br...@outerthought.org>.
On Mon, 2005-06-13 at 18:21 +0200, Bruno Dumon wrote:
<snip/>
> What still needs to be done & issues:
<snip/>
> * Daisy doesn't have a <code>-like tag, we need to decide what to do
> with this. Daisy doesn't have this since the Mozilla/IE editor APIs
> don't support the creation of this type of tag.
I've found a way to achieve this anyhow, so that's one thing less to
worry about.
--
Bruno Dumon http://outerthought.org/
Outerthought - Open Source, Java & XML Competence Support Center
bruno@outerthought.org bruno@apache.org