It seems the main issue with the main distro is to avoid redundant docs.
If we package either the PDF or HTML along with the doxygen
documentation/src dir, there's redundant data for the images.
(html, pdf, and documentation/src each have their own copy of images)
So it seems to make sense to package things in such a way as to avoid
redundancy.
Also: I think most people expect html docs. PDF readers tend to be
slow, and 'page oriented' docs are only really useful if the intention
is for print outs, which few people probably need.
So adding my 2 cents, I can see a few scenarios with the above in mind:
1) Old fashioned main distro.
Pre-built html docs only, separate "developer-docs" distro.
2) Light main distro with separate docs.
No local docs at all with source. index.html refers to website.
Elaborating on these:
1) On website for download would be:
fltk-1.3.x-src.tgz -- src with pre-built html docs only (no
documentation/src dir)
fltk-1.3.x-dev-docs.tgz -- doxygen src, pre-built PDF
fltk-1.3.0.pdf -- pre-built PDF
This is the most like what we've had in the past; pre-built read-only
html docs included with source, eg:
documentation/
|-- README -- explains doxygen docs are a separate download
|-- Makefile -- if src dir doesn't exist, prints error
indicating separate download
|-- html/ -- prebuilt HTML dir
|-- index.html -- referrer page pointing to
documentation/html/index.html
The separate dev-docs distro would just have fltk-1.3.x/documentation/src
and Doxy files, and a pre-built PDF.
With the two tars installed together, user would have pre-built html + pdf
and doxygen rebuild capability.
2) Light main distro with separate docs; no docs at all with source.
On website for download:
fltk-1.3.0-src.tgz <-- src code only, no local docs
(documentation/index.html is referral to website)
fltk-1.3.0-docs.tgz <-- includes documentation/src, pre-built html + pdf
fltk-1.3.0.pdf <-- pre-built PDF
Main distro has only src, no docs. documentation dir would contain:
documentation/
|--- README -- header explains separate download needed for
local docs
|--- Makefile -- if src dir doesn't exist, prints error
indicating separate download
|--- index.html -- a 'referral' page to fltk.org's docs page for
this version
Separate 'docs' distro has the entire fltk-1.3.0/documentation dir
with all the doxygen files, and a pre-built HTML + PDF.
With the two tars installed together, user would have pre-built html + pdf
and doxygen rebuild capability.
_______________________________________________
fltk-dev mailing list
[email protected]
http://lists.easysw.com/mailman/listinfo/fltk-dev
