RubyGems - utopia - Versions diffs - 2.13.4 → 2.14.0 - Mend

utopia 2.13.4 → 2.14.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (353) hide show

data/docs/javascript/index.html ADDED

@@ -0,0 +1,108 @@
+<!DOCTYPE html>
+<html>
+	<head>
+			<title>Javascript</title>
+		<meta charset="UTF-8"/>
+		<link rel="icon" type="image/png" href="../_static/icon.png"/>
+		<link rel="stylesheet" href="../_static/site.css" type="text/css" media="screen"/>
+		<script src="../_components/jquery/jquery.min.js"></script>
+		<script src="../_components/jquery-syntax/jquery.syntax.min.js"></script>
+		<script type="text/javascript">
+		//<![CDATA[
+			jQuery(function($) {
+				$.syntax();
+			});
+		//]]>
+		</script>
+	</head>
+	<body class="show">
+	<nav> › <a href="../index.html">Wiki</a> › <a href="index.html">JavaScript</a></nav>
+	<main>
+		<h1 id="installing-javascript-libraries">Installing JavaScript Libraries</h1>
+<p>Utopia integrates with Yarn and provides a <a href="https://github.com/ioquatix/bake">bake task</a> to simplify deployment packages distributed using <code>yarn</code> that implement the <code>dist</code> sub-directory convention.</p>
+<p>By default, utopia includes a <code>.yarnrc</code> file which installs modules into <code>lib/components</code>. This code can then be copied into <code>public/_components</code> using <code>bake utopia:yarn:update</code>.</p>
+<h2 id="installing-yarn">Installing Yarn</h2>
+<p>If you don’t already have yarn installed, make sure you have npm installed and then run the following command:</p>
+<pre><code class="language-bash">$ sudo npm install -g yarn
+</code></pre>
+<h2 id="installing-jquery">Installing jQuery</h2>
+<p>Firstly, ensure your project has a <code>package.json</code> file:</p>
+<pre><code class="language-bash">$ yarn init
+</code></pre>
+<p>Then install jquery using <code>yarn</code>:</p>
+<pre><code class="language-bash">$ yarn install jquery
+</code></pre>
+<p>Copy the distribution scripts to <code>public/_components</code>:</p>
+<pre><code class="language-bash">$ bundle exec bake utopia:yarn:update
+</code></pre>
+<p>Then add the appropriate <code>&lt;script&gt;</code> tags to <code>pages/_page.xnode</code>:</p>
+<pre><code class="language-html">&lt;script type=&quot;text/javascript&quot; src=&quot;/_components/jquery/jquery.min.js&quot;&gt;&lt;/script&gt;
+</code></pre>
+<h2 id="using-javascript">Using JavaScript</h2>
+<p>You can use JavaScript by embedding it directly into your HTML, or by creating a JavaScript source file and referencing that.</p>
+<h3 id="embedding-code">Embedding Code</h3>
+<p>In your HTML view:</p>
+<pre><code class="language-trenni">&lt;html&gt;
+  &lt;body&gt;
+    &lt;script type=&quot;text/javascript&quot;&gt;
+      //&lt;![CDATA[
+      console.log(&quot;Hello World&quot;)
+      //]]&gt;
+    &lt;/script&gt;
+  &lt;/body&gt;
+&lt;/html&gt;
+</code></pre>
+<h3 id="external-script">External Script</h3>
+<p>In <code>script.js</code>:</p>
+<pre><code class="language-javascript">console.log("Hello World")
+</code></pre>
+<p>In your HTML view:</p>
+<pre><code class="language-trenni">&lt;html&gt;
+  &lt;body&gt;
+    &lt;script type=&quot;text/javascript&quot; src=&quot;script.js&quot;&gt;&lt;/script&gt;
+  &lt;/body&gt;
+&lt;/html&gt;
+</code></pre>
+	</main>
+	<footer>
+		Last Modified: 2020-04-28 23:19:48 +1200
+		— javascript/index.md
+	</footer>
+	</body>
+</html>

