Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Building the php for the simgrid homepage on gforge
authoralegrand <alegrand@48e7efb5-ca39-0410-a469-dd3cf9ba447f>
Tue, 6 Dec 2005 16:58:43 +0000 (16:58 +0000)
committeralegrand <alegrand@48e7efb5-ca39-0410-a469-dd3cf9ba447f>
Tue, 6 Dec 2005 16:58:43 +0000 (16:58 +0000)
git-svn-id: svn+ssh://scm.gforge.inria.fr/svn/simgrid/simgrid/trunk@1865 48e7efb5-ca39-0410-a469-dd3cf9ba447f

doc/index.php.in [moved from doc/index.php with 58% similarity]
tools/doxygen/index_php.pl [new file with mode: 0755]

index a005153..226462f 100644 (file)
@@ -24,6 +24,7 @@ html: $(DOCSOURCES) Doxyfile logcategories.doc simgrid_modules.map simgrid_modul
        ../tools/doxygen/toc_create.pl FAQ.doc FAQ.toc
        ../tools/doxygen/toc_create.pl index.doc index.toc
        doxygen Doxyfile >/dev/null
+       ../tools/doxygen/index_php.pl index.php.in doc/index.html index.php
        cp @srcdir@/simgrid_logo.png @srcdir@/simgrid_modules.png html/
        cp @srcdir@/Paje_MSG_screenshot_thn.jpg @srcdir@/Paje_MSG_screenshot.jpg html/
        for i in `find html -name '*.html'` ; do \
similarity index 58%
rename from doc/index.php
rename to doc/index.php.in
index d81d7dc..a491bb6 100644 (file)
@@ -73,16 +73,7 @@ echo '<?xml version="1.0" encoding="UTF-8"?>';
                <td style="text-align: right; vertical-align: top;"><a href="http://<?php echo $domain; ?>"><img src="http://<?php echo $domain; ?>/themes/inria/images/logo.png" border="0" alt="gforge INRIA" width="198" height="52" /></a></td>
-<div class="tabs">
-  <ul>
-    <li><a href="doc/index.html"><span>Main&nbsp;Page</span></a></li>       <li><a href="doc/faq.html"><span>FAQ</span></a></li>
-    <li><a href="doc/modules.html"><span>Modules API</span></a></li>
-    <li><a href="doc/publis.html"><span>Publications</span></a></li>
-    <li><a href="doc/pages.html"><span>Related&nbsp;Pages</span></a></li>
-  </ul></div>
- </center><p><br>
 <table border="0" width="100%" cellspacing="0" cellpadding="0">
@@ -132,59 +123,7 @@ while (!feof($handle)) {
 $contents=str_replace("Welcome to", "Welcome to the", $contents);
 echo $contents; } ?>
