Keiron Liddle wrote:
> Where will the docs be located.
>
> I am writing/updating some docs for fop development and was wondering
> where I could put the docs.
>
> maybe docs/xml-docs as the base?
Joerg is probably the key person to answer this, but I would like to throw
in 2 cents worth. First, AFAIK, all of our current documentation flows out
of XML files. If this is not totally true (and it may not be), then it
probably should be (I think they call it "eating your own dog food"). So,
docs/xml-docs seems redundant. Perhaps a concept of sources and output would
be helpful here. Second, one of my goals with the doc is to explicitly
delineate between user doc and developer doc, so that we can generate
manuals and web-site areas that are appropriate for each -- specifically to
keep developer issues out of the user doc. I have been treating the
documents in docs/xml-docs/design as being developer doc, although there are
a few documents in the docs/xml-docs/fop directory that are
developer-oriented as well. I think it would be helpful to have our source
XML documents organized around that concept as well.
My recommended structure for the docs directory is as follows:
source
source/dev See note 1
source/user
build See note 2
build/pdf
build/html
transient (or temp) See note 3
stylesheet
(the other directories there now are ok -- graphics, examples, etc.)
Note 1 -- for stuff currently in "design" + the documents you are asking
about and the other developer documents. In my mind "design" is a subset of
"dev". It might be useful to have "design" as a subdirectory under "dev".
Note 2 -- perhaps this should be in xml-fop/build/docs instead. It is
important to have this be in a "build" or "output" directory so that no one
is tempted to, for example, edit the html files directly
Note 3 -- for transient transforms when doing builds, including the fo file.
The build could probably delete the contents, but sometimes it is nice to be
able to see the intermediate results.
All of this, of course, is contingent on Forrest requirements.
Sorry -- you asked a pretty simple question that was probably directed at
Joerg. I have been trying to document (and fix where possible) these
annoyances as they come up, hoping to use my still-mostly-newbie perspective
to lower the cost of bringing new newbies (??) on board.
It will require someone with commit abilities to do all of this, but, if
approved, I'll be glad to do the fixes and cleanup of the builds to match
the new structure.
Victor Mote
---------------------------------------------------------------------
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, email: [EMAIL PROTECTED]
