latest content

Author: benkeen

_config.yml

@@ -3,7 +3,7 @@ title: Form Tools Documentation
 email: [email protected]
 description: "Documentation and tutorials for all things Form Tools."
 exclude: [repos]
-baseurl: "/docs"
+baseurl: ""
 url: "http://docs.formtools.org"
 
 # build settings

_data/module_list.json

@@ -1 +1 @@
-[{"name":"Form Builder","description":"Automatically publish any forms directly onto your website. No programming knowledge needed!","icons":{"16x16":"assets/images/icon-16x16.png","32x32":"assets/images/icon-32x32.png","48x48":"assets/images/icon-48x48.png","64x64":"assets/images/icon-128x128.png","128x128":"assets/images/icon-128x128.png"},"folder":"module-form_builder"}]
+[{"name":"Form Builder","description":"Automatically publish any forms directly onto your website. No programming knowledge needed!","icons":{"16x16":"icon-16x16.png","32x32":"icon-32x32.png","48x48":"icon-48x48.png","64x64":"icon-64x64.png","128x128":"icon-128x128.png"},"folder":"module-form_builder"}]

assets/css/core.css

@@ -8495,6 +8495,11 @@ img.mfp-img {
     opacity: 0;
 }
 
+.icon48x48 {
+    display: inline-block;
+    width: 48px;
+    height: 48px;
+}
 .icon64x64 {
     display: inline-block;
     width: 64px;

assets/generated/module-form_builder/icon-128x128.png

@@ -3,6 +3,7 @@ module.exports = function(grunt) {
 
 	var fs = require("fs");
 	var vm = require("vm");
+  var rimraf = require('rimraf');
 
   var _includeInThisScope = function (path) {
     var code = fs.readFileSync(path);
@@ -11,20 +12,19 @@ module.exports = function(grunt) {
   _includeInThisScope("grunt/plugin_list.js");
   _includeInThisScope("grunt/helpers.js");
 
+
   var generateListFile = function(source) {
     var sourceObj = (source === "module") ? modules : themes;
-
     var found = [];
     for (var i=0; i<sourceObj.length; i++) {
       var folder = source + "-" + sourceObj[i];
       var packageFile = "repos/" + folder + "/package.json";
       if (!fs.existsSync(packageFile)) {
         continue;
       }
-
       var json = grunt.file.readJSON(packageFile);
 
-      // copy the icons out of the module/theme
+      // copy the icons out of the module/theme and into the docs section
       if (source === "module") {
         copyIcons(folder, json.icons);
       } else {
@@ -33,57 +33,50 @@ module.exports = function(grunt) {
 
       // append the folder name. This is used to construct links to the icons
       json.folder = folder;
-
       found.push(json);
     }
 
     grunt.file.write("_data/" + source + "_list.json", JSON.stringify(found));
   };
 
-
-  var iconFile, targetFolder;
   var copyIcons = function (folder, icons) {
-
-    // remove the old folder
-    config.clean.folder = ["./assets/generated/" + folder];
-    grunt.task.run("clean:folder")
+    // wipe out of the old folder and recreate it
+    var path = "assets/generated/" + folder;
+    rimraf.sync(path);
+    fs.mkdirSync(path);
 
     // now copy over the icons
     for (var icon in icons) {
-      iconFile = "./repos/" + folder + "/" + icons[icon];
-      targetFolder = "assets/generated/" + folder + "/";
-
-      // create the folder
-      grunt.task.run("shell:copyIcon");
+      var sourceFile = "./repos/" + folder + "/assets/images/" + icons[icon];
+      var targetLocation = "assets/generated/" + folder + "/" + icons[icon];
+      copyFileSync(sourceFile, targetLocation);
     }
   };
 
-  var getCopyIconCommand = function () {
-    var commands = [];
-    commands.push("sudo mkdir " + targetFolder);
-    commands.push("sudo chmod 777 " + targetFolder);
-    commands.push("sudo cp " + iconFile + " " + targetFolder);
-
-    console.log("_______________________________");
-    console.log(commands);
-    console.log("_______________________________");
-
-    return commands.join('&&');
+  var copyFileSync = function(srcFile, destFile) {
+    var content = fs.readFileSync(srcFile);
+    fs.writeFileSync(destFile, content);
   };
 
-
 	var config = {
 		pkg: grunt.file.readJSON("package.json"),
 		clean: {},
 		template: {},
     copy: {},
-
 		shell: {
 			start: { command: "jekyll serve --watch" },
       update:          { command: getUpdateCommands() },
 			downloadModules: { command: getModuleRepoCommands() },
 			downloadThemes:  { command: getThemeRepoCommands() },
-      copyIcon: { command: function() { getCopyIconCommand(); } }
+
+      // builds the module documentation into /modules/[MODULE_FOLDER]
+      buildModuleDoc: {
+        command: [
+          "cd repos/module-form_builder",
+          "jekyll build --config _config_docs.yml --destination ../../modules/module-form_builder"
+        ].join('&&')
+      }
+
 		}
 	};
 
@@ -108,7 +101,7 @@ module.exports = function(grunt) {
   grunt.registerTask("init", ["shell:downloadModules", "shell:downloadThemes", "createModuleListFiles"]);
 
   // updates the content of the external repos and rebuilds
-  grunt.registerTask("update", ["shell:update", "createModuleListFiles"]);
+  grunt.registerTask("update", ["shell:update", "createModuleListFiles", "shell:buildModuleDoc"]);
 
   // starts the server
   grunt.registerTask("start", ["shell:start"]);

assets/generated/module-form_builder/icon-16x16.png

@@ -5,16 +5,16 @@
 heading: Modules
 ---
 
-{% for module_info in site.data.modules_list %}
+{% for module_info in site.data.module_list %}
 
   <div class="row">
     <div class="col-lg-1">
-      <span class="icon64x64" style="background-image: {{module_info.icon.64x64}};"></span>
+      <span class="icon48x48" style="background-image: url('../assets/generated/{{module_info.folder}}/{{module_info.icons.48x48}}')"></span>
     </div>
-		<div class="col-lg-3">
-			<a href="{{site.baseurl}}/tutorials/post_form_captchas/">{{module_info.name}}</a>
+		<div class="col-lg-2">
+			<a href="{{module_info.folder}}/">{{module_info.name}}</a>
 		</div>
-		<div class="col-lg-8">
+		<div class="col-lg-9">
       {{module_info.description}}
 		</div>
 	</div>

assets/generated/module-form_builder/icon-32x32.png

@@ -0,0 +1,8 @@
+## Form Builder Documentation
+
+This branch contains the documentation for the Form Builder module.
+
+
+#### How to run
+
+`jekyll serve --watch`