-The specific goal of the project is to facilitate research in the area of
-distributed and parallel application scheduling on distributed computing
-platforms ranging from simple network of workstations to Computational
-<h2><a class="anchor" name="overview">
-Overview of the toolkit components</a></h2>
-As depicted by the following diagram, the SimGrid toolkit is basically three-layered (click on the picture to jump to a specific component).<p>
- <IMG style="border:0px "SRC="doc/simgrid_modules.png" USEMAP="#simgrid_modules">
-<MAP NAME="simgrid_modules">
-<AREA SHAPE="poly" COORDS="418,171,418,139,343,139,343,89,239,89,239,171" href="doc/group__GRAS__API.html" ALT="GRAS">
-<AREA COORDS="428,89,607,171" href="doc/group__SMPI__API.html" ALT="SMPI">
-<AREA COORDS="50,89,229,171" href="doc/group__MSG__API.html" ALT="MSG">
-<AREA COORDS="50,180,607,240" href="doc/group__SURF__API.html" ALT="SMPI">
-<AREA SHAPE="poly" COORDS="43,89,12,89,12,313,607,313,607,250,43,250" href="doc/group__XBT__API.html" ALT="XBT">
-<AREA COORDS="347,89,417,133" href="doc/group__AMOK__API.html" ALT="AMOK">
-<br><b>Relationships between the SimGrid components</b>
-<h3><a class="anchor" name="overview_fondation">
-Base layer</a></h3>
-The base of the whole toolkit is constituted by the <b><a class="el" href="doc/group__XBT__API.html">XBT</a> (eXtended Bundle of Tools)</b>.<p>
-It is a portable library providing some grounding features such as <a class="el" href="doc/group__XBT__log.html">Logging support</a>, <a class="el" href="doc/group__XBT__ex.html">Exception support</a> and <a class="el" href="doc/group__XBT__config.html">Configuration support</a>. XBT also encompass the following convenient datastructures: <a class="el" href="doc/group__XBT__dynar.html">Dynar: generic dynamic array</a>, <a class="el" href="doc/group__XBT__fifo.html">Fifo: generic workqueue</a>, <a class="el" href="doc/group__XBT__dict.html">Dict: generic dictionnary</a>, <a class="el" href="doc/group__XBT__heap.html">Heap: generic heap data structure</a>, <a class="el" href="doc/group__XBT__set.html">Set: generic set datatype</a> and <a class="el" href="doc/group__XBT__swag.html">Swag: O(1) set datatype</a>.<p>
-See the <a class="el" href="doc/group__XBT__API.html">XBT</a> section for more details.<h3><a class="anchor" name="overview_kernel">
-Simulation kernel layer</a></h3>
-The core functionnalities to simulate a virtual platform are provided by a module called <b><a class="el" href="doc/group__SURF__API.html">SURF</a></b> ("that's historical, my friend"). It is very low-level and is not intended to be used as such by end-users. Instead, it serve as a basis for the higher level layer.<p>
-SURF main features are a fast max-min linear solver and the ability to change transparently the model used to describe the platform. This greatly eases the comparison of the several models existing in the litterature.<p>
-See the <a class="el" href="doc/group__SURF__API.html">SURF</a> section for more details.<h3><a class="anchor" name="overview_envs">
-Programmation environments layer</a></h3>
-This simulation kernel is used to build several programmation environments. Each of them target a specific audiance and constitute a different paradigm. To choose which of them you want to use, you have to think about what you want to do and what would be the result of your work.<p>
-<li>If you want to study a theoritical problem and compare several heuristics, you probably want to try <b><a class="el" href="doc/group__MSG__API.html">MSG</a></b> (yet another historical name). It was designed exactly to that extend and should allow you to build easily rather realistic multi-agents simulation. Yet, realism is not the main goal of this environment and the most annoying technical issues of real platforms are masked here. Check the <a class="el" href="doc/group__MSG__API.html">MSG</a> section for more information.</li></ul>
-<li>If you want to study the behaviour of a MPI application using emulation technics, you should have a look at the <b><a class="el" href="doc/group__SMPI__API.html">SMPI</a></b> (Simulated MPI) programming environment. Unfortunately, this work is still underway. Check the <a class="el" href="doc/group__SMPI__API.html">SMPI</a> section for more information.</li></ul>
-<li>If you want to develop a real distributed application, then you may find <b><a class="el" href="doc/group__GRAS__API.html">GRAS</a></b> (Grid Reality And Simulation) useful. This is an API for the realization of distributed applications. <br>
- Moreover, there is two implementations of this API: one on top of the SURF (allowing to develop and test your application within the comfort of the simulator) and another suited for deployment on real platforms (allowing the resulting application to be highly portable and extremely efficient). <br>
- Even if you do not plan to run your code for real, you may want to switch to GRAS if you intend to use MSG in a very intensive way (e.g. for simulating a peer-to-peer environment). <br>
- See the <a class="el" href="doc/group__GRAS__API.html">GRAS</a> section for more details.</li></ul>
-If your favorite programming environment/model is not there (BSP, components, etc.) is not represented in the SimGrid toolkit yet, you may consider adding it. You should contact us first on the <a href="doc/http://lists.gforge.inria.fr/mailman/listinfo/simgrid-devel>">SimGrid developers mailing list</a>, though.<p>
-Any question, remark or suggestion are welcome on the <a href="doc/http://lists.gforge.inria.fr/mailman/listinfo/simgrid-user>">SimGrid users mailing list</a>.<p>
 <?php if ($handle=fopen('http://'.$domain.'/export/projnews.php?group_name='.$group_name,'r')){
 $contents = '';
 while (!feof($handle)) {
diff --git a/tools/doxygen/index_php.pl b/tools/doxygen/index_php.pl
new file mode 100755 (executable)
index 0000000..d3a2503
--- /dev/null
@@ -0,0 +1,93 @@
+#!/usr/bin/perl -w
+($#ARGV >= 2) or die "Usage: index_php.pl <input-php.in-file> <input-html-file> <output-php-file>";
+$inputphp  = $ARGV[0];
+$inputhtml  = $ARGV[1];
+$output = $ARGV[2];
+my($onglets) = '
+<div class="tabs">
+  <ul>
+    <li><a href="doc/index.html"><span>Main&nbsp;Page</span></a></li>       <li><a href="doc/faq.html"><span>FAQ</span></a></li>
+    <li><a href="doc/modules.html"><span>Modules API</span></a></li>
+    <li><a href="doc/publis.html"><span>Publications</span></a></li>
+    <li><a href="doc/pages.html"><span>Related&nbsp;Pages</span></a></li>
+  </ul></div>
+ </center><p><br>
+my($body) = '
+The specific goal of the project is to facilitate research in the area of
+distributed and parallel application scheduling on distributed computing
+platforms ranging from simple network of workstations to Computational
+<h2><a class="anchor" name="overview">
+Overview of the toolkit components</a></h2>
+As depicted by the following diagram, the SimGrid toolkit is basically three-layered (click on the picture to jump to a specific component).<p>
+ <IMG style="border:0px "SRC="doc/simgrid_modules.png" USEMAP="#simgrid_modules">
+<MAP NAME="simgrid_modules">
+<AREA SHAPE="poly" COORDS="418,171,418,139,343,139,343,89,239,89,239,171" href="doc/group__GRAS__API.html" ALT="GRAS">
+<AREA COORDS="428,89,607,171" href="doc/group__SMPI__API.html" ALT="SMPI">
+<AREA COORDS="50,89,229,171" href="doc/group__MSG__API.html" ALT="MSG">
+<AREA COORDS="50,180,607,240" href="doc/group__SURF__API.html" ALT="SMPI">
+<AREA SHAPE="poly" COORDS="43,89,12,89,12,313,607,313,607,250,43,250" href="doc/group__XBT__API.html" ALT="XBT">
+<AREA COORDS="347,89,417,133" href="doc/group__AMOK__API.html" ALT="AMOK">
+<br><b>Relationships between the SimGrid components</b>
+<h3><a class="anchor" name="overview_fondation">
+Base layer</a></h3>
+The base of the whole toolkit is constituted by the <b><a class="el" href="doc/group__XBT__API.html">XBT</a> (eXtended Bundle of Tools)</b>.<p>
+It is a portable library providing some grounding features such as <a class="el" href="doc/group__XBT__log.html">Logging support</a>, <a class="el" href="doc/group__XBT__ex.html">Exception support</a> and <a class="el" href="doc/group__XBT__config.html">Configuration support</a>. XBT also encompass the following convenient datastructures: <a class="el" href="doc/group__XBT__dynar.html">Dynar: generic dynamic array</a>, <a class="el" href="doc/group__XBT__fifo.html">Fifo: generic workqueue</a>, <a class="el" href="doc/group__XBT__dict.html">Dict: generic dictionnary</a>, <a class="el" href="doc/group__XBT__heap.html">Heap: generic heap data structure</a>, <a class="el" href="doc/group__XBT__set.html">Set: generic set datatype</a> and <a class="el" href="doc/group__XBT__swag.html">Swag: O(1) set datatype</a>.<p>
+See the <a class="el" href="doc/group__XBT__API.html">XBT</a> section for more details.<h3><a class="anchor" name="overview_kernel">
+Simulation kernel layer</a></h3>
+The core functionnalities to simulate a virtual platform are provided by a module called <b><a class="el" href="doc/group__SURF__API.html">SURF</a></b> ("that\'s historical, my friend"). It is very low-level and is not intended to be used as such by end-users. Instead, it serve as a basis for the higher level layer.<p>
+SURF main features are a fast max-min linear solver and the ability to change transparently the model used to describe the platform. This greatly eases the comparison of the several models existing in the litterature.<p>
+See the <a class="el" href="doc/group__SURF__API.html">SURF</a> section for more details.<h3><a class="anchor" name="overview_envs">
+Programmation environments layer</a></h3>
+This simulation kernel is used to build several programmation environments. Each of them target a specific audiance and constitute a different paradigm. To choose which of them you want to use, you have to think about what you want to do and what would be the result of your work.<p>
+<li>If you want to study a theoritical problem and compare several heuristics, you probably want to try <b><a class="el" href="doc/group__MSG__API.html">MSG</a></b> (yet another historical name). It was designed exactly to that extend and should allow you to build easily rather realistic multi-agents simulation. Yet, realism is not the main goal of this environment and the most annoying technical issues of real platforms are masked here. Check the <a class="el" href="doc/group__MSG__API.html">MSG</a> section for more information.</li></ul>
+<li>If you want to study the behaviour of a MPI application using emulation technics, you should have a look at the <b><a class="el" href="doc/group__SMPI__API.html">SMPI</a></b> (Simulated MPI) programming environment. Unfortunately, this work is still underway. Check the <a class="el" href="doc/group__SMPI__API.html">SMPI</a> section for more information.</li></ul>
+<li>If you want to develop a real distributed application, then you may find <b><a class="el" href="doc/group__GRAS__API.html">GRAS</a></b> (Grid Reality And Simulation) useful. This is an API for the realization of distributed applications. <br>
+ Moreover, there is two implementations of this API: one on top of the SURF (allowing to develop and test your application within the comfort of the simulator) and another suited for deployment on real platforms (allowing the resulting application to be highly portable and extremely efficient). <br>
+ Even if you do not plan to run your code for real, you may want to switch to GRAS if you intend to use MSG in a very intensive way (e.g. for simulating a peer-to-peer environment). <br>
+ See the <a class="el" href="doc/group__GRAS__API.html">GRAS</a> section for more details.</li></ul>
+If your favorite programming environment/model is not there (BSP, components, etc.) is not represented in the SimGrid toolkit yet, you may consider adding it. You should contact us first on the <a href="doc/http://lists.gforge.inria.fr/mailman/listinfo/simgrid-devel>">SimGrid developers mailing list</a>, though.<p>
+Any question, remark or suggestion are welcome on the <a href="doc/http://lists.gforge.inria.fr/mailman/listinfo/simgrid-user>">SimGrid users mailing list</a>.<p>
+open FILE,$inputphp;
+open OUTPUT,"> $output";
+while($line=<FILE>) {
+    chomp $line;
+    if($line =~/______ONGLETS______/) {
+       $line =~ s/______ONGLETS______/$onglets/g;
+    } elsif($line =~/______BODY______/) {
+       $line =~ s/______BODY______/$body/g;
+    }
+    print OUTPUT "$line\n";
index a4dba12..3a74f0d 100755 (executable)
@@ -1,6 +1,6 @@
 #!/usr/bin/perl -w
-($#ARGV >= 1) or die "Usage: index_create.pl <input-tag-file> <output-doc-file>";
+($#ARGV >= 1) or die "Usage: toc_create.pl <input-tag-file> <output-doc-file>";