From 5912587f686deaaa5d12cb4d1383d30888d50801 Mon Sep 17 00:00:00 2001 From: Olivier Ligot Date: Fri, 23 Aug 2013 15:43:25 +0200 Subject: [PATCH] Added wiki pages (#27) --- _config.yml | 2 +- _layouts/default.html | 9 +++-- community.html | 1 - getting-started.html | 1 - index.html | 1 - wiki.html | 31 +++++++++++++++++ wiki.py | 32 ++++++++++++++++++ wiki/Community-collaboration.md | 5 +++ wiki/EWSGI-Open-Questions.md | 5 +++ ...fication---difference-in-main-proposals.md | 5 +++ wiki/EWSGI-specification.md | 5 +++ wiki/EWSGI.md | 9 +++-- wiki/HTTP-client-library.md | 5 +++ wiki/Home.md | 21 +++++++----- wiki/Libraries.md | 5 +++ wiki/Library-conneg.md | 5 +++ wiki/Meetings.md | 7 +++- wiki/Projects-new-suggestions.md | 7 +++- wiki/Projects.md | 7 +++- wiki/Source-structure.md | 5 +++ wiki/Spec-server-architecture.md | 5 +++ wiki/Task-json.md | 5 +++ wiki/Tasks-Roadmap.md | 7 +++- wiki/Useful-links.md | 5 +++ wiki/Using-the-policy-driven-framework.md | 7 +++- wiki/WSF_OPTIONS_POLICY.md | 5 +++ wiki/Web-meeting-2012-09-18.md | 5 +++ wiki/Writing-the-handlers.md | 11 ++++-- wiki/Wsf-caching-policy.md | 5 +++ wiki/Wsf-previous-policy.md | 5 +++ wiki/server_architecture.png | Bin 89726 -> 89794 bytes 31 files changed, 203 insertions(+), 25 deletions(-) create mode 100644 wiki.html create mode 100755 wiki.py diff --git a/_config.yml b/_config.yml index 01ef4517..4bcc41f0 100644 --- a/_config.yml +++ b/_config.yml @@ -7,7 +7,7 @@ permalink: pretty # Server destination: ./_gh_pages -exclude: [".gitignore", "Gruntfile.js", "package.json", "node_modules", "README.md"] +exclude: [".gitignore", "Gruntfile.js", "package.json", "node_modules", "README.md", "server_architecture.png", "wiki.py"] port: 9000 # Custom vars diff --git a/_layouts/default.html b/_layouts/default.html index adc759d8..c97e8b7b 100644 --- a/_layouts/default.html +++ b/_layouts/default.html @@ -18,15 +18,18 @@

Eiffel Web Framework

diff --git a/community.html b/community.html index 1a0d7ffe..694ba7c6 100644 --- a/community.html +++ b/community.html @@ -1,7 +1,6 @@ --- layout: default title: Community -slug: community base_url: "../" ---
diff --git a/getting-started.html b/getting-started.html index 5f52d348..225c0afc 100644 --- a/getting-started.html +++ b/getting-started.html @@ -1,7 +1,6 @@ --- layout: default title: Getting Started -slug: getting-started base_url: "../" ---
diff --git a/index.html b/index.html index b77f8edf..3732c03d 100644 --- a/index.html +++ b/index.html @@ -1,7 +1,6 @@ --- layout: default title: Eiffel Web Framework -slug: index base_url: "./" ---
diff --git a/wiki.html b/wiki.html new file mode 100644 index 00000000..c95ae471 --- /dev/null +++ b/wiki.html @@ -0,0 +1,31 @@ +--- +layout: default +title: Wiki +base_url: ../ +--- + \ No newline at end of file diff --git a/wiki.py b/wiki.py new file mode 100755 index 00000000..2dad3ab5 --- /dev/null +++ b/wiki.py @@ -0,0 +1,32 @@ +#!/usr/bin/env python +# -*- encoding: utf-8 -*- + +"Update the wiki pages to work with Jekyll" + +import os + +HEADER = """--- +layout: default +title: %s +base_url: %s +--- +""" + +wiki = HEADER % ('Wiki', '../') + '
    \n' +for file in os.listdir('wiki'): + if not file.startswith('.') and not file.endswith('.mediawiki'): + originalname = os.path.splitext(file)[0] + name = " ".join(originalname.replace('-', ' ').replace('_', ' ').split()) + path = os.path.join ('wiki', file) + print 'Processing', path + with open(path, 'r') as f: + content = f.read() + if not content.startswith('---'): + content = (HEADER % (name, '../../') + content) + with open(path, 'w') as f: + f.write(content.replace('(./wiki/', '(../').replace('(./', '(../')) + wiki += '
  • %s
    • \n' % (originalname, name) +wiki += '
' +with open('wiki.html', 'w') as f: + f.write(wiki) +print 'Done' diff --git a/wiki/Community-collaboration.md b/wiki/Community-collaboration.md index 0be32409..136d9663 100644 --- a/wiki/Community-collaboration.md +++ b/wiki/Community-collaboration.md @@ -1,3 +1,8 @@ +--- +layout: default +title: Community collaboration +base_url: ../../ +--- This project is a community project ## Mailing list ## diff --git a/wiki/EWSGI-Open-Questions.md b/wiki/EWSGI-Open-Questions.md index d6958f94..f7e11def 100644 --- a/wiki/EWSGI-Open-Questions.md +++ b/wiki/EWSGI-Open-Questions.md @@ -1,3 +1,8 @@ +--- +layout: default +title: EWSGI Open Questions +base_url: ../../ +--- ## STRING_32, UTF-8, ... ? ## Berend raised the point that using STRING_32 is consuming 4 times the space used for STRING_8. And CPU is cheaper than memory, so we should try to use as less memory as possible. diff --git a/wiki/EWSGI-specification---difference-in-main-proposals.md b/wiki/EWSGI-specification---difference-in-main-proposals.md index 608c79bf..23e225f6 100644 --- a/wiki/EWSGI-specification---difference-in-main-proposals.md +++ b/wiki/EWSGI-specification---difference-in-main-proposals.md @@ -1,3 +1,8 @@ +--- +layout: default +title: EWSGI specification difference in main proposals +base_url: ../../ +--- Currently the **design of the EWSGI** is not going very fast, mainly due to conflicts for the core design. Let's try to summary today's **points of conflict** between Paul's proposal, and Jocelyn's proposal. diff --git a/wiki/EWSGI-specification.md b/wiki/EWSGI-specification.md index 734613f5..1451202b 100644 --- a/wiki/EWSGI-specification.md +++ b/wiki/EWSGI-specification.md @@ -1,3 +1,8 @@ +--- +layout: default +title: EWSGI specification +base_url: ../../ +--- **WARNING** **THIS PAGE IS IN PROGRESS, AS IT IS NOW, IT NEEDS UPDATE SINCE IT DOES NOT REFLECT THE FUTURE INTERFACE** # The Eiffel Web Server Gateway Interface diff --git a/wiki/EWSGI.md b/wiki/EWSGI.md index 42a4fbbc..a75fa5af 100644 --- a/wiki/EWSGI.md +++ b/wiki/EWSGI.md @@ -1,5 +1,10 @@ -- See proposed specifications: [EWSGI specification](./EWSGI-specification) -- See [Open questions](./EWSGI-Open-Questions) +--- +layout: default +title: EWSGI +base_url: ../../ +--- +- See proposed specifications: [EWSGI specification](../EWSGI-specification) +- See [Open questions](../EWSGI-Open-Questions) - And below the various proposals and associated decision ---- diff --git a/wiki/HTTP-client-library.md b/wiki/HTTP-client-library.md index 20a63d4f..be2eccf4 100644 --- a/wiki/HTTP-client-library.md +++ b/wiki/HTTP-client-library.md @@ -1,3 +1,8 @@ +--- +layout: default +title: HTTP client library +base_url: ../../ +--- # HTTP Library Features The following list of features are taken form the book [RESTful Web Services](http://www.amazon.com/Restful-Web-Services-Leonard-Richardson/dp/0596529260/ref=sr_1_1?ie=UTF8&qid=1322155984&sr=8-1) diff --git a/wiki/Home.md b/wiki/Home.md index fdb4420a..ab3bb2ef 100644 --- a/wiki/Home.md +++ b/wiki/Home.md @@ -1,3 +1,8 @@ +--- +layout: default +title: Home +base_url: ../../ +--- # Eiffel-Web-Framework # ## Location ## @@ -6,21 +11,21 @@ The official documentation/wiki is located at [https://github.com/EiffelWebFrame ## Organization ## - Mailing list: please visit and subscribe to the mailing list page [http://groups.google.com/group/eiffel-web-framework](http://groups.google.com/group/eiffel-web-framework) ![logo](http://groups.google.com/intl/en/images/logos/groups_logo_sm.gif) - Most of the topics are discussed on the mailing list (google group). -- For time to time we have [web meetings](./wiki/Meetings), and less frequently [physical meetings](./wiki/Meetings) that occurs usually during other Eiffel related events. +- For time to time we have [web meetings](../Meetings), and less frequently [physical meetings](../Meetings) that occurs usually during other Eiffel related events. ## Documentation ## - to redo ## Contributions ## -- You want to contribute or follow the progress/discussion, see the [collaboration page](./wiki/Community-collaboration) -- Potential tasks/projects on EWF: [Projects page](./wiki/Projects) +- You want to contribute or follow the progress/discussion, see the [collaboration page](../Community-collaboration) +- Potential tasks/projects on EWF: [Projects page](../Projects) ## See also ## - - [list of tasks, and a potential roadmap](./wiki/Tasks-Roadmap) - - [General source structure of this project](./wiki/Source-structure) - - EWSGI: [Eiffel Web Server Gateway Interface](./wiki/EWSGI) - - [Overview of the server side architecture](./wiki/Spec-Server-Architecture) - - This project is also a collection of [Libraries](./wiki/Libraries) related to the Web + - [list of tasks, and a potential roadmap](../Tasks-Roadmap) + - [General source structure of this project](../Source-structure) + - EWSGI: [Eiffel Web Server Gateway Interface](../EWSGI) + - [Overview of the server side architecture](../Spec-Server-Architecture) + - This project is also a collection of [Libraries](../Libraries) related to the Web ## Note ## - This wiki needs to be updated, in the meantime, please have a look at the presentation: [https://docs.google.com/presentation/pub?id=1GPFv6aHhTjFSLMnlAt-J4WeIHSGfHdB42dQxmOVOH8s&start=false&loop=false&delayms=3000](https://docs.google.com/presentation/pub?id=1GPFv6aHhTjFSLMnlAt-J4WeIHSGfHdB42dQxmOVOH8s&start=false&loop=false&delayms=3000) \ No newline at end of file diff --git a/wiki/Libraries.md b/wiki/Libraries.md index d456efcd..87f82913 100644 --- a/wiki/Libraries.md +++ b/wiki/Libraries.md @@ -1,3 +1,8 @@ +--- +layout: default +title: Libraries +base_url: ../../ +--- ## libraries currently part of the Eiffel Web Framework ## * [[Library-EWSGI]]: Eiffel Web Server Gateway Interface (prefix WGI_ for **W**eb**G**ateway**I**nterface) * [[Library-libFCGI]]: Eiffel wrapper of libfcgi SDK (http://www.fastcgi.com/devkit/libfcgi/) diff --git a/wiki/Library-conneg.md b/wiki/Library-conneg.md index 79b9d15f..1e536f13 100644 --- a/wiki/Library-conneg.md +++ b/wiki/Library-conneg.md @@ -1,3 +1,8 @@ +--- +layout: default +title: Library conneg +base_url: ../../ +--- # Server-driven content negotiation EWF supports server-driven content content negotiation, as defined in [HTTP/1.1 Content Negotiation](http://www.w3.org/Protocols/rfc2616/rfc2616-sec12.html#sec12.1) . To enable this facility: diff --git a/wiki/Meetings.md b/wiki/Meetings.md index 05faf598..0f6757d9 100644 --- a/wiki/Meetings.md +++ b/wiki/Meetings.md @@ -1,4 +1,9 @@ +--- +layout: default +title: Meetings +base_url: ../../ +--- # Previous and future meetings -* [Web-meeting: 2012-09-18](./Web-meeting-2012-09-18) +* [Web-meeting: 2012-09-18](../Web-meeting-2012-09-18) * For previous meetings, check the ["meeting" topics](https://groups.google.com/forum/?fromgroups=#!tags/eiffel-web-framework/meeting) on the [forum](http://groups.google.com/group/eiffel-web-framework) diff --git a/wiki/Projects-new-suggestions.md b/wiki/Projects-new-suggestions.md index 8ebc7ea9..d587c583 100644 --- a/wiki/Projects-new-suggestions.md +++ b/wiki/Projects-new-suggestions.md @@ -1,5 +1,10 @@ +--- +layout: default +title: Projects new suggestions +base_url: ../../ +--- Use this to suggest new projects, or request features. -The content of this page will be moved to the main [Projects](./Projects) page for time to time. +The content of this page will be moved to the main [Projects](../Projects) page for time to time. For any entry, please use this template ---- diff --git a/wiki/Projects.md b/wiki/Projects.md index 92bce9d8..f7c56165 100644 --- a/wiki/Projects.md +++ b/wiki/Projects.md @@ -1,3 +1,8 @@ +--- +layout: default +title: Projects +base_url: ../../ +--- This page lists potential projects on EWF, this is open for contribution. If you are a student, don't hesitate to pick one, or even suggest a new project, or a project being a merge of several, in any case, you will get close support from EWF's team. @@ -236,4 +241,4 @@ If you are a student, don't hesitate to pick one, or even suggest a new project, ---- # Feel free to add new idea below this line ---- -Use the following page [Projects new suggestions](./Projects new suggestions) to suggest new project, or request a feature. \ No newline at end of file +Use the following page [Projects new suggestions](../Projects new suggestions) to suggest new project, or request a feature. \ No newline at end of file diff --git a/wiki/Source-structure.md b/wiki/Source-structure.md index 477cd4b1..983077bd 100644 --- a/wiki/Source-structure.md +++ b/wiki/Source-structure.md @@ -1,3 +1,8 @@ +--- +layout: default +title: Source structure +base_url: ../../ +--- ## Currently ## - LICENSE : file containing the global license diff --git a/wiki/Spec-server-architecture.md b/wiki/Spec-server-architecture.md index 2960af9d..501b0dfc 100644 --- a/wiki/Spec-server-architecture.md +++ b/wiki/Spec-server-architecture.md @@ -1,3 +1,8 @@ +--- +layout: default +title: Spec server architecture +base_url: ../../ +--- ## Diagram: Overview of the server architecture ## ![server_architecture.png](server_architecture.png) \ No newline at end of file diff --git a/wiki/Task-json.md b/wiki/Task-json.md index 8b25b368..dc956c20 100644 --- a/wiki/Task-json.md +++ b/wiki/Task-json.md @@ -1,3 +1,8 @@ +--- +layout: default +title: Task json +base_url: ../../ +--- ## Goal ## - Make this JSON library the default one for the community diff --git a/wiki/Tasks-Roadmap.md b/wiki/Tasks-Roadmap.md index 0f0dea34..f6a33c91 100644 --- a/wiki/Tasks-Roadmap.md +++ b/wiki/Tasks-Roadmap.md @@ -1,3 +1,8 @@ +--- +layout: default +title: Tasks Roadmap +base_url: ../../ +--- ## Future * Focus on REST API - Hypermedia API @@ -31,5 +36,5 @@ * Installation scripts ## Contributors ## - - See [the collaboration page](./Community-collaboration) + - See [the collaboration page](../Community-collaboration) diff --git a/wiki/Useful-links.md b/wiki/Useful-links.md index 715ddd2d..94e8b8c3 100644 --- a/wiki/Useful-links.md +++ b/wiki/Useful-links.md @@ -1,3 +1,8 @@ +--- +layout: default +title: Useful links +base_url: ../../ +--- ## Eiffel * [http://www.scoop.it/t/eiffel-resources](http://www.scoop.it/t/eiffel-resources) diff --git a/wiki/Using-the-policy-driven-framework.md b/wiki/Using-the-policy-driven-framework.md index bf85c9ef..90397b79 100644 --- a/wiki/Using-the-policy-driven-framework.md +++ b/wiki/Using-the-policy-driven-framework.md @@ -1,3 +1,8 @@ +--- +layout: default +title: Using the policy driven framework +base_url: ../../ +--- # Using the policy driven framework **This describes a new facility that is not yet in the EWF release** @@ -25,4 +30,4 @@ is_system_options_forbidden. WSF_ROUTED_SKELETON_SERVICE also inherits from WSF_PROXY_USE_POLICY. This determines if the server will require clients to use a proxy server. By default, it will do so for HTTP/1.0 clients. This is a sensible default, as the framework assumes an HTTP/1.1 client throughout. If you are sure that you will only ever have HTTP/1.1 clients, then you can instead inherit from WSF_NO_PROXY_POLICY, as RESTBUCKS_SERVER does. If not, then you need to implement proxy_server. -Next you have to [write your handler(s)](./Writing-the-handlers) \ No newline at end of file +Next you have to [write your handler(s)](../Writing-the-handlers) \ No newline at end of file diff --git a/wiki/WSF_OPTIONS_POLICY.md b/wiki/WSF_OPTIONS_POLICY.md index 2056c430..6082379c 100644 --- a/wiki/WSF_OPTIONS_POLICY.md +++ b/wiki/WSF_OPTIONS_POLICY.md @@ -1,3 +1,8 @@ +--- +layout: default +title: WSF OPTIONS POLICY +base_url: ../../ +--- # Implementing routines in WSF_OPTIONS_POLICY This class provides a default response to OPTIONS requests other than OPTIONS *. So you don't have to do anything. The default response just includes the mandatory Allow headers for all the methods that are allowed for the request URI. if you want to include a body text, or additional header, then you should redefine this routine. \ No newline at end of file diff --git a/wiki/Web-meeting-2012-09-18.md b/wiki/Web-meeting-2012-09-18.md index 50cda2e2..8b967ee4 100644 --- a/wiki/Web-meeting-2012-09-18.md +++ b/wiki/Web-meeting-2012-09-18.md @@ -1,3 +1,8 @@ +--- +layout: default +title: Web meeting 2012 09 18 +base_url: ../../ +--- ## Participants * Jocelyn Fiat diff --git a/wiki/Writing-the-handlers.md b/wiki/Writing-the-handlers.md index 87e68a2c..157a219c 100644 --- a/wiki/Writing-the-handlers.md +++ b/wiki/Writing-the-handlers.md @@ -1,3 +1,8 @@ +--- +layout: default +title: Writing the handlers +base_url: ../../ +--- # Writing the handlers Now you have to implement each handler. You need to inherit from WSF_SKELETON_HANDLER (as ORDER_HANDLER does). This involves implementing a lot of deferred routines. There are other routines for which default implementations are provided, which you might want to override. This applies to both routines defined in this class, and those declared in the three policy classes from which it inherits. @@ -218,6 +223,6 @@ This routine is called for a normal (updating) PUT request. You have to update t ## Implementing the policies -* [WSF_OPTIONS_POLICY](./WSF_OPTIONS_POLICY) -* [WSF_PREVIOUS_POLICY](./Wsf-previous-policy) -* [WSF_CACHING_POLICY](./Wsf-caching-policy) \ No newline at end of file +* [WSF_OPTIONS_POLICY](../WSF_OPTIONS_POLICY) +* [WSF_PREVIOUS_POLICY](../Wsf-previous-policy) +* [WSF_CACHING_POLICY](../Wsf-caching-policy) \ No newline at end of file diff --git a/wiki/Wsf-caching-policy.md b/wiki/Wsf-caching-policy.md index e2c5d6ae..122f7078 100644 --- a/wiki/Wsf-caching-policy.md +++ b/wiki/Wsf-caching-policy.md @@ -1,3 +1,8 @@ +--- +layout: default +title: Wsf caching policy +base_url: ../../ +--- # Implementing WSF_CACHING_POLICY This class contains a large number of routines, some of which have sensible defaults. diff --git a/wiki/Wsf-previous-policy.md b/wiki/Wsf-previous-policy.md index 1ba251d0..ce63a127 100644 --- a/wiki/Wsf-previous-policy.md +++ b/wiki/Wsf-previous-policy.md @@ -1,3 +1,8 @@ +--- +layout: default +title: Wsf previous policy +base_url: ../../ +--- # WSF_PREVIOUS_POLICY This class deals with resources that have moved or gone. The default assumes no such resources. It exists as a separate class, rather than have the routines directly in WSF_SKELETON_HANDLER, as sub-classing it may be convenient for an organisation. diff --git a/wiki/server_architecture.png b/wiki/server_architecture.png index 3128400d777b70d9dd8c13604af1de82d0b0a287..dc6e8cd87dfaa6a81e1718c1a327941db92b6173 100644 GIT binary patch delta 80 zcmeyjhxO22Ru^4eU9OzO%KXw2D}|KQw8YY!60VZWlAKg4h2qqrveY7l#G>Sk%#zgP glG377uB61`)cDe(94iGqJ$)eJ0_ktq!dMpv0I!7`sQ>@~ delta 13 UcmX@Km-XKs)<&1DE{t_?04~1;-v9sr