Greg Ercolano wrote: > Albrecht Schlosser wrote: >> Problem #1: The URL's of the doxygen comments may change from one >> generation run to the next, and especially from one version of doxygen >> to the next one (we found a big diff. between 1.5.7 and 1.5.9). This can >> result in loss of comments, or maybe also in "mixing" comments from one >> file with a new file that "inherited" the old URL (maybe). > > Mmm -- I suppose at worst we can include a custom tag > in the docs that a post-process could look for, and append > new info to the bottom of each HTML file. > > This "post process" could then be applied as part of the > steps to uploading new docs to the website.
Greg, there is already useful php code that does this "post processing" dynamically for the 1.1 documentation, but there we had fix html file names, and the document URL does never change, e.g. Fl_Choice::value() : http://www.fltk.org/documentation.php/doc-1.1/Fl_Choice.html#Fl_Choice.value http://www.fltk.org/doc-1.1/Fl_Choice.html#Fl_Choice.value http://www.fltk.org/doc-1.3/classFl__Choice.html#69c4f1a26612986d7c14d4882d2cd19d FLTK 1.1 with and w/o comments, resp., and FLTK 1.3. The problem I'm seeing here is that doxygen uses some strange generated names, although "classFl__Choice.html" might be a constant part here. But I saw significant diffs (IIRC about 190 renamed files) between doxygen 1.5.7 and 1.5.9. This would also change the URL of a particular document, and thus we woule "lose" the comments that are linked to the URL in the database. That's the point. > I know web scripting pretty well, and feel pretty confident > I could make something that works. The only tricky part I don't > know about is the existing login account stuff. But if I looked > at the existing PHP code, I could probably figure it out. Never > saw the PHP code before; I think that involves web server access, > which I may have and not know it. Accessing the web site is easy. When you're logged in, go to Web Site - Download the nightly backups, and read the description. There is also the URL for svn access to the web site. The first step would be to check out the web site and look at the php code (documentation.php). > At worst, I could test these features on my own website. That would be the next step, and the description tells you how to do it with your own (Linux) server. I did it recently, and it was straigt forward as described there. I only had to do a few minor tweaks ("touch" a missing (generated) file, change mail addresses (!), and download the STR files (optional, I wanted to see if this works :-) ). Mike, if you're reading this, would it be okay to add a few comments to this "Creating a Developer Database" paragraph in backups.php ? >> Problem #2: Doxygen uses a sophisticated .css (cascading style sheet) >> file. > > Right, though I seem to recall there are ways they supply to > make extensions to that. > > Also, it's likely the 'post process' to append the extra HTML > required for the user comments could be a separate page, ie. > where the comments are a separate frame with its own html/css. Maybe an own frame would work, or we would have to use a customized .css for the onlin docs with comments. Again, please look at the php code to see what is there already (I wouldn't want to invent the wheel again ;-) ). >> Any ideas for problems #1 and #2 ? > > I guess the place to start for me would be to look at what > the PHP code looks like. I have dev access, but I don't think > I have details on how to access the website to view the PHP. see above. > I figure Mike is busy with other stuff, and if so, I can jump > on this. Fine :-) Albrecht _______________________________________________ fltk-dev mailing list [email protected] http://lists.easysw.com/mailman/listinfo/fltk-dev
