From ba0427cd611adb4a9fa8e7209eeb5b69d4b491a8 Mon Sep 17 00:00:00 2001 From: balat Date: Thu, 21 Dec 2023 16:12:02 +0000 Subject: [PATCH] =?UTF-8?q?Deploying=20to=20gh-pages=20from=20@=20ocsigen/?= =?UTF-8?q?tuto@627bacce647e492f2d288225325481148bb8c89e=20=F0=9F=9A=80?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- 7.1/manual/application.html | 2 +- 7.1/manual/basics.html | 2 +- 7.1/manual/basicwebsite.html | 2 +- 7.1/manual/how-to-compile-my-ocsigen-pages.html | 4 ++-- 7.1/manual/tutowidgets.html | 2 +- dev/manual/application.html | 2 +- dev/manual/basics.html | 2 +- dev/manual/basicwebsite.html | 2 +- dev/manual/how-to-compile-my-ocsigen-pages.html | 4 ++-- dev/manual/tutowidgets.html | 2 +- 10 files changed, 12 insertions(+), 12 deletions(-) diff --git a/7.1/manual/application.html b/7.1/manual/application.html index 2d81fe8c..dd446bfc 100644 --- a/7.1/manual/application.html +++ b/7.1/manual/application.html @@ -54,7 +54,7 @@ creates scaffolds for Eliom projects. The following command creates a very simple project called graffiti in the directory graffiti: -

$ eliom-distillery -name graffiti -template basic.ppx -target-directory graffiti

My first page

Our web application consists of a single page for now. Let's start by +

$ eliom-distillery -name graffiti -template client-server.basic -target-directory graffiti

My first page

Our web application consists of a single page for now. Let's start by creating a very basic page. We define the service that will implement this page by the following declaration:

open%server Eliom_content.Html.D (* provides functions to create HTML nodes *)
diff --git a/7.1/manual/basics.html b/7.1/manual/basics.html
index 274ae258..ffc72795 100644
--- a/7.1/manual/basics.html
+++ b/7.1/manual/basics.html
@@ -467,7 +467,7 @@
 

It contains by default some code examples that you can remove or adapt to your own needs. Have a look at the README file.

The make-based build system is provided by the basic template: -

eliom-distillery -template basic.ppx -name myapp
+

eliom-distillery -template client-server.basic -name myapp
 

Have a look at the README file.

Sessions

Session data is saved on server side in Eliom references.

The following Eliom reference will count the number of visits of a user on a page:

let%server count_ref =
diff --git a/7.1/manual/basicwebsite.html b/7.1/manual/basicwebsite.html
index 97daa04c..0e01c224 100644
--- a/7.1/manual/basicwebsite.html
+++ b/7.1/manual/basicwebsite.html
@@ -66,7 +66,7 @@
 

We recommend to use the program eliom-distillery to generate a template for your application (a Makefile and a default configuration file for Ocsigen Server). -

$ eliom-distillery -name mysite -template basic.ppx -target-directory mysite

Modify file mysite.eliom to include the piece of code above, +

$ eliom-distillery -name mysite -template client-server.basic -target-directory mysite

Modify file mysite.eliom to include the piece of code above, instead of the default one. Then compile and run the server by doing:

$ make test.byte

Your page is now available at URL http://localhost:8080/aaa/bbb. diff --git a/7.1/manual/how-to-compile-my-ocsigen-pages.html b/7.1/manual/how-to-compile-my-ocsigen-pages.html index 316e74cd..d2ceee3e 100644 --- a/7.1/manual/how-to-compile-my-ocsigen-pages.html +++ b/7.1/manual/how-to-compile-my-ocsigen-pages.html @@ -45,9 +45,9 @@ We are looking for beta-tester and contributors.

How to compile my Ocsigen pages?

Eliom distillery

