Skip to content

Commit

Permalink
Deploying to gh-pages from @ 627bacc 🚀
Browse files Browse the repository at this point in the history
  • Loading branch information
balat committed Dec 21, 2023
1 parent adc67bb commit ba0427c
Show file tree
Hide file tree
Showing 10 changed files with 12 additions and 12 deletions.
2 changes: 1 addition & 1 deletion 7.1/manual/application.html
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@
creates scaffolds for Eliom projects. The following command creates a
very simple project called <span class="teletype">graffiti</span> in the directory
<span class="teletype">graffiti</span>:
</p><pre class="manually-translated"><code class="language-shell">$ eliom-distillery -name graffiti -template basic.ppx -target-directory graffiti</code></pre><h3>My first page</h3><aside class="concepts"><header><h5>Concepts</h5></header><p>Services<br/>Configuration file<br/>Static validation of HTML</p></aside><p>Our web application consists of a single page for now. Let's start by
</p><pre class="manually-translated"><code class="language-shell">$ eliom-distillery -name graffiti -template client-server.basic -target-directory graffiti</code></pre><h3>My first page</h3><aside class="concepts"><header><h5>Concepts</h5></header><p>Services<br/>Configuration file<br/>Static validation of HTML</p></aside><p>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:
</p><pre class="server" class=""><code class="language-ocaml translatable">open%server Eliom_content.Html.D (* provides functions to create HTML nodes *)
Expand Down
2 changes: 1 addition & 1 deletion 7.1/manual/basics.html
Original file line number Diff line number Diff line change
Expand Up @@ -467,7 +467,7 @@
</pre><p>It contains by default some code examples that you can remove or adapt to your own needs.
Have a look at the <span class="teletype">README</span> file.
</p><p>The make-based build system is provided by the basic template:
</p><pre>eliom-distillery -template basic.ppx -name myapp
</p><pre>eliom-distillery -template client-server.basic -name myapp
</pre><p>Have a look at the <span class="teletype">README</span> file.</p></section><section class="docblock"><header><h2>Sessions</h2></header><p>Session data is saved on server side in <em>Eliom references</em>.
</p><p>The following Eliom reference will count the number of visits of a user on a page:
</p><pre class="server" class=""><code class="language-ocaml translatable">let%server count_ref =
Expand Down
2 changes: 1 addition & 1 deletion 7.1/manual/basicwebsite.html
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,7 @@
</p><p>We recommend to use the program <span class="teletype">eliom-distillery</span>
to generate a template for your application (a Makefile and a default
configuration file for Ocsigen Server).
</p><pre class="manually-translated"><code class="language-shell">$ eliom-distillery -name mysite -template basic.ppx -target-directory mysite</code></pre><p>Modify file <span class="teletype">mysite.eliom</span> to include the piece of code above,
</p><pre class="manually-translated"><code class="language-shell">$ eliom-distillery -name mysite -template client-server.basic -target-directory mysite</code></pre><p>Modify file <span class="teletype">mysite.eliom</span> to include the piece of code above,
instead of the default one.
Then compile and run the server by doing:
</p><pre class="manually-translated"><code class="language-shell">$ make test.byte</code></pre><p>Your page is now available at URL <a href="http://localhost:8080/aaa/bbb" class="ocsimore_phrasing_link"><span class="teletype">http://localhost:8080/aaa/bbb</span></a>.
Expand Down
4 changes: 2 additions & 2 deletions 7.1/manual/how-to-compile-my-ocsigen-pages.html
Original file line number Diff line number Diff line change
Expand Up @@ -45,9 +45,9 @@
We are looking for beta-tester and contributors.
</p><button id="reason">Switch to </button><div class="twocols"><nav class="leftcol">Version <select class="how-versions" onchange="location = this.value;"><option value=".././../dev/manual/how-to-compile-my-ocsigen-pages">dev</option><option value=".././../7.1/manual/how-to-compile-my-ocsigen-pages" selected="selected">7.1</option><option value=".././../2.2/manual/how-to-compile-my-ocsigen-pages">2.2</option></select><nav class="how-doctree"><h1> Programmer's guide</h1><h2><a href="intro" class="ocsimore_phrasing_link">Introduction. Ocsigen: where to start?</a></h2><h2><a href="basics" class="ocsimore_phrasing_link">All Ocsigen in one page</a></h2><h1> Main tutorials</h1><h2><a href=".././../../install" class="ocsimore_phrasing_link">Install Ocsigen</a></h2><h2><a href="start" class="ocsimore_phrasing_link">Your first app in 5 minutes</a></h2><h2><a href="basicwebsite" class="ocsimore_phrasing_link">A basic Web site in OCaml</a></h2><h2><a href="application" class="ocsimore_phrasing_link">Client/server application: Graffiti</a></h2><h2><a href="tutowidgets" class="ocsimore_phrasing_link">Eliom apps basics: writing client-server widgets</a></h2><h2><a href="how-to-register-session-data" class="ocsimore_phrasing_link">Session data: Eliom references</a></h2><h2><a href="tutoreact" class="ocsimore_phrasing_link">Reactive client-server Web applications</a></h2><h2><a href="interaction" class="ocsimore_phrasing_link">Service based Web programming</a></h2><h2><a href="misc" class="ocsimore_phrasing_link">Mixing traditional Web interaction with client-server app</a></h2><h1> 5-minute tutorials</h1><h2><a href="lwt" class="ocsimore_phrasing_link">Lwt</a></h2><h2><a href="html" class="ocsimore_phrasing_link">HTML</a></h2><h1> Other tutorials: Miscellanous features</h1><h2><a href="mobile" class="ocsimore_phrasing_link">Mobile applications with Ocsigen</a></h2><h2><a href="custom-conf" class="ocsimore_phrasing_link">Custom configuration</a></h2><h2><a href="rest" class="ocsimore_phrasing_link">RESTful JSON API</a></h2><h2><a href="ocsipersist" class="ocsimore_phrasing_link">Persistent tables with Ocsipersist</a></h2><h1> Improving Graffiti</h1><h2><a href="pictures" class="ocsimore_phrasing_link">Download pictures</a></h2><h2><a href="music" class="ocsimore_phrasing_link">Playing music</a></h2><h2><a href="reactivemediaplayer" class="ocsimore_phrasing_link">Reactive media player</a></h2><h1 class="howto"> HOW-TO</h1><h2> My first steps with Ocsigen</h2><h3><a href="how-to-make-hello-world-in-ocsigen" class="ocsimore_phrasing_link">How to make &quot;hello world&quot; in Ocsigen</a></h3><h3><a href="how-to-compile-my-ocsigen-pages" class="ocsimore_phrasing_link">How to compile my Ocsigen pages</a></h3><h3><a href="how-to-configure-and-launch-the-ocsigen-server" class="ocsimore_phrasing_link">How to configure and launch the Ocsigen Server</a></h3><h3><a href="how-does-a-page-s-source-code-look" class="ocsimore_phrasing_link">How does a client-server app source code look like?</a></h3><h2> How to put some elements in my page ?</h2><h3><a href="how-to-make-page-a-skeleton" class="ocsimore_phrasing_link">How to make a page skeleton</a></h3><h3><a href="how-to-use-get-parameters-or-parameters-in-the-url" class="ocsimore_phrasing_link">How to use GET parameters (parameters in the URL)</a></h3><h3><a href="how-to-add-css-stylesheet" class="ocsimore_phrasing_link">How to add CSS stylesheet</a></h3><h3><a href="how-to-add-a-javascript-script" class="ocsimore_phrasing_link">How to add a Javascript script</a></h3><h3><a href="how-to-add-a-div" class="ocsimore_phrasing_link">How to add a div</a></h3><h3><a href="how-to-add-a-list" class="ocsimore_phrasing_link">How to add lists in pages?</a></h3><h3><a href="how-to-add-an-image" class="ocsimore_phrasing_link">How to add an image</a></h3><h3><a href="how-to-write-titles-and-paragraphs" class="ocsimore_phrasing_link">How to write titles and paragraphs</a></h3><h3><a href="how-to-set-and-id-classes-or-other-attributes-to-html-elements" class="ocsimore_phrasing_link">How to set and id, classes or other attributes to HTML elements</a></h3><h3><a href="how-to-add-a-select-or-other-form-element" class="ocsimore_phrasing_link">How to add select (or other form element)</a></h3><h3><a href="how-to-insert-raw-form-elements-not-belonging-to-a-form-towards-a-service" class="ocsimore_phrasing_link">How to insert &quot;raw&quot; form elements (not belonging to a form towards a service)</a></h3><h3><a href="how-to-make-responsive-css" class="ocsimore_phrasing_link">How to make responsive CSS</a></h3><h2> Services</h2><h3><a href="how-to-do-links-to-other-pages" class="ocsimore_phrasing_link">How to do links to other pages</a></h3><h3><a href="how-to-write-forms" class="ocsimore_phrasing_link">How to write forms</a></h3><h3><a href="how-to-register-a-service-that-decides-itself-what-to-send" class="ocsimore_phrasing_link">How to register a service that decides itself what to send</a></h3><h3><a href="how-to-create-link-to-a-current-page-without-knowing-its-url" class="ocsimore_phrasing_link">How to create link to a current page (without knowing its URL)</a></h3><h3><a href="how-to-create-form-wizard-sequence-of-pages-depending-on-data-entered-on-previous-ones" class="ocsimore_phrasing_link">How to create form wizard (sequence of pages depending on data entered on previous ones)</a></h3><h3><a href="how-to-write-a-json-service" class="ocsimore_phrasing_link">How to write a JSON service</a></h3><h3><a href="how-to-send-file-download" class="ocsimore_phrasing_link">How to send a file (download)</a></h3><h3><a href="how-to-send-file-upload" class="ocsimore_phrasing_link">How to send a file (upload)</a></h3><h2> Js_of_ocaml</h2><h3><a href="how-to-attach-ocaml-values-to-dom-elements" class="ocsimore_phrasing_link">How to attach OCaml values to DOM elements</a></h3><h3><a href="how-to-know-whether-the-browser-window-has-the-focus-or-not" class="ocsimore_phrasing_link">How to know whether the browser window has the focus or not</a></h3><h3><a href="how-to-build-js-object" class="ocsimore_phrasing_link">How to build js object</a></h3><h3><a href="how-to-stop-default-behaviour-of-events" class="ocsimore_phrasing_link">How to stop default behaviour of events</a></h3><h3><a href="how-to-call-an-ocaml-function-from-js-code" class="ocsimore_phrasing_link">How to call an OCaml function from js code</a></h3><h2> Eliom client-server applications</h2><h3><a href="how-to-call-a-server-side-function-from-client-side" class="ocsimore_phrasing_link">How to call a server-side function from the client side</a></h3><h3><a href="how-to-make-the-client-side-program-get-an-html-element-from-the-server-and-insert-it-in-the-page" class="ocsimore_phrasing_link">How to make the client side program get an HTML element from the server and insert it in the page</a></h3><h3><a href="how-to-attach-ocaml-values-to-the-html-nodes-sent-to-the-client" class="ocsimore_phrasing_link">How to attach OCaml values to the HTML nodes sent to the client</a></h3><h3><a href="how-to-iterate-on-all-sessions-for-one-user-or-all-tabs" class="ocsimore_phrasing_link">How to iterate on all sessions for one user, or all tabs</a></h3><h3><a href="how-to-implement-a-notification-system" class="ocsimore_phrasing_link">How to implement a notification system</a></h3><h3><a href="how-to-send-a-file-to-server-without-stopping-the-client-process" class="ocsimore_phrasing_link">How to send a file to server without stopping the client process</a></h3><h3><a href="how-to-detect-channel-disconnection" class="ocsimore_phrasing_link">How to detect channel disconnection</a></h3><h3><a href="how-to-detect-on-client-side-that-the-server-side-state-for-the-process-is-closed" class="ocsimore_phrasing_link">How to detect on client side that the server side state for the process is closed</a></h3><h2> Eliom Server side</h2><h3><a href="how-do-i-create-a-cryptographically-safe-identifier" class="ocsimore_phrasing_link">How do I create a Cryptographically safe identifier</a></h3><h3><a href="hash-password" class="ocsimore_phrasing_link">Protecting passwords</a></h3></nav></nav><article class="rightcol"><h1>How to compile my Ocsigen pages?</h1><h3> Eliom distillery</h3><p>Eliom-distillery will help you to build your client-server application
using Eliom.
It comes with several templates (&quot;basic.ppx&quot;, &quot;basic&quot;, &quot;mobile&quot;,
It comes with several templates (&quot;client-server.basic&quot;, &quot;os.pgocaml&quot;,
and more to come ...).
</p><pre>$ eliom-distillery -name &lt;name&gt; -template basic.ppx [-target-directory &lt;dir&gt;]
</p><pre>$ eliom-distillery -name &lt;name&gt; -template client-server.basic [-target-directory &lt;dir&gt;]
</pre><p>Eliom distillery will also create a default configuration file for Ocsigen
Server.
</p><p>More information on Eliom distillery in
Expand Down
2 changes: 1 addition & 1 deletion 7.1/manual/tutowidgets.html
Original file line number Diff line number Diff line change
Expand Up @@ -106,7 +106,7 @@
(Js_of_ocaml.Dom_html.document##.body)
(Eliom_content.Html.To_dom.of_element (mywidget &quot;Click me&quot; &quot;Hello!&quot;));
Lwt.return ()</code></pre><p>To compile it, first create a project by calling
</p><pre> eliom-distillery -name ex -template basic.ppx
</p><pre> eliom-distillery -name ex -template client-server.basic
</pre><p>The name of the project must match the name given to the functor
<span class="teletype">Eliom_registration.App</span>.
</p><p>After you adapt the file <span class="teletype">ex.eliom</span>,
Expand Down
2 changes: 1 addition & 1 deletion dev/manual/application.html
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@
creates scaffolds for Eliom projects. The following command creates a
very simple project called <span class="teletype">graffiti</span> in the directory
<span class="teletype">graffiti</span>:
</p><pre class="manually-translated"><code class="language-shell">$ eliom-distillery -name graffiti -template basic.ppx -target-directory graffiti</code></pre><h3>My first page</h3><aside class="concepts"><header><h5>Concepts</h5></header><p>Services<br/>Configuration file<br/>Static validation of HTML</p></aside><p>Our web application consists of a single page for now. Let's start by
</p><pre class="manually-translated"><code class="language-shell">$ eliom-distillery -name graffiti -template client-server.basic -target-directory graffiti</code></pre><h3>My first page</h3><aside class="concepts"><header><h5>Concepts</h5></header><p>Services<br/>Configuration file<br/>Static validation of HTML</p></aside><p>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:
</p><pre class="server" class=""><code class="language-ocaml translatable">open%server Eliom_content.Html.D (* provides functions to create HTML nodes *)
Expand Down
2 changes: 1 addition & 1 deletion dev/manual/basics.html
Original file line number Diff line number Diff line change
Expand Up @@ -467,7 +467,7 @@
</pre><p>It contains by default some code examples that you can remove or adapt to your own needs.
Have a look at the <span class="teletype">README</span> file.
</p><p>The make-based build system is provided by the basic template:
</p><pre>eliom-distillery -template basic.ppx -name myapp
</p><pre>eliom-distillery -template client-server.basic -name myapp
</pre><p>Have a look at the <span class="teletype">README</span> file.</p></section><section class="docblock"><header><h2>Sessions</h2></header><p>Session data is saved on server side in <em>Eliom references</em>.
</p><p>The following Eliom reference will count the number of visits of a user on a page:
</p><pre class="server" class=""><code class="language-ocaml translatable">let%server count_ref =
Expand Down
2 changes: 1 addition & 1 deletion dev/manual/basicwebsite.html
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,7 @@
</p><p>We recommend to use the program <span class="teletype">eliom-distillery</span>
to generate a template for your application (a Makefile and a default
configuration file for Ocsigen Server).
</p><pre class="manually-translated"><code class="language-shell">$ eliom-distillery -name mysite -template basic.ppx -target-directory mysite</code></pre><p>Modify file <span class="teletype">mysite.eliom</span> to include the piece of code above,
</p><pre class="manually-translated"><code class="language-shell">$ eliom-distillery -name mysite -template client-server.basic -target-directory mysite</code></pre><p>Modify file <span class="teletype">mysite.eliom</span> to include the piece of code above,
instead of the default one.
Then compile and run the server by doing:
</p><pre class="manually-translated"><code class="language-shell">$ make test.byte</code></pre><p>Your page is now available at URL <a href="http://localhost:8080/aaa/bbb" class="ocsimore_phrasing_link"><span class="teletype">http://localhost:8080/aaa/bbb</span></a>.
Expand Down
Loading

0 comments on commit ba0427c

Please sign in to comment.