genit 1.0.1 → 2.0

data/NEWS

@@ -1,89 +1,73 @@
-v1.0.1  2013-03-13
+v2.0  2013-03-29
+  * Improve the layout folder structure, which add interesting side effects:
+    - faster compilation
+    - less use of compile command
+    - takes less size on disk
+  * Genit is now html5 only
+  * Genit provide a web server for development
+  * Config file is no longer an hidden file
+  * I remove all css templates
+  * Genit put an error message when the main template is malformed
+
 
+v1.0.1  2013-03-13
   * Fix a bug that creates a bad html5 doctype
 
 
 v1.0  2011-10-02
-
   * Genit creates a sitemap.xml
-  
   * Genit puts an error message when:
     - config file not present
     - unknown tag
     - bad or incomplete fragment tag
     - syntax error in .config
-  
   * Genit puts a warning message when a here tag is used without its counterpart
-  
   * Version is added to the .genit file
 
 
 v0.99  2011-09-25
-
   * Genit creates an RSS feed for your news articles
   
 
 v0.9  2011-09-04
-
   * You can add news to your site with ease
-  
   * The tag 'var' does not exist anymore. It is replaced by the two-part tag
     'here' & 'what'
-  
   * Put your public files (photo, text, pdf, etc.) in the 'public' folder
-  
   * Put your javascript in the 'scripts' folder
-  
   * Relative links should be written relative to the root (the index.hmtl file)
-  
   * New '--empty' switch for the 'create' command
-  
   * New '--doctype' option for the 'create' command
-  
   * Fix bug #38: named anchor crashes the compiler
   
 
 v0.5  2011-08-06
-
   * You can pass string variables from page to template
-  
   * Pages can be organized into subfolders
-  
   * fix a bug where the cli option -v crashed 
   
 
 v0.4.1  2011-07-30
-
   * Fix a bug where the closing part of auto-closing tags were forgotten.
 
 
 v0.4  2011-07-25
-
   * better smoke test
-  
   * basic user documentation 
-  
   * genit use a simple project file
-  
   * use clamp as a command line framework 
   
 
 v0.3  2011-07-23
-
   * You can split a page in a multitude of fragments.
 
 
 v0.2  2011-07-02
-
   * Globally styling your site
-  
   * Manage a main menu
 
 
 v0.1  2011-06-25
-
   * Create a project
-  
   * Compile a project (one template, multiple pages)
-  
   * A page can be in html or in markdown format

data/README.markdown

