CFD Online Logo CFD Online URL
www.cfd-online.com
[Sponsors]
Home > Forums > OpenFOAM

Would like local doxygen search form to work

Register Blogs Members List Search Today's Posts Mark Forums Read

Reply
 
LinkBack Thread Tools Display Modes
Old   January 1, 2008, 15:19
Default Hi, I don't know if this ac
  #1
unoder
Guest
 
Posts: n/a
Hi,

I don't know if this actually is the right place to ask, but I guess its relevant to somebody here, so here we go: I would like to be able to browse the doxygen documentation while offline and not connected to the internet.

However, when I type something in the "search field" I get a "Opening search.php" form up saying that this file is a PHP script. Then Firefox asks me what it should do with it.

I guess I should install something for the PHP scripting to work offline - php server? I'm running opensuse 10.0 (or 10.1?). Perhaps I can use yast?

Just tell me what I should download and try to install, and I'll try to make it work.

TIA,

Regards,
Martin
  Reply With Quote

Old   January 2, 2008, 04:30
Default Hi Martin! The "easiest" wa
  #2
Assistant Moderator
 
Bernhard Gschaider
Join Date: Mar 2009
Posts: 3,744
Rep Power: 36
gschaider will become famous soon enoughgschaider will become famous soon enough
Hi Martin!

The "easiest" way to browse offline on your machine (in my experienve) is to install a webserver with php, make the doxygen-directory accessible to it and point your webbrowser to http://127.0.0.1/path_to_doxy

Bernhard
__________________
Note: I don't use "Friend"-feature on this forum out of principle. Ah. And by the way: I'm not on Facebook either. So don't be offended if I don't accept your invitation/friend request
gschaider is offline   Reply With Quote

Old   January 3, 2008, 06:36
Default Hi Bernhard, Thanks a lot f
  #3
unoder
Guest
 
Posts: n/a
Hi Bernhard,

Thanks a lot for the idea. The webserver now works for a very simple "index.html" file in /srv/www/htdocs/index.html (simply saying: "This works").

However, I currently got a problem with my apache configuration files I think - get an annoying "403 error - missing permission", but I think I'll solve that problem...

I see I need to change my DocumentRoot in /etc/apache2/default-server.conf and point it to the OpenFOAM/doc/Doxygen-directory (hmmm. or perhaps xxxx/Doxygen/html-directory, where the index.html file is)...

I hope I get it working... If anyone tried it, please tell how you modified your .conf-files in /etc/apache2. Or perhaps I'll figure it out myself, when I get a bit more time to google for an answer to the 403-error...


Regards,
Martin
  Reply With Quote

Old   February 2, 2008, 20:56
Default Hi, In case anyone wants to
  #4
unoder
Guest
 
Posts: n/a
Hi,

In case anyone wants to save some time and browse the documentation offline: I had a problem with Doxygen linking to C source files which it couldn't find so three steps were necessary to get a satisfactory behaviour:

1) I added a symbolic link in ~/OpenFOAM/OpenFOAM-1.4.1-dev/doc/Doxygen/html to
/home/martin/OpenFOAM/OpenFOAM-1.4.1-dev/src, which then makes the relative paths work by apache.

2) The content type of the C-source files were recognized as "text/C source file" so whenever I clicked on a source file, firefox asked me what to do with the file (download / save as etc.). The fix: "AddType text/plain C c CPP cpp"

3) Then the usual documentroot/directory settings must be right. Here's my "default-server.conf" file (suggestions and improvements are welcome - I don't know much about apache, but this seem to work nice locally - "Options FollowSymLinks" must be enabled for everything to work):

---------
DocumentRoot "/home/martin/OpenFOAM/OpenFOAM-1.4.1-dev/doc/Doxygen/html"

