flak 0.0.1 → 0.0.2

data/lib/flak/thor/templates/doc/content/assets/images/.empty_directory

@@ -0,0 +1 @@
+empty

data/lib/flak/thor/templates/doc/content/assets/movies/.empty_directory

@@ -0,0 +1 @@
+empty

data/lib/flak/thor/templates/doc/content/index.txt.tt

@@ -0,0 +1,31 @@
+---
+## title, author, email, creation time, and description will be set automatically at compile time. 
+## Uncomment the lines below only if you want to override these fields.
+# title: Alternative title
+# author: Someone Else
+# email: someone.else@example.com
+# created_at: <%= Time.now.strftime("%d %B %Y") %>
+# description: Learn how to use this tool.
+---
+h2. <%= name.capitalize %> Module
+
+h4. What is <%= name.capitalize %>? 
+
+A super simple way to convert any file to any other file. 
+
+h4. What Makes <%= name.capitalize %> So Amazing? 
+
+It really works.
+
+h4. What Features are available in this version.
+
+* Convert excel to jpg
+* Convert movies to SQL
+* Convert web pages to any 3d format
+
+See the "release notes":release_notes.html for more features.
+
+Installation is "easy":install_guide.html
+
+
+

data/lib/flak/thor/templates/doc/content/install_guide.txt.tt

@@ -0,0 +1,64 @@
+---
+## author, email, creation time, and description will be set automatically at compile time. 
+## Uncomment the lines below only if you want to override these fields.
+# title: Alternative title
+# author: Someone Else
+# email: someone.else@example.com
+# created_at: <%= Time.now.strftime("%d %B %Y") %>
+# description: Learn how to use this tool.
+type: Install Guide
+---
+
+
+<%% @figure_counter = 1 %>
+
+h3. Introduction
+
+This is an install guide. You can change the meta information, name, email etc. at the top of the original textile file in the doc directory of your module. You can have more than one install guide if you like. Just give them different filenames, like installMac.txt, installLinux.txt etc.
+
+Just like a tutorial, you can add movies and images. So why not go ahead and make a screencast. See the tutorial template for more examples.
+
+
+<hr>
+
+h3. Install on Linux
+
+# Here's an ordered list, good for installation steps
+# Here's an ordered list, good for installation steps
+# Here's an ordered list, good for installation steps
+
+<hr>
+
+h3. Install on Mac
+
+# Here's an ordered list, good for installation steps
+# Here's an ordered list, good for installation steps
+# Here's an ordered list, good for installation steps
+
+<hr>
+
+h3. Install on Windows
+
+# Here's an ordered list, good for installation steps
+# Here's an ordered list, good for installation steps
+# Here's an ordered list, good for installation steps
+
+You can link to other pages in the site with embedded ruby (erb) <%%= link_to( "like this", "tutorial.html") %>. 
+
+Or you can use textile to link to other pages in the site or externally "like this":my_other_page.html or "this":http://www.vfxoverflow.com
+
+
+<hr>
+
+<%%= figure_tag('Image Title', 'You can write a caption here.','images/screenshot.jpg','left') %>
+
+<hr>
+
+The  system is now set up. If you take a look in the outliner you will see magic has been done. When you press play you should see cool stuff.
+
+h3. Another section
+
+h3. Done
+
+
+Have Fun!

data/lib/flak/thor/templates/doc/content/release_notes.txt.tt

@@ -0,0 +1,44 @@
+---
+## author, email, creation time, and description will be set automatically at compile time. 
+## Uncomment the lines below only if you want to override these fields.
+# title: Alternative title
+# author: Someone Else
+# email: someone.else@example.com
+# created_at: <%= Time.now.strftime("%d %B %Y") %>
+# description: Learn how to use this tool.
+type: Release Notes
+---
+
+h2. Release Notes
+
+h3. 0.0.5 - 13 February 2012
+
+h4. fooTool
+* Implemented Viewport2 support.
+* Fixed bug that caused tool to fail to open.
+* Added ability to choose container from any directory above.
+* When bumping version, revision is set to zero.
+* Added buttons to version and revision bump.
+
+h3. 0.0.4 - 9 February 2012
+
+h4. fooTool
+* Added Custom Info functionality to the heads up display and filename generation.
+* Implemented nonsense generation system called Nonsense.
+See "documentation":fooToolTutorial.html
+
+h3. 0.0.3 - 12 December 2011
+
+h4. barTool
+
+* Added runtime command to break a mesh apart based on selected edge loops. 
+See "documentation":barToolTutorial.html
+
+h4. bazTool
+
+* Fixed bug related to exporting shaders from objects with skin clusters.  
+* Fixed bug related to exporting shaders with namespaces.
+* Added ability to remove Ids and assign Ids without exporting.
+* Added detailed logging on import, export and assignment operations.
+* Added Id sanity check.
+See "documentation":bazToolTutorial.html

data/lib/flak/thor/templates/doc/content/scenes/.empty_directory

@@ -0,0 +1 @@
+empty

data/lib/flak/thor/templates/doc/content/tutorial.txt.tt