data/docs/{wiki/middleware/content.html → middleware/content/index.html} RENAMED

@@ -2,12 +2,10 @@
 <html>
 	<head>
-			<title>Content - Utopia</title>
+			<title>Content</title>
 		<meta charset="UTF-8"/>
-		<link href="https://maxcdn.bootstrapcdn.com/font-awesome/4.7.0/css/font-awesome.min.css" rel="stylesheet" integrity="sha384-wvfXpqpZZVQGK6TAh5PVlGOfQNHSoD2xbE+QkPxCAFlNEevoEH3Sl0sibVcOQVnN" crossorigin="anonymous"/>
 		<link rel="icon" type="image/png" href="../../_static/icon.png"/>
 		<link rel="stylesheet" href="../../_static/site.css" type="text/css" media="screen"/>
@@ -23,18 +21,13 @@
 		</script>
 	</head>
-	<body class="">
-		<header>
-			<img src="../../_static/utopia.svg"/>
-		</header>
-		<div id="page">
-	<nav>
-	 › <a href="../../wiki.html">Wiki</a> › <span>Middleware</span> › <a href="content.html">Content</a></nav>
+	<body class="show">
+	<nav> › <a href="../../index.html">Wiki</a> › <span>Middleware</span> › <a href="index.html">Content</a></nav>
-	<h1 id="content">Content</h1>
+	<main>
+		<h1 id="content">Content</h1>
 <p>A tag based content generation system which integrates nicely with HTML5. Supports structures which separate generic page templates from dynamically generated content in an easy and consistent way.</p>
 <pre><code class="language-ruby">use Utopia::Content,
@@ -54,11 +47,12 @@
 <p>This template would typically be designed with supporting <code>_page.xnode</code> and <code>_heading.xnode</code> in the same directory or, more typically, somewhere further up the directory hierarchy.</p>
+	</main>
 	<footer>
-		Last Modified: 2017-05-03 14:21:19 +1200 —
+		Last Modified: 2020-04-28 11:35:36 +1200
+		— middleware/content/index.md
 	</footer>
-		</div>
 	</body>
 </html>

data/docs/{wiki/middleware/controller/actions.html → middleware/controller/actions/index.html} RENAMED

@@ -2,12 +2,10 @@
 <html>
 	<head>
-			<title>Actions - Utopia</title>
+			<title>Actions</title>
 		<meta charset="UTF-8"/>
-		<link href="https://maxcdn.bootstrapcdn.com/font-awesome/4.7.0/css/font-awesome.min.css" rel="stylesheet" integrity="sha384-wvfXpqpZZVQGK6TAh5PVlGOfQNHSoD2xbE+QkPxCAFlNEevoEH3Sl0sibVcOQVnN" crossorigin="anonymous"/>
 		<link rel="icon" type="image/png" href="../../../_static/icon.png"/>
 		<link rel="stylesheet" href="../../../_static/site.css" type="text/css" media="screen"/>
@@ -23,18 +21,13 @@
 		</script>
 	</head>
-	<body class="">
-		<header>
-			<img src="../../../_static/utopia.svg"/>
-		</header>
-		<div id="page">
-	<nav>
-	 › <a href="../../../wiki.html">Wiki</a> › <span>Middleware</span> › <a href="../controller.html">Controller</a> › <a href="actions.html">Actions</a></nav>
+	<body class="show">
+	<nav> › <a href="../../../index.html">Wiki</a> › <span>Middleware</span> › <a href="../index.html">Controller</a> › <a href="index.html">Actions</a></nav>
-	<h1 id="controlleractions">Controller::Actions</h1>
+	<main>
+		<h1 id="controlleractions">Controller::Actions</h1>
 <p>Actions let you match path patterns in your controller and execute code. In your <code>controller.rb</code> simply add:</p>