<directory>
# Possible values for the Options directive are "None", "All",
# or any combination of:
# Indexes Includes FollowSymLinks SymLinksifOwnerMatch ExecCGI MultiViews
#
# Note that "MultiViews" must be named *explicitly* --- "Options All"
# doesn't give it to you.
#
# The Options directive is both complicated and important. Please see
# http://httpd.apache.org/docs-2.2/mod/core.html#options
# for more information.
Options FollowSymLinks
# AllowOverride controls what directives may be placed in .htaccess files.
# It can be "All", "None", or any combination of the keywords:
# Options FileInfo AuthConfig Limit
AllowOverride None
# Controls who can get stuff from this server.
Order allow,deny
Allow from all
</directory>


# -- MARTINS MODIFICATION: THINK OF SOURCE FILES AS --
# -- TEXT/PLAIN OR TEXT/HTML TO AVOID DOWNLOADING THEM --
AddType text/plain C c CPP cpp


# NOT SURE IF THIS IS NEEDED????
<ifmodule>
# Note that the name of the user directory ("public_html") cannot simply be
# changed here, since it is a compile time setting. The apache package
# would have to be rebuilt. You could work around by deleting
# /usr/sbin/suexec, but then all scripts from the directories would be
# executed with the UID of the webserver.
UserDir public_html
# The actual configuration of the directory is in
# /etc/apache2/mod_userdir.conf.
Include /etc/apache2/mod_userdir.conf
</ifmodule>


# Include all *.conf files from /etc/apache2/conf.d/.
#
# This is mostly meant as a place for other RPM packages to drop in their
# configuration snippet.
#
# You can comment this out here if you want those bits include only in a
# certain virtual host, but not here.
#
Include /etc/apache2/conf.d/*.conf

# The manual... if it is installed ('?' means it won't complain)
Include /etc/apache2/conf.d/apache2-manual?conf
ServerName laptop

ServerAdmin root@laptop

---------

And the search-form / php-part works really great... Suse YAST-installer did everything for me (php5). Hope somebody can use the "recipe" (and else I might use it next time I forgot what I did and need to reinstall).
  Reply With Quote

Old   February 4, 2008, 08:04
Default Hi Martin! Could you add th
  #5
Assistant Moderator
 
Bernhard Gschaider
Join Date: Mar 2009
Posts: 3,744
Rep Power: 36
gschaider will become famous soon enoughgschaider will become famous soon enough
Hi Martin!

Could you add this in the HowTo-secion of the Wiki? That would be great

Bernhard
__________________
Note: I don't use "Friend"-feature on this forum out of principle. Ah. And by the way: I'm not on Facebook either. So don't be offended if I don't accept your invitation/friend request
gschaider is offline   Reply With Quote

Old   February 4, 2008, 17:07
Default Sure Bernhard, I suppose yo
  #6
unoder
Guest
 
Posts: n/a
Sure Bernhard,

I suppose you meant to add it here?

http://openfoamwiki.net/index.php/Main_HowTos

And here's the link:

http://openfoamwiki.net/index.php/Ho..._while_offline

If anyone get trouble/suggestions/improvements/thinks it should somewhere else in the wiki-tree, please edit the wiki-entry... I don't pretend to be an expert here...
  Reply With Quote

Reply

Thread Tools
Display Modes

Posting Rules
You may not post new threads
You may not post replies
You may not post attachments
You may not edit your posts

BB code is On
Smilies are On
[IMG] code is On
HTML code is Off
Trackbacks are On
Pingbacks are On
Refbacks are On


Similar Threads
Thread Thread Starter Forum Replies Last Post
Collabaration diagrams in Doxygen srinath OpenFOAM 3 November 10, 2011 01:35
SEARCH A PROOF FOR DERIVING DIFF. FORM OF CL CFDUser Main CFD Forum 17 March 7, 2009 03:03
Using Doxygen shuo OpenFOAM Running, Solving & CFD 1 October 3, 2006 03:39
Doxygen and dot Kuan Tek Seang (Seang) OpenFOAM Installation 1 January 25, 2005 04:24
why my In-Form doesn't work? green Phoenics 2 May 27, 2004 21:03


All times are GMT -4. The time now is 22:01.