Skip to content

Commit 71c90a2

Browse files
committed
Updated mediawiki and markdown link to local pages,
in order to use those files as browseable documentation, and close the github wiki.
1 parent 8057dca commit 71c90a2

10 files changed

+34
-34
lines changed

doc/wiki/Doc_Getting_Started.mediawiki

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
Menu :: [[Doc_Getting_Started|Getting Started]] :: [[Doc_Community|Community]]
1+
Menu :: [[Doc_Getting_Started.mediawiki|Getting Started]] :: [[Community-collaboration.md|Community]]
22

33
= Getting Started =
44
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:
5454
5555

5656
After one more compile, you can now launch the application and point your browser to [http://localhost:9090].
57-
You should now see a simple page with Hello World.
57+
You should now see a simple page with Hello World.

doc/wiki/Doc_Index.mediawiki

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
1-
Menu :: [[Doc_Getting_Started|Getting Started]] :: [[Doc_Community|Community]]
1+
Menu :: [[Doc_Getting_Started.mediawiki|Getting Started]] :: [[Community-collaboration.md|Community]]
22

33
= Eiffel Web Framework =
44
Framework to build web applications in Eiffel
55

66
[ [http://github.com/EiffelWebFramework/EWF/zipball/ Download Current] ]
7-
[ [http://github.com/EiffelWebFramework/EWF/zipball/release-0.3 Download v0.3] ]
7+
[ [http://github.com/EiffelWebFramework/EWF/zipball/release-0.3 Download v0.3] ]

doc/wiki/Documentation.md

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ This is the low level of the framework, at this point, `req` provides access to
2727
The response `res` is the interface to send data back to the client.
2828
For convenience, the framework provides richer service interface that handles the most common needs (filter, router, ...).
2929

30-
> [Learn more about service](Documentation__Service)
30+
> [Learn more about service](Documentation__Service.md)
3131
3232
<a name="wiki-request"></a><a name="wiki-response"></a><a name="wiki-request-and-response"></a>
3333
<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*
5050

5151
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.
5252

53-
> [Learn more about request](Documentation__Request) and [about response](Documentation__Response)
53+
> [Learn more about request](Documentation__Request.md) and [about response](Documentation__Response.md)
5454
5555
<a name="wiki-connector"></a>
5656
<a name="connector"></a>
@@ -66,7 +66,7 @@ Currently 3 main connectors are available:
6666
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.
6767
It is fairly easy to add new connector, it just has to follow the EWSGI interface
6868

69-
> [Learn more about connector](Documentation__Connector)
69+
> [Learn more about connector](Documentation__Connector.md)
7070
7171
<a name="wiki-router"></a>
7272
<a name="router"></a>
@@ -113,7 +113,7 @@ How we do that in EWF? : Router with (or without context).
113113
Related code: wsf_router, wsf_router_context
114114
Examples
115115

116-
> [Learn more about router](Documentation__Router)
116+
> [Learn more about router](Documentation__Router.md)
117117
118118
# EWF components
119119
## URI Handler:
@@ -180,25 +180,25 @@ examples
180180
External libraries are included, such as Cypress OAuth (Security), HTML parsing library, Template Engine Smarty.
181181

182182
## server
183-
* __ewsgi__: Eiffel Web Server Gateway Interface read more
183+
* __ewsgi__: Eiffel Web Server Gateway Interface [read more](EWSGI.md).
184184
* connectors: various web server connectors for EWSGI
185185
* __libfcgi__: Wrapper for libfcgi SDK
186-
* __wsf__: Web Server Framework [read more]
187-
* __router__: URL dispatching/routing based on uri, uri_template, or custom read more
186+
* __wsf__: Web Server Framework
187+
* __router__: URL dispatching/routing based on uri, uri_template, or custom [read more](Documentation__Router.md).
188188
* __wsf_html__: (html and css) Content generator from the server side.
189189
* CMS example: <https://github.com/EiffelWebFramework/cms/tree/master/example>
190190

191191
## protocol
192-
* __http__: HTTP related classes, constants for status code, content types, ... read more
193-
* __uri_template__: URI Template library (parsing and expander) read more
194-
* __content_negotiation__: CONNEG library (Content-type Negociation) read more
192+
* __http__: HTTP related classes, constants for status code, content types, ...
193+
* __uri_template__: URI Template library (parsing and expander)
194+
* __content_negotiation__: CONNEG library (Content-type Negociation)
195195

196196
## Client
197-
* __http_client__: simple HTTP client based on cURL readmore
197+
* __http_client__: simple HTTP client based on cURL
198198
* __Firebase API__: <https://github.com/EiffelWebFramework/Redwood>
199199

200200
## Text
201-
* __encoder__: Various simple encoders: base64, url-encoder, xml entities, html entities read more
201+
* __encoder__: Various simple encoders: base64, url-encoder, xml entities, html entities
202202

203203
## Utils
204204
* __error__: very simple/basic library to handle error

doc/wiki/EWSGI.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
1-
- See proposed specifications: [EWSGI specification](./EWSGI-specification)
2-
- See [Open questions](./EWSGI-Open-Questions)
1+
- See proposed specifications: [EWSGI specification](EWSGI-specification.md)
2+
- See [Open questions](EWSGI-Open-Questions.md)
33
- And below the various proposals and associated decision
44

55
----

doc/wiki/Home.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -6,21 +6,21 @@ The official documentation/wiki is located at [https://github.com/EiffelWebFrame
66
## Organization ##
77
- 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)
88
- Most of the topics are discussed on the mailing list (google group).
9-
- 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.
9+
- 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.
1010

1111
## Documentation ##
1212
- [Documentation](./Documentation)
1313

1414
## Contributions ##
15-
- You want to contribute or follow the progress/discussion, see the [collaboration page](./wiki/Community-collaboration)
16-
- Potential tasks/projects on EWF: [Projects page](./wiki/Projects)
15+
- You want to contribute or follow the progress/discussion, see the [collaboration page](Community-collaboration.md)
16+
- Potential tasks/projects on EWF: [Projects page](Projects.md)
1717

1818
## See also ##
19-
- [list of tasks, and a potential roadmap](./wiki/Tasks-Roadmap)
20-
- [General source structure of this project](./wiki/Source-structure)
21-
- EWSGI: [Eiffel Web Server Gateway Interface](./wiki/EWSGI)
22-
- [Overview of the server side architecture](./wiki/Spec-Server-Architecture)
23-
- This project is also a collection of [Libraries](./wiki/Libraries) related to the Web
19+
- [list of tasks, and a potential roadmap](Tasks-Roadmap.md)
20+
- [General source structure of this project](Source-structure.md)
21+
- EWSGI: [Eiffel Web Server Gateway Interface](EWSGI.md)
22+
- [Overview of the server side architecture](Spec-Server-Architecture.md)
23+
- This project is also a collection of [Libraries](Libraries.md) related to the Web
2424

2525
## Note ##
26-
- 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)
26+
- 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)

doc/wiki/Projects-new-suggestions.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
Use this to suggest new projects, or request features.
2-
The content of this page will be moved to the main [Projects](./Projects) page for time to time.
2+
The content of this page will be moved to the main [Projects](Projects.md) page for time to time.
33
For any entry, please use this template
44

55
----

doc/wiki/Projects.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -236,4 +236,4 @@ If you are a student, don't hesitate to pick one, or even suggest a new project,
236236
----
237237
# Feel free to add new idea below this line
238238
----
239-
Use the following page [Projects new suggestions](./Projects new suggestions) to suggest new project, or request a feature.
239+
Use the following page [Projects new suggestions](Projects-new-suggestions.md) to suggest new project, or request a feature.

doc/wiki/Using-the-policy-driven-framework.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,4 +23,4 @@ is_system_options_forbidden.
2323

2424
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.
2525

26-
Next you have to [write your handler(s)](./Writing-the-handlers)
26+
Next you have to [write your handler(s)](Writing-the-handlers.md)

doc/wiki/Writing-the-handlers.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -218,6 +218,6 @@ This routine is called for a normal (updating) PUT request. You have to update t
218218

219219
## Implementing the policies
220220

221-
* [WSF_OPTIONS_POLICY](./WSF_OPTIONS_POLICY)
222-
* [WSF_PREVIOUS_POLICY](./Wsf-previous-policy)
223-
* [WSF_CACHING_POLICY](./Wsf-caching-policy)
221+
* [WSF_OPTIONS_POLICY](WSF_OPTIONS_POLICY.md)
222+
* [WSF_PREVIOUS_POLICY](Wsf-previous-policy.md)
223+
* [WSF_CACHING_POLICY](Wsf-caching-policy.md)

doc/wiki/roadmap.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
# Upcoming versions
22

33
# Current state: oct-2013
4-
- check previous wiki page: [Tasks roadmap](./Tasks roadmap)
4+
- check previous wiki page: [Tasks roadmap](Tasks-roadmap.md)

0 commit comments

Comments
 (0)