@@ -0,0 +1,81 @@
+---
+## author, email, creation time, and description will be set automatically at compile time. 
+## Uncomment the lines below only if you want to override these fields.
+# title: Alternative title
+# author: Someone Else
+# email: someone.else@example.com
+# created_at: <%= Time.now.strftime("%d %B %Y") %>
+# description: Learn how to use this tool.
+type: Tutorial
+---
+
+
+<%% @figure_counter = 1 %>
+
+h3. Introduction
+
+This is a tutorial. You can change the meta information, name, email etc. at the top of the original textile file in the doc directory of your module. 
+
+You can add movies and images. There are methods available in the helpers file that make it easy to display movies and images in a consistent manner. Examples are shown below. Save movies in the movies folder and images in the images folder (not the site_images folder)
+
+
+<%%= movie_tag('Movie Title', 'You can write a caption here. The movie must be in webm format','movies/sampleMovie.webm','left') %>
+
+<hr>
+
+
+h3. Get Started
+
+# Here's an ordered list, good for getting started steps
+# Select File -> New
+# Set the time range to 1 - 200.
+# Do stuff.
+# Do more stuff.
+# Hit the magic button.
+# Choose Magic Button->Make it [].
+# Enter the values shown in the screenshot below and click "Apply".
+
+
+
+You can link to other pages in the site with embedded ruby (erb) <%%= link_to( "like this", "tutorial.html") %>. 
+
+Or you can use textile to link to other pages in the site or externally "like this":my_other_page.html or "this":http://www.vfxoverflow.com
+
+
+
+<hr>
+
+<%%= figure_tag('Image Title', 'You can write a caption here.','images/screenshot.jpg','left') %>
+
+<hr>
+
+The  system is now set up. If you take a look in the outliner you will see magic has been done. When you press play you should see cool stuff.
+
+h3. Another section
+
+I refuse to write Lorem Ipsum blahdy blah blah blah.
+
+h4. Advantages over other systems:
+
+* Bullet 1 is fun
+* Bullet 2 is new
+* Bullet 3 for me
+* Bullet 4 doesn't rhyme unfortunately
+
+<hr>
+
+<%%= figure_tag('Image Title', 'How about another image. Notice the figure number auto incremented','images/screenshot.jpg','left') %>
+
+<hr>
+
+You should now see stars.
+
+<hr>
+bq..  *Some technical blurb:*
+Here's some technical blurb. Here's some technical blurb.Here's some technical blurb.Here's some technical blurb.Here's some technical blurb.Here's some technical blurb.Here's some technical blurb.Here's some technical blurb.Here's some technical blurb.Here's some technical blurb.Here's some technical blurb.Here's some technical blurb.Here's some technical blurb.
+
+
+h3. Done
+
+
+Have Fun!

data/lib/flak/thor/templates/doc/layouts/default.html

@@ -0,0 +1,52 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
+	"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en-us">
+<head>
+	<meta http-equiv="content-type" content="text/html; charset=utf-8" />
+	<title><%= @item[:title] %> - <%= @item[:type] %></title>
+	<meta name="author" content="<%= @item[:author] %>" />
+	<link rel="stylesheet" href="css/page.css" type="text/css" media="screen, projection"></link>
+</head>
+<body>
+	<div class="page">
+		<%= create_header %>
+		<%= create_meta %>	
+		<ol id="main_container">
+			<li id="sidebar">	
+				<%= toc %>
+			</li>
+			<li id="body_container">	
+				<%= yield %>
+			</li>	
+		</ol>
+		<%= vfxoverflow_ribbon %>
+		<div id="footer">
+			<ul>
+				<li class="footer_image">
+					 <a href="http://www.mirovideoconverter.com/"><img  src="site_images/miro_logo_bw.png" title="miro video converter" /></a>
+				</li>
+				<li class="footer_image">
+					 <a href="http://www.thefoundry.co.uk/support/"><img  src="site_images/nuke.png" title="nuke support" /></a>
+				</li>
+				<li class="footer_image">
+					 <a href="http://download.autodesk.com/global/docs/maya2012/en_us/index.html"><img  src="site_images/maya.png" title="maya 2012 help" /></a>
+				</li>
+				<li class="footer_image">
+					 <a href="http://www.python.org/about/help/"><img  src="site_images/python.png" title="python help" /></a>
+				</li>
+				<li class="footer_image">
+					 <a href="http://www.chaosgroup.com/en/2/support.html"><img  src="site_images/vray.png" title="vray support" /></a>
+				</li>
+				<li class="footer_image">
+					 <a href="https://renderman.pixar.com/forum/support.php"><img  src="site_images/prman.png" title="renderman support" /></a>
+				</li>
+			</ul>
+
+		</div>
+	</div>
+	
+	
+
+
+</body>
+</html>

data/lib/flak/thor/templates/doc/lib/helpers.rb

