Method: Capitate::TaskNode#write_doc

Defined in:
lib/capitate/task_node.rb

#write_doc(dir, file_name = nil, title = nil, options = {}, &block) ⇒ Object

Write textile documentation for node (recursively).

Uses task desc attribute for task details.

Options

dir

Dir to write to

file_name

File name to write to, defaults to full name

title

Title and h1 for page, defaults to name

options

Options



103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
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
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
 
# File 'lib/capitate/task_node.rb', line 103

def write_doc(dir, file_name = nil, title = nil, options = {}, &block)
  
  file_name ||= full_name
  title ||= full_name(":")
  
  
  
  path = "#{dir}/#{file_name}.txt"
  puts "%10s %-30s" % [ "create", path ]
  
  File.open(path, "w") do |file|
    file.puts "h1. #{title}\n\n"      
    
    #
    # Breadcrumb generate
    #
    bc_full_name = full_name(":")
    links = []
    if bc_full_name
      names = bc_full_name.split(":")
      links << " #{names.pop} " # Pop off current
      
      while(!names.empty?) do          
        links << %{ "#{names.last}":#{names.join("-")}.html }
        names.pop
      end
    end
    
    # Write breadcrumb
    file.puts %{ "home":../index.html > "recipes":index.html > #{links.reverse.join(" > ")} }
  
    # Write task count
    # count = 0
    # each_node do |snode, level|
    #   count += snode.tasks.length
    # end
    # file.puts %{\n\n*#{count}* tasks!\n\n}
    
    #
    # Namespace
    #
    unless nodes.empty?
      file.puts "\n\nh2. Namespaces\n\n"
      each_node do |snode, level|
        #li_level = (0..level).collect { "*" }.join
        li_level = "*"
        if snode.tasks.length > 0
          file.puts %{#{li_level} "#{snode.full_name(":")}":#{snode.full_name}.html (#{snode.tasks.length}) \n}                  
        end
      end        
    end
    
    #
    # Tasks
    # 
    unless tasks.empty?
      file.puts "\n\nh2. Tasks\n\n"
      sorted_tasks.each do |task|
        file.puts %{* "#{task.fully_qualified_name}":##{task.fully_qualified_name} \n}                  
      end        
    end
    
    #
    # Task details
    #
    unless tasks.empty?
      file.puts "\n\nh2. Task documentation\n\n"        
      sorted_tasks.each do |task|
        file.puts %{<div class="recipe">\n\n}
        options = ""
        options = "<span class='options'>, #{task.options.inspect}</span>" unless task.options.blank?
        file.puts "h3(##{task.fully_qualified_name}). #{task.fully_qualified_name}#{options}\n\n"
        file.puts "#{unindent(task.desc)}\n\n"                    
        file.puts "</div>\n\n\n"
      end
    end
    
    #
    # Write doc (recursively for "child" namespace)
    #
    sorted_nodes.each do |snode|
      snode.write_doc(dir, nil, nil, options)
    end
    
    # If block then let it do stuff with open file
    if block_given?
      file.puts "\n\n"
      yield(file) 
    end      
  end
end