@@ -83,7 +76,7 @@ end
 <h2 id="path-matching">Path Matching</h2>
-<p>Path matching works from right to left, and ‘**’ is a greedy operator. Controllers are invoked with a path relative to the controller’s <code>URI_PATH</code>, so all lookups are relative to the controller.</p>
+<p>Path matching works from right to left, and <code>'**'</code> is a greedy operator. Controllers are invoked with a path relative to the controller’s <code>URI_PATH</code>, so all lookups are relative to the controller.</p>
 <dl>
 	<dt><code class="language-ruby">"*"</code></dt>
@@ -105,13 +98,14 @@ end
 end
 </code></pre>
-<p>If you are doing this to perform some kind of rewriting, it may be preferable to use the <a href="actions/rewrite/index.html">Rewrite</a> controller layer.</p>
+<p>If you are doing this to perform some kind of rewriting, it may be preferable to use the <a href="../rewrite/index.html">Rewrite</a> controller layer.</p>
+	</main>
 	<footer>
-		Last Modified: 2017-05-03 14:21:19 +1200 —
+		Last Modified: 2020-04-28 23:19:19 +1200
+		— middleware/controller/actions/index.md
 	</footer>
-		</div>
 	</body>
 </html>

data/docs/{wiki/middleware/controller.html → middleware/controller/index.html} RENAMED

@@ -2,12 +2,10 @@
 <html>
 	<head>
-			<title>Controller - Utopia</title>
+			<title>Controller</title>
 		<meta charset="UTF-8"/>
-		<link href="https://maxcdn.bootstrapcdn.com/font-awesome/4.7.0/css/font-awesome.min.css" rel="stylesheet" integrity="sha384-wvfXpqpZZVQGK6TAh5PVlGOfQNHSoD2xbE+QkPxCAFlNEevoEH3Sl0sibVcOQVnN" crossorigin="anonymous"/>
 		<link rel="icon" type="image/png" href="../../_static/icon.png"/>
 		<link rel="stylesheet" href="../../_static/site.css" type="text/css" media="screen"/>
@@ -23,18 +21,13 @@
 		</script>
 	</head>
-	<body class="">
-		<header>
-			<img src="../../_static/utopia.svg"/>
-		</header>
-		<div id="page">
-	<nav>
-	 › <a href="../../wiki.html">Wiki</a> › <span>Middleware</span> › <a href="controller.html">Controller</a></nav>
+	<body class="show">
+	<nav> › <a href="../../index.html">Wiki</a> › <span>Middleware</span> › <a href="index.html">Controller</a></nav>
-	<h1 id="controller">Controller</h1>
+	<main>
+		<h1 id="controller">Controller</h1>
 <p>A simple recursive controller layer which works in isolation from the view rendering middleware.</p>
@@ -94,11 +87,12 @@ otherwise do |request, path|
 end
 </code></pre>
+	</main>
 	<footer>
-		Last Modified: 2016-12-13 12:38:35 +1300 —
+		Last Modified: 2020-04-28 11:35:36 +1200
+		— middleware/controller/index.md
 	</footer>
-		</div>
 	</body>
 </html>

data/docs/{wiki/middleware/controller/rewrite.html → middleware/controller/rewrite/index.html} RENAMED

@@ -2,12 +2,10 @@
 <html>
 	<head>
-			<title>Rewrite - Utopia</title>
+			<title>Rewrite</title>
 		<meta charset="UTF-8"/>
-		<link href="https://maxcdn.bootstrapcdn.com/font-awesome/4.7.0/css/font-awesome.min.css" rel="stylesheet" integrity="sha384-wvfXpqpZZVQGK6TAh5PVlGOfQNHSoD2xbE+QkPxCAFlNEevoEH3Sl0sibVcOQVnN" crossorigin="anonymous"/>
 		<link rel="icon" type="image/png" href="../../../_static/icon.png"/>
 		<link rel="stylesheet" href="../../../_static/site.css" type="text/css" media="screen"/>
