diff --git a/doc/wiki/Doc_Index.mediawiki b/doc/wiki/Doc_Index.mediawiki index f5e9c3e2..9f195ef9 100644 --- a/doc/wiki/Doc_Index.mediawiki +++ b/doc/wiki/Doc_Index.mediawiki @@ -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 = Framework to build web applications in Eiffel diff --git a/doc/wiki/Documentation-_Router.md b/doc/wiki/Documentation-_Router.md deleted file mode 100644 index 3207e4a6..00000000 --- a/doc/wiki/Documentation-_Router.md +++ /dev/null @@ -1 +0,0 @@ -See WSF_ROUTER \ No newline at end of file diff --git a/doc/wiki/Documentation__Connector.md b/doc/wiki/Documentation__Connector.md deleted file mode 100644 index b76dce29..00000000 --- a/doc/wiki/Documentation__Connector.md +++ /dev/null @@ -1 +0,0 @@ -See WSF_CONNECTOR \ No newline at end of file diff --git a/doc/wiki/Documentation__Router.md b/doc/wiki/Documentation__Router.md deleted file mode 100644 index 3207e4a6..00000000 --- a/doc/wiki/Documentation__Router.md +++ /dev/null @@ -1 +0,0 @@ -See WSF_ROUTER \ No newline at end of file diff --git a/doc/wiki/EWSGI-Open-Questions.md b/doc/wiki/EWSGI/Open-Questions.md similarity index 100% rename from doc/wiki/EWSGI-Open-Questions.md rename to doc/wiki/EWSGI/Open-Questions.md diff --git a/doc/wiki/EWSGI.md b/doc/wiki/EWSGI/index.md similarity index 100% rename from doc/wiki/EWSGI.md rename to doc/wiki/EWSGI/index.md diff --git a/doc/wiki/EWSGI-specification---difference-in-main-proposals.md b/doc/wiki/EWSGI/specification---difference-in-main-proposals.md similarity index 100% rename from doc/wiki/EWSGI-specification---difference-in-main-proposals.md rename to doc/wiki/EWSGI/specification---difference-in-main-proposals.md diff --git a/doc/wiki/EWSGI-specification.md b/doc/wiki/EWSGI/specification.md similarity index 100% rename from doc/wiki/EWSGI-specification.md rename to doc/wiki/EWSGI/specification.md diff --git a/doc/wiki/Home.md b/doc/wiki/Home.md index 1ae8df4b..b238d84b 100644 --- a/doc/wiki/Home.md +++ b/doc/wiki/Home.md @@ -6,19 +6,19 @@ 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](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/index.md) ## Contributions ## -- You want to contribute or follow the progress/discussion, see the [collaboration page](Community-collaboration.md) -- Potential tasks/projects on EWF: [Projects page](Projects.md) +- You want to contribute or follow the progress/discussion, see the [collaboration page](community.md) +- Potential tasks/projects on EWF: [Projects page](project/Projects.md) ## 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) - - 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) - This project is also a collection of [Libraries](Libraries.md) related to the Web diff --git a/doc/wiki/Community-collaboration.md b/doc/wiki/community.md similarity index 100% rename from doc/wiki/Community-collaboration.md rename to doc/wiki/community.md diff --git a/doc/wiki/Connectors.md b/doc/wiki/documentation/Connectors.md similarity index 99% rename from doc/wiki/Connectors.md rename to doc/wiki/documentation/Connectors.md index c3d8f646..6f64aca5 100644 --- a/doc/wiki/Connectors.md +++ b/doc/wiki/documentation/Connectors.md @@ -46,3 +46,6 @@ It's fairly easy to write your own connector. Just inherit from these classes: * WGI_INPUT_STREAM * WGI_OUTPUT_STREAM * WSF_SERVICE_LAUNCHER + + +See WSF_CONNECTOR diff --git a/doc/wiki/Filter.md b/doc/wiki/documentation/Filter.md similarity index 100% rename from doc/wiki/Filter.md rename to doc/wiki/documentation/Filter.md diff --git a/doc/wiki/HTTP-client-library.md b/doc/wiki/documentation/HTTP-client-library.md similarity index 100% rename from doc/wiki/HTTP-client-library.md rename to doc/wiki/documentation/HTTP-client-library.md diff --git a/doc/wiki/Library-conneg.md b/doc/wiki/documentation/Library-conneg.md similarity index 100% rename from doc/wiki/Library-conneg.md rename to doc/wiki/documentation/Library-conneg.md diff --git a/doc/wiki/Request-and-response.md b/doc/wiki/documentation/Request-and-response.md similarity index 100% rename from doc/wiki/Request-and-response.md rename to doc/wiki/documentation/Request-and-response.md diff --git a/doc/wiki/Documentation__Request.md b/doc/wiki/documentation/Request.md similarity index 100% rename from doc/wiki/Documentation__Request.md rename to doc/wiki/documentation/Request.md diff --git a/doc/wiki/Documentation__Response.md b/doc/wiki/documentation/Response.md similarity index 100% rename from doc/wiki/Documentation__Response.md rename to doc/wiki/documentation/Response.md diff --git a/doc/wiki/Router.md b/doc/wiki/documentation/Router.md similarity index 65% rename from doc/wiki/Router.md rename to doc/wiki/documentation/Router.md index 0b208861..75571e7d 100644 --- a/doc/wiki/Router.md +++ b/doc/wiki/documentation/Router.md @@ -1,3 +1,6 @@ The primary goal of the router (class _WSF_ROUTER_) is to dispatch requests according to the request URI. -**TODO**: describe the router interface \ No newline at end of file +See WSF_ROUTER + +**TODO**: describe the router interface + diff --git a/doc/wiki/Documentation__Service.md b/doc/wiki/documentation/Service.md similarity index 100% rename from doc/wiki/Documentation__Service.md rename to doc/wiki/documentation/Service.md diff --git a/doc/wiki/Documentation.md b/doc/wiki/documentation/index.md similarity index 94% rename from doc/wiki/Documentation.md rename to doc/wiki/documentation/index.md index 8101379c..7270daf5 100644 --- a/doc/wiki/Documentation.md +++ b/doc/wiki/documentation/index.md @@ -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. 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) @@ -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. -> [Learn more about request](Documentation__Request.md) and [about response](Documentation__Response.md) +> [Learn more about request](Request.md) and [about response](Response.md) @@ -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. 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) @@ -113,7 +113,7 @@ How we do that in EWF? : Router with (or without context). Related code: wsf_router, wsf_router_context Examples -> [Learn more about router](Documentation__Router.md) +> [Learn more about router](Router.md) # EWF components ## URI Handler: @@ -180,21 +180,22 @@ examples External libraries are included, such as Cypress OAuth (Security), HTML parsing library, Template Engine Smarty. ## 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 * __libfcgi__: Wrapper for libfcgi SDK * __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. * CMS example: ## protocol * __http__: HTTP related classes, constants for status code, content types, ... * __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 -* __http_client__: simple HTTP client based on cURL +* __http_client__: simple [HTTP client](HTTP-client.library.md) based on cURL * __Firebase API__: ## Text diff --git a/doc/wiki/Using-the-policy-driven-framework.md b/doc/wiki/policy-driven-framework/Using-the-policy-driven-framework.md similarity index 100% rename from doc/wiki/Using-the-policy-driven-framework.md rename to doc/wiki/policy-driven-framework/Using-the-policy-driven-framework.md diff --git a/doc/wiki/WSF_OPTIONS_POLICY.md b/doc/wiki/policy-driven-framework/WSF_OPTIONS_POLICY.md similarity index 100% rename from doc/wiki/WSF_OPTIONS_POLICY.md rename to doc/wiki/policy-driven-framework/WSF_OPTIONS_POLICY.md diff --git a/doc/wiki/Writing-the-handlers.md b/doc/wiki/policy-driven-framework/Writing-the-handlers.md similarity index 100% rename from doc/wiki/Writing-the-handlers.md rename to doc/wiki/policy-driven-framework/Writing-the-handlers.md diff --git a/doc/wiki/Wsf-caching-policy.md b/doc/wiki/policy-driven-framework/Wsf-caching-policy.md similarity index 100% rename from doc/wiki/Wsf-caching-policy.md rename to doc/wiki/policy-driven-framework/Wsf-caching-policy.md diff --git a/doc/wiki/Wsf-previous-policy.md b/doc/wiki/policy-driven-framework/Wsf-previous-policy.md similarity index 100% rename from doc/wiki/Wsf-previous-policy.md rename to doc/wiki/policy-driven-framework/Wsf-previous-policy.md diff --git a/doc/wiki/Meetings.md b/doc/wiki/project/Meetings.md similarity index 78% rename from doc/wiki/Meetings.md rename to doc/wiki/project/Meetings.md index 05faf598..e93817e0 100644 --- a/doc/wiki/Meetings.md +++ b/doc/wiki/project/Meetings.md @@ -1,4 +1,4 @@ # 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) diff --git a/doc/wiki/Projects-new-suggestions.md b/doc/wiki/project/Projects-new-suggestions.md similarity index 100% rename from doc/wiki/Projects-new-suggestions.md rename to doc/wiki/project/Projects-new-suggestions.md diff --git a/doc/wiki/Projects.md b/doc/wiki/project/Projects.md similarity index 100% rename from doc/wiki/Projects.md rename to doc/wiki/project/Projects.md diff --git a/doc/wiki/Task-json.md b/doc/wiki/project/Task-json.md similarity index 100% rename from doc/wiki/Task-json.md rename to doc/wiki/project/Task-json.md diff --git a/doc/wiki/Tasks-Roadmap.md b/doc/wiki/project/Tasks-Roadmap.md similarity index 90% rename from doc/wiki/Tasks-Roadmap.md rename to doc/wiki/project/Tasks-Roadmap.md index 1a1a1a75..206f2bf5 100644 --- a/doc/wiki/Tasks-Roadmap.md +++ b/doc/wiki/project/Tasks-Roadmap.md @@ -1,4 +1,4 @@ -Check new roadmap wiki page: [roadmap](./roadmap) +Check new roadmap wiki page: [roadmap](roadmap.md) ## Future * Focus on REST API - Hypermedia API @@ -32,5 +32,5 @@ Check new roadmap wiki page: [roadmap](./roadmap) * Installation scripts ## Contributors ## - - See [the collaboration page](./Community-collaboration) + - See [the collaboration page](../community.md) diff --git a/doc/wiki/Useful-links.md b/doc/wiki/project/Useful-links.md similarity index 100% rename from doc/wiki/Useful-links.md rename to doc/wiki/project/Useful-links.md diff --git a/doc/wiki/Web-meeting-2012-09-18.md b/doc/wiki/project/meetings/Web-meeting-2012-09-18.md similarity index 100% rename from doc/wiki/Web-meeting-2012-09-18.md rename to doc/wiki/project/meetings/Web-meeting-2012-09-18.md diff --git a/doc/wiki/roadmap.md b/doc/wiki/project/roadmap.md similarity index 100% rename from doc/wiki/roadmap.md rename to doc/wiki/project/roadmap.md