In this release, most of the sandbox projects have documentation, done
with our docbook system. I plan to make this documentation available as
html on our website, so people looking at, say the DictionaryAnnotator,
can click a link and go that component's html page(s).
To do this without excessive space consumption on the web server, I plan
to alter the uima-website layout for sandbox projects, from:
docs/
downloads/
sandbox/
simple-server/
images/
... lots of standard docbook file image png/gif files
callouts/
... lots of standard docbook file image png/gif files
simpleServerUserGuide
... image files unique for simpleServerUserGuide
simpleServerUserGuide/
css/
stylesheet-html.css
simpleServerUserGuide.html
anotherSandboxProject'sDoc/
images/
... lots of standard docbook file image png/gif files
callouts/
... lots of standard docbook file image png/gif files
anotherSandboxProjectUserGuide
... image files unique for anotherSandboxProjectUserGuide
anotherSandboxProjectUserGuide/
css/
stylesheet-html.css
anotherSandboxProjectUserGuide.html
etc.
to one where the standard docbook images and callouts are shared. It
would remove one level of directory, too:
docs/
downloads/
sandbox/
** Removed simple-server/
images/
... lots of standard docbook file image png/gif files
callouts/
... lots of standard docbook file image png/gif files
simpleServerUserGuide
... image files unique for simpleServerUserGuide
anotherSandboxProjectUserGuide
... image files unique for anotherSandboxProjectUserGuide
anotherSandboxProjectUserGuide
... image files unique for anotherSandboxProjectUserGuide
... etc
simpleServerUserGuide/
css/
stylesheet-html.css
simpleServerUserGuide.html
anotherSandboxProjectUserGuide/
css/
stylesheet-html.css
anotherSandboxProjectUserGuide.html
anotherSandboxProjectUserGuide/
css/
stylesheet-html.css
anotherSandboxProjectUserGuide.html
... etc
This re-arrangement doesn't change the relative directory relationship
between the html, the css, and the images, so the imbedded links should
still work.
The actual user-guide.html files will be Svn copied here so they won't
take any significant space in SVN (but they will of course take space on
the web server, but with this arrangement, many less files per project
due to sharing the docbook boilerplate images).
Any objections?
-Marshall