@@ -23,18 +21,13 @@
 		</script>
 	</head>
-	<body class="">
-		<header>
-			<img src="../../../_static/utopia.svg"/>
-		</header>
-		<div id="page">
-	<nav>
-	 › <a href="../../../wiki.html">Wiki</a> › <span>Middleware</span> › <a href="../controller.html">Controller</a> › <a href="rewrite.html">Rewrite</a></nav>
+	<body class="show">
+	<nav> › <a href="../../../index.html">Wiki</a> › <span>Middleware</span> › <a href="../index.html">Controller</a> › <a href="index.html">Rewrite</a></nav>
-	<h1 id="controllerrewrite">Controller::Rewrite</h1>
+	<main>
+		<h1 id="controllerrewrite">Controller::Rewrite</h1>
 <p>The <code class="language-ruby">Controller::Rewrite</code> layer can match and rewrite requests before they processed. This allows you to handle URLs like <code>/post/15/view</code> or <code>/blog/123-pictures-of-my-cat</code> easily. The basic rewrite operation is to extract some part of the path and optionally executes a block. That means that the path is modified before being passed on to the next layer in the controller, and controller instance variables may be set.</p>
@@ -101,11 +94,12 @@ end
 <p>It’s possible to match using <code class="language-ruby">Integer</code>, <code class="language-ruby">Float</code>, <code class="language-ruby">String</code>, and you can provide your own class which will be instantiated. If it doesn’t match, raise an exception and the rewrite rule will fail.</p>
+	</main>
 	<footer>
-		Last Modified: 2017-05-03 14:21:19 +1200 —
+		Last Modified: 2020-04-28 11:35:36 +1200
+		— middleware/controller/rewrite/index.md
 	</footer>
-		</div>
 	</body>
 </html>

data/docs/{wiki/middleware/localization.html → middleware/localization/index.html} RENAMED

@@ -2,12 +2,10 @@
 <html>
 	<head>
-			<title>Localization - Utopia</title>
+			<title>Localization</title>
 		<meta charset="UTF-8"/>
-		<link href="https://maxcdn.bootstrapcdn.com/font-awesome/4.7.0/css/font-awesome.min.css" rel="stylesheet" integrity="sha384-wvfXpqpZZVQGK6TAh5PVlGOfQNHSoD2xbE+QkPxCAFlNEevoEH3Sl0sibVcOQVnN" crossorigin="anonymous"/>
 		<link rel="icon" type="image/png" href="../../_static/icon.png"/>
 		<link rel="stylesheet" href="../../_static/site.css" type="text/css" media="screen"/>
@@ -23,18 +21,13 @@
 		</script>
 	</head>
-	<body class="">
-		<header>
-			<img src="../../_static/utopia.svg"/>
-		</header>
-		<div id="page">
-	<nav>
-	 › <a href="../../wiki.html">Wiki</a> › <span>Middleware</span> › <a href="localization.html">Localization</a></nav>
+	<body class="show">
+	<nav> › <a href="../../index.html">Wiki</a> › <span>Middleware</span> › <a href="index.html">Localization</a></nav>
-	<h1 id="localization">Localization</h1>
+	<main>
+		<h1 id="localization">Localization</h1>
 <p>The localization middleware uses the <code>Accept-Language</code> header to guess the preferred locale out of the given options. If a request path maps to a resource, that resource is returned. Otherwise, a localized request is made.</p>
@@ -49,11 +42,12 @@
 show_welcome(localization.current_locale)
 </code></pre>
+	</main>
 	<footer>
-		Last Modified: 2017-05-03 14:21:19 +1200 —
+		Last Modified: 2020-04-28 11:35:36 +1200
+		— middleware/localization/index.md
 	</footer>
-		</div>
 	</body>
 </html>

