Updated github pages.

- fixed various markdown syntax. - fixed relative path to images. - update text to mention EiffelWeb, and updated version.
2016-05-31 16:54:04 +02:00
parent 3938d4422d
commit bae84f1e29
8 changed files with 25 additions and 21 deletions
--- a/README.md
+++ b/README.md
@@ -1,12 +1,12 @@
-# Eiffel Web Framework
+# EiffelWeb

-Eiffel Web Framework is a framework to build web applications in Eiffel.
+EiffelWeb is a framework to build web applications in Eiffel.

 To get started, check out [http://eiffelwebframework.github.io/EWF](http://eiffelwebframework.github.io/EWF)!

 ## Documentation

-Eiffel Web Framework's documentation, included in this repo in the root directory, is built with [Jekyll](http://jekyllrb.com) and publicly hosted on GitHub Pages at [http://eiffelwebframework.github.io/EWF](http://eiffelwebframework.github.io/EWF). The docs may also be run locally.
+EiffelWeb 's documentation, included in this repo in the root directory, is built with [Jekyll](http://jekyllrb.com) and publicly hosted on GitHub Pages at [http://eiffelwebframework.github.io/EWF](http://eiffelwebframework.github.io/EWF). The docs may also be run locally.

 ### Running documentation locally

--- a/_config.yml
+++ b/_config.yml
@@ -1,6 +1,6 @@
 # Dependencies
 markdown:         kramdown
-highlighter:      pygments
+highlighter:      rouge

 # Permalinks
 permalink:        pretty
@@ -12,4 +12,5 @@ port:             9000

 # Custom vars
 repo:             https://github.com/EiffelWebFramework/EWF
+version:          v1.0.3
 download:         https://github.com/EiffelWebFramework/EWF/archive/v1.0.3.zip
--- a/_layouts/default.html
+++ b/_layouts/default.html
@@ -3,10 +3,10 @@
  <head>
    <meta charset="utf-8">
    <title>
-      {% if page.title == "Eiffel Web Framework" %}
+      {% if page.title == "EiffelWeb" %}
      {{ page.title }}
      {% else if %}
-      {{ page.title }} &middot; Eiffel Web Framework
+      {{ page.title }} &middot; EiffelWeb
      {% endif %}
    </title>
    <meta name="viewport" content="width=device-width, initial-scale=1.0">
@@ -18,7 +18,7 @@
    <div class="container-narrow">
      <div class="masthead">
        <ul class="nav nav-pills pull-right">
-          <li{% if page.title == "Eiffel Web Framework" %} class="active"{% endif %}>
+          <li{% if page.title == "EiffelWeb" %} class="active"{% endif %}>
            <a href="{{ page.base_url }}index.html">Home</a>
          </li>
          <li{% if page.title == "Getting Started" %} class="active"{% endif %}>
@@ -34,13 +34,13 @@
            <a href="{{ page.base_url }}wiki">(Old-Wiki)</a>
          </li>
        </ul>
-        <h3 class="muted">Eiffel Web Framework</h3>
+        <h3 class="muted">EiffelWeb</h3>
      </div>
      <hr>
    {{ content }}
      <hr>
      <div class="footer">
-        <p>&copy; EiffelWebFramework 2012-2016</p>
+        <p>&copy; EiffelWeb framework 2012-2016</p>
      </div>
    </div> <!-- /container -->
    <script src="{{ page.base_url }}js/vendor/jquery.min.js"></script>
--- a/getting-started.html
+++ b/getting-started.html
@@ -12,8 +12,8 @@ base_url: "../"
          We will first see how to install EWF and then how to compile and run the venerable <i>Hello World</i> example.</p>
          <h2>Installation</h2>
          <h3>EiffelStudio</h3>
-          <p>EiffelStudio 14.05 comes with EWF version 0.4: there is nothing to do in this case.</p>
-          <p>If you are using an older version of EiffelStudio, we recommand to download the latest EWF version (0.4 as of this writing) instead of using the one that comes with EiffelStudio.</p>
+          <p>Latest EiffelStudio release comes with latest EWF version: there is nothing to do in this case.</p>
+          <p>If you are using an older version of EiffelStudio, we recommand to download the latest EWF version ({{ site.version }} as of this writing) instead of using the one that comes with EiffelStudio.</p>
          <h3>Download</h3>
          <p>Follow these steps to download and install EWF on your computer:</p>
          <ol>
@@ -39,7 +39,7 @@ base_url: "../"
              <li>located in <i>$ISE_EIFFEL/contrib/examples/web/ewf</i></li>
              <li><a href="https://github.com/EiffelWebFramework/ewf_examples">available on Github</a></li>
            </ul>
-            <li>Read the <a href="{{ page.base_url }}doc/workbook">Overview</a></li>
+            <li>Read the <a href="{{ page.base_url }}workbook/workbook">Overview</a></li>
          </ul>
        </div>
      </div>
--- a/index.html
+++ b/index.html
@@ -1,10 +1,10 @@
 ---
 layout: default
-title: Eiffel Web Framework
+title: EiffelWeb framework
 base_url: "./"
 ---
      <div class="jumbotron">
-        <h1>Eiffel Web Framework</h1>
+        <h1>EiffelWeb</h1>
        <p class="lead">
        Framework to build web applications in Eiffel
        </p>
--- a/workbook/basics/basics.md
+++ b/workbook/basics/basics.md
@@ -97,11 +97,11 @@ The **WSF_RESPONSE** provides features to define the response with information s

 **APPLICATION** is the root class of our example, it launches the application, using the corresponding connector, Which connector? this depends how you want to run it cgi, fcgi,nino or standalone. For development is recommended to use a standalone web server written in Eiffel, and run the execution within the EiffelStudio debugger. For production fcgi (or cgi) using Apache or another popular web server.

-![Launcher Hierarchy](Launcher Hierarchy.png "Launcher Hierarchy")
+![Launcher Hierarchy](../Launcher Hierarchy.png "Launcher Hierarchy")

 **WS_LAUNCHABLE_SERVICE** inherit from **WS_SERVICE** class, which is a marker interface in EWF. And also provides a way to launch our application using different kind of connectors.  The class **WSF_DEFAULT_SERVICE_I**, inherit from **WS_LAUNCHABLE_SERVICE**  and has a formal generic that should conform to **WSF_SERVICE_LAUNCHER [WSF_EXECUTION]**. Below a [BON diagram](http://www.bon-method.com/index_normal.htm) showing one of the possible options.

-![Standalone Launcher](WSF_SERVICE_LAUNCHER_STANDALONE.png "Standalone Hierarchy")
+![Standalone Launcher](../WSF_SERVICE_LAUNCHER_STANDALONE.png "Standalone Hierarchy")
 Other connectors:

 **WSF_STANDALONE_SERVICE_LAUNCHER**
@@ -115,7 +115,7 @@ The **APPLICATION_EXECUTION** class inherits from **WSF_EXECUTION** interface,

 In the **APPLICATION_EXECUTION** class class you will need to implement implement the **execute** feature, get data from the request *req* and write the response in *res*.

-![Execution Hierarchy](APPLICATION_EXECUTION.png "Application Execution ")
+![Execution Hierarchy](../APPLICATION_EXECUTION.png "Application Execution ")

 The WSF_EXECUTION instance, in this case ```APPLICATION_EXECUTION``` is created per request, with two main attributes request: ```WSF_REQUEST``` and response: ```WSF_RESPONSE```.

--- a/workbook/deployment/readme.md
+++ b/workbook/deployment/readme.md
@@ -133,10 +133,13 @@ Copy the app.exe and the folder "www"  into a folder served by apache2, for exam

 >NOTE: By default Apache does not come with fcgid module, so you will need to download it, and put the module under Apache2/modules

-#.htaccess FCGI
->http://perishablepress.com/stupid-htaccess-tricks/
+# .htaccess FCGI

-####.htaccess
+```
+http://perishablepress.com/stupid-htaccess-tricks/
+```
+
+#### .htaccess

    Options +ExecCGI +Includes +FollowSymLinks -Indexes
    
--- a/workbook/handling_request/headers.md
+++ b/workbook/handling_request/headers.md
@@ -452,7 +452,7 @@ As an exercise, try to write a similar service to retrieve the OS family using t
 	* [SERVER_SOFTWARE](https://tools.ietf.org/html/rfc3875#section-4.1.16)

 **Example**
-An [EWF service](../cgi_variables/application.e) that shows the CGI variables, creates a table showing the values of all the CGI variables.
+An [EWF service](../headers/cgi_variables/application.e) that shows the CGI variables, creates a table showing the values of all the CGI variables.


 Nav: [Workbook](../../workbook) :: [Handling Requests: Form/Query parameters](../form) :: [Generating Responses](../../generating_response/generating_response)