@@ -0,0 +1,147 @@
+include Nanoc::Helpers::LinkTo
+
+# Add more types if you need to, for example: Houdini SOP. 
+# Then set the :type field in the yaml section at the top of each help file of that type
+# Those pages will then appear in the sidebar menu
+TYPES = ["Tutorial","Maya Node","Maya Plugin Command","Maya MEL Command","Nuke Node", "Nuke Script"]
+
+MODULE_TYPES = ["Index", "Release Notes", "Install Guide"]
+
+
+
+
+# This helper displays a webm (HTML5) movie in a div with a title and caption. 
+# You can convert quicktime and other formats to webm with
+# Miro Video Converter on Mac. http://blog.getmiro.com/2011/01/miro-video-converter-now-in-the-mac-app-store/
+# For windows and linux you'll have to search. I believe there is also an online converter
+def movie_tag(title,caption,movie,side)
+  body=""
+  body += '<div class="figure '+side+'">'
+  body += "<video controls>" 
+  body +=  '<source src="'  + movie +'" type="video/webm">'  
+  body +=   "Sorry dude, your browser doesn't support HTML5 video. Upgrade already!"  
+  body +=  "</video>"
+  body +='<p class="title">'+title+'</p>'
+  body +='<p class="caption">'+caption+'</p>'
+  body +='</div>'
+end
+
+
+
+
+
+# This helper displays an image in a div with a title and caption. 
+# The image is resized by css if it is too big, however it will be a hyperlink to the full-size image.
+def figure_tag(title,caption,image,side)
+  figure_name = "Figure " + @figure_counter.to_s+'.'
+  @figure_counter+=1
+  body=""
+  body += '<div class="figure '+side+'">'
+  body +=  '<a href="'+image+'"><img  src="'+image+'"  title="'+caption+'" /></a>'
+  # body +='<img alt="Image missing" src="'+image+'" title="'+caption+'"/>'
+  body +='<p class="title">'+figure_name+' '+title+'</p>'
+  body +='<p class="caption">'+caption+'</p>'
+  body +='</div>'
+end
+
+
+
+
+
+
+
+# create one block for the table of contents with the given array of pages and the heading
+def toc_block(pages, heading)
+
+  body =""
+  if pages.length > 0
+    body += '<div class="toc_block">'  
+    body += "<h4>#{heading}</h4>"   
+    body += '<ul>'
+
+    pages.each do |page|
+      unless page == @item
+        body += "<li>"
+        if ( page.identifier == "/") 
+          body += link_to(page[:title] , "index.html") 
+        else
+          body +=  link_to(page[:title] ,  relative_path_to(page)) 
+        end
+      else
+        body += '<li class="current">'
+        body += page[:title] 
+      end
+      body += "</li>"
+    end
+
+    body += '</ul>'  
+    body += '</div>'
+
+  end
+  body
+end
+
+# create markup for the table of contents in the sidebar.
+def toc
+
+  items =  @items.select { |i| (i[:title] != nil)  }
+  body =""
+  sub_pages = items.select { |i|  MODULE_TYPES.include?(i[:type]) }
+
+  body += toc_block(sub_pages, "Module Pages")
+
+  TYPES.each do |type| 
+    sub_pages = items.select  { |i|  i[:type] == type }
+    body +=  toc_block(sub_pages, "#{type}s")
+  end
+
+  body
+end
+
+
+def vfxoverflow_ribbon
+  r = "site_images/vfxoverflow_ribbon.png"
+  body =  '<a href="http://www.vfxoverflow.com/questions/new"><img id="vfxoverflow" src="'+r+'" alt="Ask at VFX Overflow" /></a>'
+end
+
+# create markup for the header header
+def create_header
+  body =  '<div id="header">'
+  r = "site_images/logo.jpg"
+  body +=  '<a href="http://www.reliancemediaworks.com/"><img class="logo" src="'+r+'" alt="logo" /></a>'
+  body += "<h3><b>#{@item[:type]}: </b> #{@item[:title]} </h3>"
+  body += '</div>'  
+end
+
+# create markup for the metadata
+def create_meta
+
+  body = '<div class="meta_container">' 
+
+  @item[:description] = "Please write a description for this page" if @item[:description].nil?
+  body += '<div class="metainfo"><b>Description: </b>' 
+  body +=  @item[:description] 
+  body += '</div>' 
+
+  @item[:email] = "you@example.com"  if @item[:email].nil?
+  @item[:author] = "Your Name"  if @item[:author].nil?
+  body += '<div class="metainfo"><b>Author: </b><a href="mailto:' 
+  body += @item[:email] 
+  body += '">' 
+  body += @item[:author]
+  body +='</a></div>'
+
+
+  body += '<div class="metainfo"><b>Created: </b>' +  @item[:created_at] + '</div>' if (! @item[:created_at].nil?)
+  body += '<div class="metainfo"><b>Keywords: </b>' +  @item[:keywords] + '</div>' if (! @item[:keywords].nil?)
+  body += '<div class="metainfo"><b>Plugin: </b>' +  @item[:plugin] + '</div>' if (! @item[:plugin].nil?)
+  body += '<div class="metainfo"><b>Test Scene: </b>' +  @item[:test_scene] + '</div>' if (!  @item[:test_scene].nil?)
+
+  body += '</div>' 
+
+
+
+end
+
+
+