updated html for wiki pages
This commit is contained in:
@@ -9,4 +9,5 @@ base_url: "./"
|
||||
Framework to build web applications in Eiffel
|
||||
</p>
|
||||
<a class="btn btn-default btn-lg btn-primary" href="{{ site.download }}">Download</a>
|
||||
<a class="btn btn-default btn-lg btn-primary" href="{{ site.repo }}">Contribute</a>
|
||||
</div>
|
||||
|
||||
54
wiki.html
54
wiki.html
@@ -4,28 +4,40 @@ title: Wiki
|
||||
base_url: ../
|
||||
---
|
||||
<ul>
|
||||
<li><a href="Projects">Projects</a></li>
|
||||
<li><a href="EWSGI-specification---difference-in-main-proposals">EWSGI specification difference in main proposals</a></li>
|
||||
<li><a href="Using-the-policy-driven-framework">Using the policy driven framework</a></li>
|
||||
<li><a href="HTTP-client-library">HTTP client library</a></li>
|
||||
<li><a href="Home">Home</a></li>
|
||||
<li><a href="Meetings">Meetings</a></li>
|
||||
<li><a href="Useful-links">Useful links</a></li>
|
||||
<li><a href="Tasks-Roadmap">Tasks Roadmap</a></li>
|
||||
<li><a href="server_architecture">server architecture</a></li>
|
||||
<li><a href="Web-meeting-2012-09-18">Web meeting 2012 09 18</a></li>
|
||||
<li><a href="Source-structure">Source structure</a></li>
|
||||
<li><a href="Projects-new-suggestions">Projects new suggestions</a></li>
|
||||
<li><a href="EWSGI">EWSGI</a></li>
|
||||
<li><a href="EWSGI-Open-Questions">EWSGI Open Questions</a></li>
|
||||
<li><a href="Wsf-previous-policy">Wsf previous policy</a></li>
|
||||
<li><a href="Libraries">Libraries</a></li>
|
||||
<li><a href="Wsf-caching-policy">Wsf caching policy</a></li>
|
||||
<li><a href="Spec-server-architecture">Spec server architecture</a></li>
|
||||
<li><a href="Library-conneg">Library conneg</a></li>
|
||||
<li><a href="Task-json">Task json</a></li>
|
||||
<li><a href="Community-collaboration">Community collaboration</a></li>
|
||||
<li><a href="WSF_OPTIONS_POLICY">WSF OPTIONS POLICY</a></li>
|
||||
<li><a href="Connectors">Connectors</a></li>
|
||||
<li><a href="Documentation-_Router">Documentation Router</a></li>
|
||||
<li><a href="Documentation">Documentation</a></li>
|
||||
<li><a href="Documentation__Connector">Documentation Connector</a></li>
|
||||
<li><a href="Documentation__Request">Documentation Request</a></li>
|
||||
<li><a href="Documentation__Response">Documentation Response</a></li>
|
||||
<li><a href="Documentation__Router">Documentation Router</a></li>
|
||||
<li><a href="Documentation__Service">Documentation Service</a></li>
|
||||
<li><a href="EWSGI-Open-Questions">EWSGI Open Questions</a></li>
|
||||
<li><a href="EWSGI-specification---difference-in-main-proposals">EWSGI specification difference in main proposals</a></li>
|
||||
<li><a href="EWSGI-specification">EWSGI specification</a></li>
|
||||
<li><a href="EWSGI">EWSGI</a></li>
|
||||
<li><a href="Filter">Filter</a></li>
|
||||
<li><a href="Home">Home</a></li>
|
||||
<li><a href="HTTP-client-library">HTTP client library</a></li>
|
||||
<li><a href="Libraries">Libraries</a></li>
|
||||
<li><a href="Library-conneg">Library conneg</a></li>
|
||||
<li><a href="Meetings">Meetings</a></li>
|
||||
<li><a href="Projects-new-suggestions">Projects new suggestions</a></li>
|
||||
<li><a href="Projects">Projects</a></li>
|
||||
<li><a href="Request-and-response">Request and response</a></li>
|
||||
<li><a href="roadmap">roadmap</a></li>
|
||||
<li><a href="Router">Router</a></li>
|
||||
<li><a href="server_architecture">server architecture</a></li>
|
||||
<li><a href="Source-structure">Source structure</a></li>
|
||||
<li><a href="Spec-server-architecture">Spec server architecture</a></li>
|
||||
<li><a href="Task-json">Task json</a></li>
|
||||
<li><a href="Tasks-Roadmap">Tasks Roadmap</a></li>
|
||||
<li><a href="Useful-links">Useful links</a></li>
|
||||
<li><a href="Using-the-policy-driven-framework">Using the policy driven framework</a></li>
|
||||
<li><a href="Web-meeting-2012-09-18">Web meeting 2012 09 18</a></li>
|
||||
<li><a href="Writing-the-handlers">Writing the handlers</a></li>
|
||||
<li><a href="Wsf-caching-policy">Wsf caching policy</a></li>
|
||||
<li><a href="Wsf-previous-policy">Wsf previous policy</a></li>
|
||||
<li><a href="WSF_OPTIONS_POLICY">WSF OPTIONS POLICY</a></li>
|
||||
</ul>
|
||||
@@ -1,3 +1,8 @@
|
||||
---
|
||||
layout: default
|
||||
title: Community collaboration
|
||||
base_url: ../../
|
||||
---
|
||||
This project is a community project
|
||||
|
||||
## Mailing list ##
|
||||
|
||||
@@ -1,3 +1,8 @@
|
||||
---
|
||||
layout: default
|
||||
title: Connectors
|
||||
base_url: ../../
|
||||
---
|
||||
The main goal of the connectors is to let you choose a target at compile time.
|
||||
This allows you to concentrate on your business during development time and then decide which target you choose at deployment time.
|
||||
The current connectors are:
|
||||
|
||||
@@ -1 +1,6 @@
|
||||
---
|
||||
layout: default
|
||||
title: Documentation Router
|
||||
base_url: ../../
|
||||
---
|
||||
See WSF_ROUTER
|
||||
@@ -1,3 +1,8 @@
|
||||
---
|
||||
layout: default
|
||||
title: Documentation
|
||||
base_url: ../../
|
||||
---
|
||||
# Current Status
|
||||
* Official repository: <https://github.com/EiffelWebFramework/EWF>
|
||||
* Official website: <http://eiffelwebframework.github.io/EWF/getting-started/>
|
||||
|
||||
@@ -1 +1,6 @@
|
||||
---
|
||||
layout: default
|
||||
title: Documentation Connector
|
||||
base_url: ../../
|
||||
---
|
||||
See WSF_CONNECTOR
|
||||
@@ -1 +1,6 @@
|
||||
---
|
||||
layout: default
|
||||
title: Documentation Request
|
||||
base_url: ../../
|
||||
---
|
||||
See WSF_REQUEST
|
||||
@@ -1 +1,6 @@
|
||||
---
|
||||
layout: default
|
||||
title: Documentation Response
|
||||
base_url: ../../
|
||||
---
|
||||
See WSF_RESPONSE
|
||||
@@ -1 +1,6 @@
|
||||
---
|
||||
layout: default
|
||||
title: Documentation Router
|
||||
base_url: ../../
|
||||
---
|
||||
See WSF_ROUTER
|
||||
@@ -1,2 +1,7 @@
|
||||
---
|
||||
layout: default
|
||||
title: Documentation Service
|
||||
base_url: ../../
|
||||
---
|
||||
EWF Services
|
||||
> See WSF\_SERVICE
|
||||
@@ -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.
|
||||
|
||||
@@ -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.
|
||||
|
||||
@@ -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
|
||||
|
||||
@@ -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
|
||||
|
||||
----
|
||||
|
||||
@@ -1,3 +1,8 @@
|
||||
---
|
||||
layout: default
|
||||
title: Filter
|
||||
base_url: ../../
|
||||
---
|
||||
# Introduction
|
||||
|
||||
The basic idea of a filter is to pre-process incoming data and post-process outgoing data.
|
||||
|
||||
@@ -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)
|
||||
|
||||
|
||||
23
wiki/Home.md
23
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) 
|
||||
- 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 ##
|
||||
- [Documentation](./Documentation)
|
||||
- [Documentation](../Documentation)
|
||||
|
||||
## 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)
|
||||
@@ -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/)
|
||||
|
||||
@@ -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:
|
||||
|
||||
@@ -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)
|
||||
|
||||
@@ -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
|
||||
|
||||
----
|
||||
|
||||
@@ -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.
|
||||
Use the following page [Projects new suggestions](../Projects new suggestions) to suggest new project, or request a feature.
|
||||
@@ -1,3 +1,8 @@
|
||||
---
|
||||
layout: default
|
||||
title: Request and response
|
||||
base_url: ../../
|
||||
---
|
||||
# Request
|
||||
The class _WSF_REQUEST_ can be used to access data related to the HTTP request.
|
||||
|
||||
|
||||
@@ -1,3 +1,8 @@
|
||||
---
|
||||
layout: default
|
||||
title: Router
|
||||
base_url: ../../
|
||||
---
|
||||
The primary goal of the router (class _WSF_ROUTER_) is to dispatch requests according to the request URI.
|
||||
|
||||
**TODO**: describe the router interface
|
||||
@@ -1,3 +1,8 @@
|
||||
---
|
||||
layout: default
|
||||
title: Source structure
|
||||
base_url: ../../
|
||||
---
|
||||
## Currently ##
|
||||
|
||||
- LICENSE : file containing the global license
|
||||
|
||||
@@ -1,3 +1,8 @@
|
||||
---
|
||||
layout: default
|
||||
title: Spec server architecture
|
||||
base_url: ../../
|
||||
---
|
||||
## Diagram: Overview of the server architecture ##
|
||||
|
||||
|
||||
@@ -1,3 +1,8 @@
|
||||
---
|
||||
layout: default
|
||||
title: Task json
|
||||
base_url: ../../
|
||||
---
|
||||
## Goal ##
|
||||
- Make this JSON library the default one for the community
|
||||
|
||||
|
||||
@@ -1,4 +1,9 @@
|
||||
Check new roadmap wiki page: [roadmap](./roadmap)
|
||||
---
|
||||
layout: default
|
||||
title: Tasks Roadmap
|
||||
base_url: ../../
|
||||
---
|
||||
Check new roadmap wiki page: [roadmap](../roadmap)
|
||||
## Future
|
||||
* Focus on REST API
|
||||
- Hypermedia API
|
||||
@@ -32,5 +37,5 @@ Check new roadmap wiki page: [roadmap](./roadmap)
|
||||
* Installation scripts
|
||||
|
||||
## Contributors ##
|
||||
- See [the collaboration page](./Community-collaboration)
|
||||
- See [the collaboration page](../Community-collaboration)
|
||||
|
||||
|
||||
@@ -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)
|
||||
|
||||
@@ -1,3 +1,8 @@
|
||||
---
|
||||
layout: default
|
||||
title: Using the policy driven framework
|
||||
base_url: ../../
|
||||
---
|
||||
# Using the policy driven framework
|
||||
|
||||
## Introduction
|
||||
@@ -23,4 +28,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)
|
||||
Next you have to [write your handler(s)](../Writing-the-handlers)
|
||||
@@ -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.
|
||||
@@ -1,3 +1,8 @@
|
||||
---
|
||||
layout: default
|
||||
title: Web meeting 2012 09 18
|
||||
base_url: ../../
|
||||
---
|
||||
## Participants
|
||||
|
||||
* Jocelyn Fiat
|
||||
|
||||
@@ -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)
|
||||
* [WSF_OPTIONS_POLICY](../WSF_OPTIONS_POLICY)
|
||||
* [WSF_PREVIOUS_POLICY](../Wsf-previous-policy)
|
||||
* [WSF_CACHING_POLICY](../Wsf-caching-policy)
|
||||
@@ -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.
|
||||
|
||||
@@ -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.
|
||||
|
||||
@@ -1,4 +1,9 @@
|
||||
---
|
||||
layout: default
|
||||
title: roadmap
|
||||
base_url: ../../
|
||||
---
|
||||
# Upcoming versions
|
||||
|
||||
# Current state: oct-2013
|
||||
- check previous wiki page: [Tasks roadmap](./Tasks roadmap)
|
||||
- check previous wiki page: [Tasks roadmap](../Tasks roadmap)
|
||||
Binary file not shown.
|
Before Width: | Height: | Size: 88 KiB After Width: | Height: | Size: 79 B |
Reference in New Issue
Block a user