Commits

Anonymous committed a4e5ee2

Rewritten the page Getting Started in our User Guide

  • Participants
  • Parent commits 4c433f4

Comments (0)

Files changed (3)

File example-site/includes/css/screen.css

 	#content h4 {
 		font-size:14px;
 		font-weight:bold;
+		margin-top:14px;
 	}
 
 	/* Paragraph styles */
 	#content p {
 		font-size:12px;
 		line-height:17px;
+		margin-top:8px;
 	}
 	
 	#content .author {
 	
 	#content ul, ol {
 		margin-top:12px;
-		padding-left:25px;
+		padding-left:45px;
 	}
 	
 	#content li {

File example-site/views/dragonfly_welcome

+<% (display-partial "doctype") %>
+<% (display-partial "header") %>
+
+<body>
+
+<div id="wrap">
+	<div id="header">
+		<% (display-partial "navigation") %>	
+		<div class="clear"></div>
+	</div>
+
+	<div id="content">
+				
+		<div class="title nomargin">
+			<p><% (title "| Dragonfly web framework") %><p>
+		</div>
+		
+		<h1>Getting Started</h1>
+		<p class="extract">
+		Setting up Dragonfly is easy, there are only two steps, copying files, and changing the configuration to suit your site. Typically the configuration needs no adjusting, but depending on your situation you may need to make some adjustments.	
+		</p>
+		
+		<h2>Requirements</h2>
+		<p>Dragonfly requires the following to work:</p>
+		<ul>
+			<li>newLISP v10.1 or greater.</li>
+			<li>For magic redirection Apache web server is required.</li>
+		</ul>
+		
+		<p>If you meet those requirements, great! If you're using a custom web server, you might want to setup your own redirection script based on the .htaccess file.
+		</p>
+
+		<h2>Step 1 - Copying Files</h2>
+		<p>There are three things you'll need to copy into your site's root to install
+		Dragonfly. You'll find these files inside the 'example-site' folder.</p>
+		
+		<ol>
+			<li>The 'dragonfly-framework' folder</li>
+			<li>index.cgi</li>
+			<li>.htaccess (this file is hidden)</li>
+		</ol>
+		
+		<p>By "site root" we mean the folder that represents your basic web address,
+		for example if your website is located at:<br/><br/>
+		http://wwww.example-site.com/
+		<br/><br/>
+		And on your webserver that is represented by this folder (called the "site root"):
+		<br/><br/>
+		/home/www/example-site.com/
+		<br/><br/>
+		Then that's the folder you'll want to copy the files into.
+		<br/><br/>
+		If you'd like Dragonfly to live somewhere else inside your site root,
+		see the Example step at the end of this document.
+		</p>
+
+		<h2>Step 2 - Configure Dragonfly</h2>
+		<p>Edit the 'config.lsp' file in dragonfly-framework.<br/><br/>Read through the comments (they begin with a semi-colon) for instructions on what the settings are for.<br/><br/>If you want to prevent .html files from being processed through Dragonfly, open the .htaccess file in the site root and read the comments there for how to disable that behavior.
+		</p>
+
+		<h2>Step 3 - That's it'</h2>
+		<p>You're ready to run Dragonfly!</p>
+		
+		<div class="line-dotted"></div>
+
+		<% (benchmark-result) %>
+		
+		<div class="line-dotted"></div>
+		
+		
+	</div><!-- END CONTENT -->
+	
+</div><!-- END WRAP -->
+<% (display-partial "footer") %>
+

File example-site/views/welcome

 			<li>And discovering new programming styles</li>
 		</ol>
 		<p>&nbsp;</p>
-
-		<h2>Getting Started</h2>
-		<ol>
-			<li>We assume that You've already installed newLISP. If not, then download it first at <% (link_to_external "official site of newLISP" "http://www.newlisp.org/") %></li>
-			<li>Then download the latest version of <% (link_to_external "Dragonfly at GoogleCode" "http://code.google.com/p/dragonfly-newlisp/downloads/list") %></li>
-			<li>Extract the archive to Your harddrive</li>
-			<li>Start the builtin webserver by typing "newlisp -http -c -d 8080 -w /path/to/your/archive"</li>
-			<li>Open Your browser and navigate to <% (link_to_external "http://localhost:8080/" "http://localhost:8080/") %></li>
-		</ol>
-		<p>&nbsp;</p>
-
-		<h2>Exploring the folders</h2>
-		<p>The Dragonfly framework comes with a number of folders. The root folder is called <b class="files">dragonfly-framework</b>. This folder contains just two files, <b class="files">dragonfly.lsp</b> and <b class="files">README.TXT</b>. The <b class="files">dragonfly.lsp</b> contains core functions like routing and benchmarking.</p><br/>
-		<p>The subfolders are <b class="folders">config</b>, <b class="folders">docs</b>, <b class="folders">helpers-active</b>, <b class="folders">helpers-inactive</b>, <b class="folders">modules-active</b> and <b class="folders">modules-inactive</b>.</p><br/>
-		<p>Your web applications config will be stored in the subfolder <b class="folders">config</b>, in the file <b class="file">dragonfly_config.lsp</b>.</p>
 		
 		<div class="line-dotted"></div>