Top Level Namespace

Includes:
Nanoc::Helpers::LinkTo

Defined Under Namespace

Modules: Flak Classes: Hash, String

Constant Summary collapse

TYPES =

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

["Tutorial","Maya Node","Maya Plugin Command","Maya MEL Command","Nuke Node", "Nuke Script"]
MODULE_TYPES = 
["Index", "Release Notes", "Install Guide"]
LOGOS = 
[
  [ "www.mirovideoconverter.com" , "miro_logo_bw.png", "miro video converter"],
  [ "www.thefoundry.co.uk/support" , "nuke.png", "nuke support"],
  [ "download.autodesk.com/global/docs/maya2012/en_us/index.html" , "maya.png", "maya 2012 help"],
  [ "www.python.org/about/help" , "python.png", "python help"],
  [ "www.chaosgroup.com/en/2/support.html" , "vray.png", "vray support"],
  [ "renderman.pixar.com/forum/support.php" , "prman.png", "renderman support"]
]

Instance Method Summary collapse

Instance Method Details

#create_header ⇒ Object

create markup for the header header



108
109
110
111
112
113
114
115
116
117
118
 
# File 'lib/flak/thor/templates/doc/lib/helpers.rb', line 108

def create_header
  body =  '<div id="header">'

  body +='<ul id="logos">'
  r = "site_images/logo.jpg"
  body +=  '<li><a href="http://www.reliancemediaworks.com/"><img class="logo" src="'+r+'" alt="logo" /></a></li>'
  body +=  '<li><a href="images/module_logo.png"><img class="module_logo" src="images/module_logo.png" /></a></li>'
  body +='</ul>'
  body += "<h3><b>#{@item[:type]}: </b> #{@item[:title]} </h3>"
  body += '</div>'  
end

#create_meta ⇒ Object

create markup for the metadata



121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
 
# File 'lib/flak/thor/templates/doc/lib/helpers.rb', line 121

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] = "[email protected]"  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

#figure_tag(title, caption, image, side) ⇒ Object

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.



35
36
37
38
39
40
41
42
43
44
45
 
# File 'lib/flak/thor/templates/doc/lib/helpers.rb', line 35

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

#footer ⇒ Object 



159
160
161
162
163
164
165
166
167
168
 
# File 'lib/flak/thor/templates/doc/lib/helpers.rb', line 159

def footer
  str = 	'<div id="footer"><ul>'
  arr = LOGOS.collect do ||
    '<li class="footer_image"><a href="http://'+[0]+'"><img  src="site_images/'+ [1]+'" title="'+[2]+'" /></a></li>'
  end
  str += arr.join("\n")
  str += '</ul></div>'
  str

end

#movie_tag(title, caption, movie, side) ⇒ Object

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. 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



17
18
19
20
21
22
23
24
25
26
27
 
# File 'lib/flak/thor/templates/doc/lib/helpers.rb', line 17

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

#toc ⇒ Object

create markup for the table of contents in the sidebar.



85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
 
# File 'lib/flak/thor/templates/doc/lib/helpers.rb', line 85

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

#toc_block(pages, heading) ⇒ Object

create one block for the table of contents with the given array of pages and the heading



54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
 
# File 'lib/flak/thor/templates/doc/lib/helpers.rb', line 54

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

#vfxoverflow_ribbon ⇒ Object 



102
103
104
105
 
# File 'lib/flak/thor/templates/doc/lib/helpers.rb', line 102

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