@@ -6,8 +6,12 @@ and database. A genit site consists only of xhtml code (+ css, medias and eventu
 
 Genit is written in Ruby but there is no needs to know the Ruby language.
 
-The project is in early development stage, see
-[project guidelines](https://github.com/lkdjiin/genit/blob/master/project_guidelines.markdown).
+**------------------------------------------------------------------------**
+
+**This readme file and all the documentation refers to version 1.0 of genit.
+I'm currently writing the doc for genit version 2.0**
+
+**------------------------------------------------------------------------**
 
 Description
 -----------

data/Rakefile

@@ -13,7 +13,7 @@ task :default => :spec
 
 desc 'Test genit with rspec'
 RSpec::Core::RakeTask.new(:spec) do |t|
-  t.rspec_opts = ['--color --format documentation']
+  t.rspec_opts = ['--color']
 end
 
 desc 'Check for code smells'

data/TODO

@@ -1,25 +1,190 @@
-BUG
-================
+version 2
+=============================================================
 
-Un site HTML5 compilé -> le résultat du doctype, head, etc. est un mélange
-de html5 et xhtml.
+[done] improve the layout folder structure
+[done] html5 uniquement
+[done] ajouter un serveur
+[done] config file should not be hidden
+[done] retirer alsa et yui
+[done] error msg when template is malformed
 
-Update docs to reflect the fact that all tags MUST be closed.
 
+version 2.x
+===============================================================
+menu: Pouvoir changer l'id "actif". Exemple li.active avec twitter bootstrap.
+a custom class for the selected menu item
 
-messages warning
-----------------
+use haml
+
+use sass/scss or less
+
+Document the genit tag and its attributes
+
+think about a deamon to auto-compile
+
+think about a pager for the news
+
+Think about i18n
+
+per page script 
+
+per page style
 
+--minimize option for the compile command
 
 si j'écris <h1>news page (en oubliant le tag de fin) Genit ne dis
 rien et ajoute silencieusement le </h1>. Voir si on peut lui faire
-cracher un warning (ou une erreur si pas possible warning).
+cracher une erreur.
 
 Quand je fais reférence à une url interne inexistante, il serait bon
-d'avoir un warning.
-
-dans le dossier page on accepte uniquement .html et .markdown (warning)
+d'avoir une erreur
 
 si j'écris </br> (au lieu de <br/>) Genit ne dis rien, le tag est ignoré.
-Voir si on peut lui faire cracher un warning (ou une erreur si pas possible warning).
+Voir si on peut lui faire cracher une erreur.
+
+Pouvoir utiliser les news avec markdown.
+
+dans le dossier page on accepte uniquement .html et .markdown (sinon erreur)
+
+
+
+
+Project guidelines
+==================
+
+Basic objectives
+----------------
+
+At a minimum, Genit should allow to do this :
+
+  + include typical sections:
+    - header
+    - footer
+    - sitemap
+    - menu
+  + generate the RSS feed (with all news, or only a certain number)
+  + generate news section (with all news, or only a certain number)
+  + include different css files per page
+  + include different script files per page
+  + generate different `<meta>` per page (title, keywords, etc.)
+
+Implementation
+--------------
+
+### Create a project
+
+We use the following command line :
+
+    genit create my-site
+    cd my-site
+
+#### Project structure
+
+    my-site/
+      fragments/
+      news/
+        2011-06-19.markdown
+      pages/
+        index.markdown
+      scripts/
+      styles/
+        alsa/
+          all.css
+        yui/
+          all.css
+        handheld.css
+        print.css
+        screen.css
+        images/
+      templates/
+        main.html
+        menu.html
+      www/
+
+#### Fragments folder
+
+Here we are some fragments, pieces of page.
+
+    <genit class="fragment" file="foo.markdown" />
+
+A fragment can be included in any page you want.
+
+Thinking in page fragment help to modularize the xthml code, like any other "real" programing language.
+
+#### News folder
+
+To include the X latest news:
+
+    <genit class="news" number="5" />
+
+Without number attribute, we include all news.
+
+The news are marked with the file name, which is the date. 
+I know it allows only one daily news, but for a static web site, I see
+no problem.
+
+#### Pages folder
+
+All site pages are in this folder. Written in .html or .markdown.
+
+
+#### Scripts folder
+
+I think to include prototype and scriptaculous by default, but:
+
+  * If you don't want to use javascript, don't use it.
+  * You can use any framework you want.
+
+To include a script in the `<head></head>` tag of a particular page,
+we can write (anywhere in the page but it's more readable at the beginning):
+
+    <genit class="script" file="foo.js" />
+
+
+#### Styles folder
+
+Everything that is related to the design of the site goes here.
+
+To include a particular css file in the `<head></head>` tag of a particular page,
+we can write (anywhere in the page but it's more readable at the beginning):
+
+    <genit class="css" file="foo.css" />
+
+#### Templates folder
+
+This is the wrapper(s) for all your site pages. Other frameworks may call it 'layout'.
+
+Only written in .html.
+For now, there is only two templates: the 'main.html' and the 'menu.html'.
+
+To include a page in the template:
+
+    <genit class="pages" />
+
+Some sections are found on the vast majority of web sites : header, footer,
+main menu, bottom menu, left side, right side and sitemap. To include those
+sections we'll write
+
+    <genit class="header" />
+    <genit class="footer" />
+    etc.
+
+#### www folder
+
+The "compiled" project will go here.
+
+TODO il serait peut-être bien d'avoir une option pour changer ce nom de dossier ?
+
+### Compiling the project
+
+The following command will generate the web site in the www folder:
+
+    genit compile
+
+A shortcut:
+
+    genit cc
+
+The --minimize option minimize the size of the file, good for production phase:
 
+    genit compile --minimize

data/VERSION

@@ -1 +1 @@
-1.0.1
+2.0

data/bin/genit

@@ -32,48 +32,46 @@ include Genit
 module Genit
 
   class AbstractCommand < Clamp::Command
-    
     option ['-v', '--version'], :flag, "print version" do
       puts "genit #{File.read(File.join($GENIT_PATH, 'VERSION')).strip}"
       exit 0
     end
-    
   end
-  
+
+  # Command to create a project.
   class CreateCommand < AbstractCommand
   
-    parameter "NAME", "the name of the project", :attribute_name => :project_name
-    option ["-d", "--doctype"], "DOCTYPE", "The Document Type Definition", :default => "html_5"
-    option ["-e", "--empty"], :flag, "Do not produce smoke test", :default => false
-
+    parameter "NAME", "the name of the project",
+              :attribute_name => :project_name
+    option ["-e", "--empty"], :flag, "Do not produce smoke test",
+           :default => false
 
     def execute
-      valid_doctypes = ['xhtml_1.0_strict', 'xhtml_1.0_transitional', 'html_5']
-      unless valid_doctypes.include? doctype
-        puts 'Valid doctypes are ' + valid_doctypes.inspect
-        exit 1
-      end
-      project = ProjectCreator.new project_name, doctype, empty?
+      project = ProjectCreator.new project_name, empty?
       project.create
     end
-    
   end
-  
-  class CompileCommand < AbstractCommand
 
+  # Command to compile a project.
+  class CompileCommand < AbstractCommand
     def execute
       compiler = Compiler.new Dir.getwd
       compiler.compile
     end
-    
   end
-  
+
+  # Command to start the web server.
+  class ServerCommand < AbstractCommand
+    def execute
+      Server.new(Dir.getwd).start
+    end
+  end
+
   class MainCommand < AbstractCommand
-    
     subcommand "create", "Create a project.", CreateCommand
     subcommand "compile", "Compile the web site.", CompileCommand
     subcommand "cc", "Compile the web site.", CompileCommand
-
+    subcommand "server", "Run WEBrick.", ServerCommand
   end
 
 end

data/data/styles/screen.css

@@ -14,22 +14,18 @@ margin-top:50px;
 #menu { display:none;}
 
 p {
-font-size:1.2em;
-color:#555;
+font-size:16px;
+color:#bbb;
 }
 
-p:hover {color:#003;}
+p:hover {color:#fff;}
 
-p:hover a {
+a {
 background-color:#003 !important;
 color:white !important;
 text-decoration:none !important;
 }
 
-a {
-color:#334 !important;
-}
-
-h1{color:#003;}
+h1{color:#fff;}
 
 html{background-color:#336;}

data/data/templates/main.html

@@ -1,5 +1,4 @@
     <title>Genit - Static web site framework</title>
-    <link rel="stylesheet" type="text/css" media="all" href="styles/alsa/all.css" /> 
     <link rel="stylesheet" type="text/css" media="screen" href="styles/screen.css" /> 
     <link rel="stylesheet" type="text/css" media="print" href="styles/print.css" /> 
   </head>

data/lib/genit.rb

@@ -5,6 +5,7 @@ require 'genit/documents'
 require 'genit/utils'
 require 'genit/builders'
 require 'genit/tags'
+require 'genit/server'
 
 module Errors
 
@@ -12,14 +13,18 @@ module Errors
     puts "Error: #{message}"
     exit 1
   end
-  
+
   def warning message
     puts "Warning: #{message}"
   end
-  
+
 end
-  
+
 module Genit
   include Errors
-  
+
+  PAGES_DIR = "src/pages"
+  TEMPLATES_DIR = "src/templates"
+  FRAGMENTS_DIR = "src/fragments"
+  NEWS_DIR = "src/news"
 end