diff --git a/doc/wiki/Doc_Getting_Started.mediawiki b/doc/wiki/Doc_Getting_Started.mediawiki index 550862d8..865d432a 100644 --- a/doc/wiki/Doc_Getting_Started.mediawiki +++ b/doc/wiki/Doc_Getting_Started.mediawiki @@ -1,4 +1,4 @@ -Menu :: [[Doc_Getting_Started|Getting Started]] :: [[Doc_Community|Community]] +Menu :: [[Doc_Getting_Started.mediawiki|Getting Started]] :: [[Community-collaboration.md|Community]] = Getting Started = This page will help you to get started with EWF. We will first see how to install EWF and then how to compile and run the venerable Hello World example. @@ -54,4 +54,4 @@ To do this, we will redefine the feature initialize as follows: After one more compile, you can now launch the application and point your browser to [http://localhost:9090]. -You should now see a simple page with Hello World. \ No newline at end of file +You should now see a simple page with Hello World. diff --git a/doc/wiki/Doc_Index.mediawiki b/doc/wiki/Doc_Index.mediawiki index 90016448..f5e9c3e2 100644 --- a/doc/wiki/Doc_Index.mediawiki +++ b/doc/wiki/Doc_Index.mediawiki @@ -1,7 +1,7 @@ -Menu :: [[Doc_Getting_Started|Getting Started]] :: [[Doc_Community|Community]] +Menu :: [[Doc_Getting_Started.mediawiki|Getting Started]] :: [[Community-collaboration.md|Community]] = Eiffel Web Framework = Framework to build web applications in Eiffel [ [http://github.com/EiffelWebFramework/EWF/zipball/ Download Current] ] -[ [http://github.com/EiffelWebFramework/EWF/zipball/release-0.3 Download v0.3] ] \ No newline at end of file +[ [http://github.com/EiffelWebFramework/EWF/zipball/release-0.3 Download v0.3] ] diff --git a/doc/wiki/Documentation.md b/doc/wiki/Documentation.md index 89c4264c..8101379c 100644 --- a/doc/wiki/Documentation.md +++ b/doc/wiki/Documentation.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) +> [Learn more about service](Documentation__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) and [about response](Documentation__Response) +> [Learn more about request](Documentation__Request.md) and [about response](Documentation__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) +> [Learn more about connector](Documentation__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) +> [Learn more about router](Documentation__Router.md) # EWF components ## URI Handler: @@ -180,25 +180,25 @@ 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__: Eiffel Web Server Gateway Interface [read more](EWSGI.md). * connectors: various web server connectors for EWSGI * __libfcgi__: Wrapper for libfcgi SDK -* __wsf__: Web Server Framework [read more] - * __router__: URL dispatching/routing based on uri, uri_template, or custom read more +* __wsf__: Web Server Framework + * __router__: URL dispatching/routing based on uri, uri_template, or custom [read more](Documentation__Router.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, ... read more -* __uri_template__: URI Template library (parsing and expander) read more -* __content_negotiation__: CONNEG library (Content-type Negociation) read more +* __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) ## Client -* __http_client__: simple HTTP client based on cURL readmore +* __http_client__: simple HTTP client based on cURL * __Firebase API__: ## Text -* __encoder__: Various simple encoders: base64, url-encoder, xml entities, html entities read more +* __encoder__: Various simple encoders: base64, url-encoder, xml entities, html entities ## Utils * __error__: very simple/basic library to handle error diff --git a/doc/wiki/EWSGI.md b/doc/wiki/EWSGI.md index 42a4fbbc..7b34869f 100644 --- a/doc/wiki/EWSGI.md +++ b/doc/wiki/EWSGI.md @@ -1,5 +1,5 @@ -- See proposed specifications: [EWSGI specification](./EWSGI-specification) -- See [Open questions](./EWSGI-Open-Questions) +- See proposed specifications: [EWSGI specification](EWSGI-specification.md) +- See [Open questions](EWSGI-Open-Questions.md) - And below the various proposals and associated decision ---- diff --git a/doc/wiki/Home.md b/doc/wiki/Home.md index 16806d74..1ae8df4b 100644 --- a/doc/wiki/Home.md +++ b/doc/wiki/Home.md @@ -6,21 +6,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](./wiki/Meetings), and less frequently [physical meetings](Meetings.md) that occurs usually during other Eiffel related events. ## 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.md) +- Potential tasks/projects on EWF: [Projects page](Projects.md) ## 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.md) + - [General source structure of this project](Source-structure.md) + - EWSGI: [Eiffel Web Server Gateway Interface](EWSGI.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 ## 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 + - 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) diff --git a/doc/wiki/Projects-new-suggestions.md b/doc/wiki/Projects-new-suggestions.md index 8ebc7ea9..5b1c1b4d 100644 --- a/doc/wiki/Projects-new-suggestions.md +++ b/doc/wiki/Projects-new-suggestions.md @@ -1,5 +1,5 @@ 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.md) page for time to time. For any entry, please use this template ---- diff --git a/doc/wiki/Projects.md b/doc/wiki/Projects.md index 92bce9d8..58e49f21 100644 --- a/doc/wiki/Projects.md +++ b/doc/wiki/Projects.md @@ -236,4 +236,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.md) to suggest new project, or request a feature. diff --git a/doc/wiki/Using-the-policy-driven-framework.md b/doc/wiki/Using-the-policy-driven-framework.md index 12d085e4..b9fa279c 100644 --- a/doc/wiki/Using-the-policy-driven-framework.md +++ b/doc/wiki/Using-the-policy-driven-framework.md @@ -23,4 +23,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.md) diff --git a/doc/wiki/Writing-the-handlers.md b/doc/wiki/Writing-the-handlers.md index 87e68a2c..bf404c2a 100644 --- a/doc/wiki/Writing-the-handlers.md +++ b/doc/wiki/Writing-the-handlers.md @@ -218,6 +218,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.md) +* [WSF_PREVIOUS_POLICY](Wsf-previous-policy.md) +* [WSF_CACHING_POLICY](Wsf-caching-policy.md) diff --git a/doc/wiki/roadmap.md b/doc/wiki/roadmap.md index a0b733b5..9516a246 100644 --- a/doc/wiki/roadmap.md +++ b/doc/wiki/roadmap.md @@ -1,4 +1,4 @@ # Upcoming versions # Current state: oct-2013 -- check previous wiki page: [Tasks roadmap](./Tasks roadmap) \ No newline at end of file +- check previous wiki page: [Tasks roadmap](Tasks-roadmap.md)