data/docs/{wiki/middleware/redirection.html → middleware/redirection/index.html} RENAMED

@@ -2,12 +2,10 @@
 <html>
 	<head>
-			<title>Redirection - Utopia</title>
+			<title>Redirection</title>
 		<meta charset="UTF-8"/>
-		<link href="https://maxcdn.bootstrapcdn.com/font-awesome/4.7.0/css/font-awesome.min.css" rel="stylesheet" integrity="sha384-wvfXpqpZZVQGK6TAh5PVlGOfQNHSoD2xbE+QkPxCAFlNEevoEH3Sl0sibVcOQVnN" crossorigin="anonymous"/>
 		<link rel="icon" type="image/png" href="../../_static/icon.png"/>
 		<link rel="stylesheet" href="../../_static/site.css" type="text/css" media="screen"/>
@@ -23,18 +21,13 @@
 		</script>
 	</head>
-	<body class="">
-		<header>
-			<img src="../../_static/utopia.svg"/>
-		</header>
-		<div id="page">
-	<nav>
-	 › <a href="../../wiki.html">Wiki</a> › <span>Middleware</span> › <a href="redirection.html">Redirection</a></nav>
+	<body class="show">
+	<nav> › <a href="../../index.html">Wiki</a> › <span>Middleware</span> › <a href="index.html">Redirection</a></nav>
-	<h1 id="redirection">Redirection</h1>
+	<main>
+		<h1 id="redirection">Redirection</h1>
 <p>A set of flexible URI rewriting middleware which includes support for string mappings, regular expressions and status codes (e.g. 404 errors).</p>
@@ -51,11 +44,12 @@ use Utopia::Redirection::Errors,
 	404 =&gt; '/errors/file-not-found'
 </code></pre>
+	</main>
 	<footer>
-		Last Modified: 2016-12-13 12:37:11 +1300 —
+		Last Modified: 2020-04-28 11:35:36 +1200
+		— middleware/redirection/index.md
 	</footer>
-		</div>
 	</body>
 </html>

data/docs/{wiki/middleware/session.html → middleware/session/index.html} RENAMED

@@ -2,12 +2,10 @@
 <html>
 	<head>
-			<title>Session - Utopia</title>
+			<title>Session</title>
 		<meta charset="UTF-8"/>
-		<link href="https://maxcdn.bootstrapcdn.com/font-awesome/4.7.0/css/font-awesome.min.css" rel="stylesheet" integrity="sha384-wvfXpqpZZVQGK6TAh5PVlGOfQNHSoD2xbE+QkPxCAFlNEevoEH3Sl0sibVcOQVnN" crossorigin="anonymous"/>
 		<link rel="icon" type="image/png" href="../../_static/icon.png"/>
 		<link rel="stylesheet" href="../../_static/site.css" type="text/css" media="screen"/>
@@ -23,18 +21,13 @@
 		</script>
 	</head>
-	<body class="">
-		<header>
-			<img src="../../_static/utopia.svg"/>
-		</header>
-		<div id="page">
-	<nav>
-	 › <a href="../../wiki.html">Wiki</a> › <span>Middleware</span> › <a href="session.html">Session</a></nav>
+	<body class="show">
+	<nav> › <a href="../../index.html">Wiki</a> › <span>Middleware</span> › <a href="index.html">Session</a></nav>
-	<h1 id="session">Session</h1>
+	<main>
+		<h1 id="session">Session</h1>
 <p>The session management uses symmetric private key encryption to store data on the client and avoid tampering.</p>
@@ -61,11 +54,12 @@
 <p>This is done by default when using <code>utopia server create</code> and <code>utopia server update</code>.</p>
+	</main>
 	<footer>
-		Last Modified: 2017-02-13 16:30:17 +1300 —
+		Last Modified: 2020-04-28 11:35:36 +1200
+		— middleware/session/index.md
 	</footer>
-		</div>
 	</body>
 </html>