Eliom-distillery will help you to build your client-server application using Eliom. -It comes with several templates ("basic.ppx", "basic", "mobile", +It comes with several templates ("client-server.basic", "os.pgocaml", and more to come ...). -

$ eliom-distillery -name <name> -template basic.ppx [-target-directory <dir>]
+

$ eliom-distillery -name <name> -template client-server.basic [-target-directory <dir>]
 

Eliom distillery will also create a default configuration file for Ocsigen Server.

More information on Eliom distillery in diff --git a/7.1/manual/tutowidgets.html b/7.1/manual/tutowidgets.html index 1682c307..d10f4864 100644 --- a/7.1/manual/tutowidgets.html +++ b/7.1/manual/tutowidgets.html @@ -106,7 +106,7 @@ (Js_of_ocaml.Dom_html.document##.body) (Eliom_content.Html.To_dom.of_element (mywidget "Click me" "Hello!")); Lwt.return ()

To compile it, first create a project by calling -

  eliom-distillery -name ex -template basic.ppx
+

  eliom-distillery -name ex -template client-server.basic
 

The name of the project must match the name given to the functor Eliom_registration.App.

After you adapt the file ex.eliom, diff --git a/dev/manual/application.html b/dev/manual/application.html index d3d9883c..891ab5cd 100644 --- a/dev/manual/application.html +++ b/dev/manual/application.html @@ -54,7 +54,7 @@ creates scaffolds for Eliom projects. The following command creates a very simple project called graffiti in the directory graffiti: -

$ eliom-distillery -name graffiti -template basic.ppx -target-directory graffiti

My first page

Our web application consists of a single page for now. Let's start by +

$ eliom-distillery -name graffiti -template client-server.basic -target-directory graffiti

My first page

Our web application consists of a single page for now. Let's start by creating a very basic page. We define the service that will implement this page by the following declaration:

open%server Eliom_content.Html.D (* provides functions to create HTML nodes *)
diff --git a/dev/manual/basics.html b/dev/manual/basics.html
index 38e427a6..7011c780 100644
--- a/dev/manual/basics.html
+++ b/dev/manual/basics.html
@@ -467,7 +467,7 @@
 

It contains by default some code examples that you can remove or adapt to your own needs. Have a look at the README file.

The make-based build system is provided by the basic template: -

eliom-distillery -template basic.ppx -name myapp
+

eliom-distillery -template client-server.basic -name myapp
 

Have a look at the README file.

Sessions

Session data is saved on server side in Eliom references.

The following Eliom reference will count the number of visits of a user on a page:

let%server count_ref =
diff --git a/dev/manual/basicwebsite.html b/dev/manual/basicwebsite.html
index d4771522..51013a55 100644
--- a/dev/manual/basicwebsite.html
+++ b/dev/manual/basicwebsite.html
@@ -66,7 +66,7 @@
 

We recommend to use the program eliom-distillery to generate a template for your application (a Makefile and a default configuration file for Ocsigen Server). -

$ eliom-distillery -name mysite -template basic.ppx -target-directory mysite

Modify file mysite.eliom to include the piece of code above, +

$ eliom-distillery -name mysite -template client-server.basic -target-directory mysite

Modify file mysite.eliom to include the piece of code above, instead of the default one. Then compile and run the server by doing:

$ make test.byte

Your page is now available at URL http://localhost:8080/aaa/bbb. diff --git a/dev/manual/how-to-compile-my-ocsigen-pages.html b/dev/manual/how-to-compile-my-ocsigen-pages.html index ba7d1fdf..8e56609a 100644 --- a/dev/manual/how-to-compile-my-ocsigen-pages.html +++ b/dev/manual/how-to-compile-my-ocsigen-pages.html @@ -45,9 +45,9 @@ We are looking for beta-tester and contributors.

How to compile my Ocsigen pages?

Eliom distillery

Eliom-distillery will help you to build your client-server application using Eliom. -It comes with several templates ("basic.ppx", "basic", "mobile", +It comes with several templates ("client-server.basic", "os.pgocaml", and more to come ...). -

$ eliom-distillery -name <name> -template basic.ppx [-target-directory <dir>]
+

$ eliom-distillery -name <name> -template client-server.basic [-target-directory <dir>]
 

Eliom distillery will also create a default configuration file for Ocsigen Server.

More information on Eliom distillery in diff --git a/dev/manual/tutowidgets.html b/dev/manual/tutowidgets.html index 18ea91db..a9cbac9c 100644 --- a/dev/manual/tutowidgets.html +++ b/dev/manual/tutowidgets.html @@ -106,7 +106,7 @@ (Js_of_ocaml.Dom_html.document##.body) (Eliom_content.Html.To_dom.of_element (mywidget "Click me" "Hello!")); Lwt.return ()

To compile it, first create a project by calling -

  eliom-distillery -name ex -template basic.ppx
+

  eliom-distillery -name ex -template client-server.basic
 

The name of the project must match the name given to the functor Eliom_registration.App.

After you adapt the file ex.eliom,