Guest xionmark Posted September 7, 2004 Share Posted September 7, 2004 Hi, Is there a way to "upload" a bunch of HTML docs into the WIKI without having to cut and paste the HTML or edit manually? Let me explain. I have some ~3,200 individual HTML pages I'd like to put on the WIKI (HDK documentation for a single version of the HDK; I need to upload 3 versions) but I only know how to edit the WIKI by hand ... Any ideas? --Mark Quote Link to comment Share on other sites More sharing options...
Mario Marengo Posted September 7, 2004 Share Posted September 7, 2004 Hey Mark, As far as I know, the wiki does not understand full HTML (just a handful of tags), so copying doxygen-ated pages is probably not going to work at all Maybe post directions on how to generate one's own pages instead? Cheers! Quote Link to comment Share on other sites More sharing options...
Jason Posted September 7, 2004 Share Posted September 7, 2004 Hey Mark,As far as I know, the wiki does not understand full HTML (just a handful of tags), so copying doxygen-ated pages is probably not going to work at all Maybe post directions on how to generate one's own pages instead? Cheers! 13679[/snapback] We've considered trying to upgrade to something more full-featured like tikiwiki but the last version we tried couldn't import the phpwiki pages properly. I'll try again when I get a moment. TikiWiki allows HTML in the docs. Currently it might just have to be uploaded and linked off the Wiki. I wouldn't think it'd be a great idea to try to cram 300mb of pages into the SQL database anyway. Quote Link to comment Share on other sites More sharing options...
Marc Posted September 7, 2004 Share Posted September 7, 2004 Yeah, I definitely think the docs should be a seperate issue. The wiki is pretty free and loose with its sql code and as it is it taxes the server when it gets used. Quote Link to comment Share on other sites More sharing options...
Guest xionmark Posted September 7, 2004 Share Posted September 7, 2004 Maybe post directions on how to generate one's own pages instead? Hi Mario, Ahh gee, that's too easy :-) ... but then it'd be nice to have them already online and ready to view. Here's a small shell script to extract the files. Once extracted, fire up Doxy and let it have all these files to ingest ... yummy! --Mark #!/bin/csh # first, create a list of files to extract from the HDK dbase hviewfile -l > file_list.txt # create a list of directories to create cat file_list.txt | cut -f 1 -d '/' | uniq | sort > dir_list.txt # If on a Windoze machine, remove the \r character dos2unix dir_list.txt foreach dir (`cat dir_list.txt`) if(-d $dir) then echo directory $dir exists else mkdir $dir endif end # Now extract the header files from the HDK dbase foreach f (`cat file_list.txt`) hviewfile $f > $f end exit 0 Quote Link to comment Share on other sites More sharing options...
Guest Guest Posted September 7, 2004 Share Posted September 7, 2004 Thanks Mark! As soon as I'm done with this job , I'll start playing with the HDK.... ...what I meant was to post something like that on the wiki Cheers! Quote Link to comment Share on other sites More sharing options...
Mario Marengo Posted September 7, 2004 Share Posted September 7, 2004 Oooops... forgot to log in... that was me ^^ Quote Link to comment Share on other sites More sharing options...
Guest xionmark Posted September 7, 2004 Share Posted September 7, 2004 As soon as I'm done with this job , I'll start playing with the HDK.......what I meant was to post something like that on the wiki 13683[/snapback] Ooops ... missed that one ... I think I'm WIKI challeged ... too simple I guess .. OK, I'll put it up there. It'll be so COOL to have you working on the HDK!!!!! --Mark Quote Link to comment Share on other sites More sharing options...
Mario Marengo Posted September 8, 2004 Share Posted September 8, 2004 Hey Mark and Jason, I just tested the link to the 7.0 doxygen pages in the wiki, and they pretty much killed (froze) all browsers I tested them on (Konqueror, Mozilla, Firefox). The reason is that the pages were generated with the "TreeView" feature on. For docs of this size, it will take forever for the browser to run the Java script that generates it, so it will freeze for several minutes (I killed it before it finished so I don't know exactly how long a time... but *long*). I would suggest re-generating them (if possible) with the option GENERATE_TREEVIEW set to NO. The tree view takes forever to generate even in my local version of the docs, so... just thought I'd mention it. Cheers! Quote Link to comment Share on other sites More sharing options...
Guest xionmark Posted September 8, 2004 Share Posted September 8, 2004 Hey Mark and Jason,I just tested the link to the 7.0 doxygen pages in the wiki, and they pretty much killed (froze) all browsers I tested them on (Konqueror, Mozilla, Firefox). The reason is that the pages were generated with the "TreeView" feature on. For docs of this size, it will take forever for the browser to run the Java script that generates it, so it will freeze for several minutes (I killed it before it finished so I don't know exactly how long a time... but *long*). I would suggest re-generating them (if possible) with the option GENERATE_TREEVIEW set to NO. The tree view takes forever to generate even in my local version of the docs, so... just thought I'd mention it. Cheers! 13697[/snapback] My God you're quick!!! Yep, we just discovered the problem and made a note on the page, I'll regen the docs tonight and hopefully have them all up there tomorrow. IE (yuck!) works OK, but I don't have any problems locally once the first pass is done, which only takes about 30 secs. I really like the browser tree though, it makes it much easier to bop around the different pages, but will keep that in the downloadable files ... or maybe I should gen up both versions ..? What do you think? That'll take up more disk space so I don't know if that's such a good idea ... suggestions? --Mark Quote Link to comment Share on other sites More sharing options...
Mario Marengo Posted September 8, 2004 Share Posted September 8, 2004 I really like the browser tree though, it makes it much easier to bop around the different pages, but will keep that in the downloadable files ... or maybe I should gen up both versions ..? What do you think? 13698[/snapback] I agree it's a nice feature... but even 30 seconds is an eternity, man! I usually have a tab showing the alphabetical listing, and open specific things in separate tabs... but that's just me. I'd say keep the treeview in the downloadable versions, but remove it from the browsable ones -- else people might think the browser just crashed, when it's really just cooking the tree view. Oh; and make a note of it in the wiki (like you just did), so there are no surprises. Two cents. Cheers! Quote Link to comment Share on other sites More sharing options...
Jason Posted September 9, 2004 Share Posted September 9, 2004 New version of the Doxygen pages are up! Thanks Mark! Quote Link to comment Share on other sites More sharing options...
Guest xionmark Posted September 9, 2004 Share Posted September 9, 2004 I agree it's a nice feature... but even 30 seconds is an eternity, man! Woohoo! I tested the pages on a Linux box last night and it only took 5-10 seconds to load (locally) ... the 30 second metric was with me tired ol' SGI beast ... damn, I gotta get rid of that thing! --Mark Quote Link to comment Share on other sites More sharing options...
edward Posted September 10, 2004 Share Posted September 10, 2004 Nice. I hate to put a damper on your hard work but note that the current docs on the web page are based on the HDK headers prior to being made public. It doesn't make much difference but it's slightly cleaner. Quote Link to comment Share on other sites More sharing options...
Mario Marengo Posted September 10, 2004 Share Posted September 10, 2004 Yup; those load up fine now. Thanks Mark! Quote Link to comment Share on other sites More sharing options...
AndrewVK Posted September 17, 2004 Share Posted September 17, 2004 Unfortunately doxygen ignores descriptions of all functions See doxygen help - "Documenting the code" section It would be cool if somebody could write script (perl???) to modify header`s comments. Quote Link to comment Share on other sites More sharing options...
hoknamahn Posted September 17, 2004 Share Posted September 17, 2004 If I understood... Check it http://viipuri.hotmail.ru/h2doxygen.zip Quote Link to comment Share on other sites More sharing options...
Guest xionmark Posted September 17, 2004 Share Posted September 17, 2004 Hey guys, Sorry I haven't been able to reply, been slammed the last few days at work. Thanks for the Perl code, I'll check into it this weekend. --Mark Quote Link to comment Share on other sites More sharing options...
Jason Posted September 27, 2004 Share Posted September 27, 2004 BTW, the new version of the Wiki supports uploading files much better than the old one. Quote Link to comment Share on other sites More sharing options...
AndrewVK Posted September 27, 2004 Share Posted September 27, 2004 If I understood... Check it http://viipuri.hotmail.ru/h2doxygen.zip 13848[/snapback] Hey Hok thank You for rerl! I have just tested it. It works great but $string =~ s/\*\/\s/\*\/\*/g; # Replace "*/ " to "*/*" should be replaced with $string =~ s/\*\/\s/\*\/\*/g; # Replace "/* " to "/*!" Quote Link to comment Share on other sites More sharing options...
Recommended Posts
Join the conversation
You can post now and register later. If you have an account, sign in now to post with your account.
Note: Your post will require moderator approval before it will be visible.