Update doc structure, and fixed a few links.
This commit is contained in:
@@ -1,4 +1,4 @@
|
|||||||
Menu :: [[Doc_Getting_Started.mediawiki|Getting Started]] :: [[Community-collaboration.md|Community]]
|
Menu :: [[Doc_Getting_Started.mediawiki|Getting Started]] :: [[community.md|Community]]
|
||||||
|
|
||||||
= Eiffel Web Framework =
|
= Eiffel Web Framework =
|
||||||
Framework to build web applications in Eiffel
|
Framework to build web applications in Eiffel
|
||||||
|
|||||||
@@ -1 +0,0 @@
|
|||||||
See WSF_ROUTER
|
|
||||||
@@ -1 +0,0 @@
|
|||||||
See WSF_CONNECTOR
|
|
||||||
@@ -1 +0,0 @@
|
|||||||
See WSF_ROUTER
|
|
||||||
@@ -6,19 +6,19 @@ The official documentation/wiki is located at [https://github.com/EiffelWebFrame
|
|||||||
## Organization ##
|
## 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) 
|
- 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).
|
- 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](Meetings.md) that occurs usually during other Eiffel related events.
|
- For time to time we have [web meetings](project/Meetings.md), and less frequently [physical meetings](project/Meetings.md) that occurs usually during other Eiffel related events.
|
||||||
|
|
||||||
## Documentation ##
|
## Documentation ##
|
||||||
- [Documentation](./Documentation)
|
- [Documentation](documentation/index.md)
|
||||||
|
|
||||||
## Contributions ##
|
## Contributions ##
|
||||||
- You want to contribute or follow the progress/discussion, see the [collaboration page](Community-collaboration.md)
|
- You want to contribute or follow the progress/discussion, see the [collaboration page](community.md)
|
||||||
- Potential tasks/projects on EWF: [Projects page](Projects.md)
|
- Potential tasks/projects on EWF: [Projects page](project/Projects.md)
|
||||||
|
|
||||||
## See also ##
|
## See also ##
|
||||||
- [list of tasks, and a potential roadmap](Tasks-Roadmap.md)
|
- [list of tasks, and a potential roadmap](project/Tasks-Roadmap.md)
|
||||||
- [General source structure of this project](Source-structure.md)
|
- [General source structure of this project](Source-structure.md)
|
||||||
- EWSGI: [Eiffel Web Server Gateway Interface](EWSGI.md)
|
- EWSGI: [Eiffel Web Server Gateway Interface](EWSGI/index.md)
|
||||||
- [Overview of the server side architecture](Spec-Server-Architecture.md)
|
- [Overview of the server side architecture](Spec-Server-Architecture.md)
|
||||||
- This project is also a collection of [Libraries](Libraries.md) related to the Web
|
- This project is also a collection of [Libraries](Libraries.md) related to the Web
|
||||||
|
|
||||||
|
|||||||
@@ -46,3 +46,6 @@ It's fairly easy to write your own connector. Just inherit from these classes:
|
|||||||
* WGI_INPUT_STREAM
|
* WGI_INPUT_STREAM
|
||||||
* WGI_OUTPUT_STREAM
|
* WGI_OUTPUT_STREAM
|
||||||
* WSF_SERVICE_LAUNCHER
|
* WSF_SERVICE_LAUNCHER
|
||||||
|
|
||||||
|
|
||||||
|
See WSF_CONNECTOR
|
||||||
@@ -1,3 +1,6 @@
|
|||||||
The primary goal of the router (class _WSF_ROUTER_) is to dispatch requests according to the request URI.
|
The primary goal of the router (class _WSF_ROUTER_) is to dispatch requests according to the request URI.
|
||||||
|
|
||||||
**TODO**: describe the router interface
|
See WSF_ROUTER
|
||||||
|
|
||||||
|
**TODO**: describe the router interface
|
||||||
|
|
||||||
@@ -27,7 +27,7 @@ This is the low level of the framework, at this point, `req` provides access to
|
|||||||
The response `res` is the interface to send data back to the client.
|
The response `res` is the interface to send data back to the client.
|
||||||
For convenience, the framework provides richer service interface that handles the most common needs (filter, router, ...).
|
For convenience, the framework provides richer service interface that handles the most common needs (filter, router, ...).
|
||||||
|
|
||||||
> [Learn more about service](Documentation__Service.md)
|
> [Learn more about service](Service.md)
|
||||||
|
|
||||||
<a name="wiki-request"></a><a name="wiki-response"></a><a name="wiki-request-and-response"></a>
|
<a name="wiki-request"></a><a name="wiki-response"></a><a name="wiki-request-and-response"></a>
|
||||||
<a name="request"></a><a name="response"></a><a name="request-and-response"></a>
|
<a name="request"></a><a name="response"></a><a name="request-and-response"></a>
|
||||||
@@ -50,7 +50,7 @@ Any incoming http request is represented by an new object of type **WSF_REQUEST*
|
|||||||
|
|
||||||
The **WSF_RESPONSE** represents the communication toward the client, a service need to provide correct headers, and content. For instance the `Content-Type`, and `Content-Length`. It also allows to send data with chunked encoding.
|
The **WSF_RESPONSE** represents the communication toward the client, a service need to provide correct headers, and content. For instance the `Content-Type`, and `Content-Length`. It also allows to send data with chunked encoding.
|
||||||
|
|
||||||
> [Learn more about request](Documentation__Request.md) and [about response](Documentation__Response.md)
|
> [Learn more about request](Request.md) and [about response](Response.md)
|
||||||
|
|
||||||
<a name="wiki-connector"></a>
|
<a name="wiki-connector"></a>
|
||||||
<a name="connector"></a>
|
<a name="connector"></a>
|
||||||
@@ -66,7 +66,7 @@ Currently 3 main connectors are available:
|
|||||||
At compilation time, you can use a default connector (by using the associated default lib), but you can also use a mixed of them and choose which one to execute at runtime.
|
At compilation time, you can use a default connector (by using the associated default lib), but you can also use a mixed of them and choose which one to execute at runtime.
|
||||||
It is fairly easy to add new connector, it just has to follow the EWSGI interface
|
It is fairly easy to add new connector, it just has to follow the EWSGI interface
|
||||||
|
|
||||||
> [Learn more about connector](Documentation__Connector.md)
|
> [Learn more about connector](Connector.md)
|
||||||
|
|
||||||
<a name="wiki-router"></a>
|
<a name="wiki-router"></a>
|
||||||
<a name="router"></a>
|
<a name="router"></a>
|
||||||
@@ -113,7 +113,7 @@ How we do that in EWF? : Router with (or without context).
|
|||||||
Related code: wsf_router, wsf_router_context
|
Related code: wsf_router, wsf_router_context
|
||||||
Examples
|
Examples
|
||||||
|
|
||||||
> [Learn more about router](Documentation__Router.md)
|
> [Learn more about router](Router.md)
|
||||||
|
|
||||||
# EWF components
|
# EWF components
|
||||||
## URI Handler:
|
## URI Handler:
|
||||||
@@ -180,21 +180,22 @@ examples
|
|||||||
External libraries are included, such as Cypress OAuth (Security), HTML parsing library, Template Engine Smarty.
|
External libraries are included, such as Cypress OAuth (Security), HTML parsing library, Template Engine Smarty.
|
||||||
|
|
||||||
## server
|
## server
|
||||||
* __ewsgi__: Eiffel Web Server Gateway Interface [read more](EWSGI.md).
|
* __ewsgi__: Eiffel Web Server Gateway Interface [read more](../EWSGI/index.md).
|
||||||
* connectors: various web server connectors for EWSGI
|
* connectors: various web server connectors for EWSGI
|
||||||
* __libfcgi__: Wrapper for libfcgi SDK
|
* __libfcgi__: Wrapper for libfcgi SDK
|
||||||
* __wsf__: Web Server Framework
|
* __wsf__: Web Server Framework
|
||||||
* __router__: URL dispatching/routing based on uri, uri_template, or custom [read more](Documentation__Router.md).
|
* __router__: URL dispatching/routing based on uri, uri_template, or custom [read more](Router.md).
|
||||||
|
* __filter__: Filter chain [read more](Filter.md).
|
||||||
* __wsf_html__: (html and css) Content generator from the server side.
|
* __wsf_html__: (html and css) Content generator from the server side.
|
||||||
* CMS example: <https://github.com/EiffelWebFramework/cms/tree/master/example>
|
* CMS example: <https://github.com/EiffelWebFramework/cms/tree/master/example>
|
||||||
|
|
||||||
## protocol
|
## protocol
|
||||||
* __http__: HTTP related classes, constants for status code, content types, ...
|
* __http__: HTTP related classes, constants for status code, content types, ...
|
||||||
* __uri_template__: URI Template library (parsing and expander)
|
* __uri_template__: URI Template library (parsing and expander)
|
||||||
* __content_negotiation__: CONNEG library (Content-type Negociation)
|
* __content_negotiation__: [CONNEG](Library-conneg.md) library (Content-type Negociation)
|
||||||
|
|
||||||
## Client
|
## Client
|
||||||
* __http_client__: simple HTTP client based on cURL
|
* __http_client__: simple [HTTP client](HTTP-client.library.md) based on cURL
|
||||||
* __Firebase API__: <https://github.com/EiffelWebFramework/Redwood>
|
* __Firebase API__: <https://github.com/EiffelWebFramework/Redwood>
|
||||||
|
|
||||||
## Text
|
## Text
|
||||||
@@ -1,4 +1,4 @@
|
|||||||
# Previous and future meetings
|
# Previous and future meetings
|
||||||
|
|
||||||
* [Web-meeting: 2012-09-18](./Web-meeting-2012-09-18)
|
* [Web-meeting: 2012-09-18](meetings/Web-meeting-2012-09-18.md)
|
||||||
* 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)
|
* 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,4 +1,4 @@
|
|||||||
Check new roadmap wiki page: [roadmap](./roadmap)
|
Check new roadmap wiki page: [roadmap](roadmap.md)
|
||||||
## Future
|
## Future
|
||||||
* Focus on REST API
|
* Focus on REST API
|
||||||
- Hypermedia API
|
- Hypermedia API
|
||||||
@@ -32,5 +32,5 @@ Check new roadmap wiki page: [roadmap](./roadmap)
|
|||||||
* Installation scripts
|
* Installation scripts
|
||||||
|
|
||||||
## Contributors ##
|
## Contributors ##
|
||||||
- See [the collaboration page](./Community-collaboration)
|
- See [the collaboration page](../community.md)
|
||||||
|
|
||||||
Reference in New Issue
Block a user