Class: TaskJuggler::UserManual

Inherits:
RichTextDocument show all
Includes:
HTMLElements
Defined in:
lib/taskjuggler/UserManual.rb

Overview

This class specializes the RichTextDocument class for the TaskJuggler user manual. This manual is not only generated from a set of RichTextSnip files, but also contains the SyntaxReference for the TJP syntax.

Instance Attribute Summary

Attributes inherited from RichTextDocument

#functionHandlers

Instance Method Summary collapse

Methods inherited from RichTextDocument

#addSnip, #checkInternalReferences, #registerFunctionHandler

Constructor Details

#initialize ⇒ UserManual

Create a UserManual object and gather the TJP syntax information.



32
33
34
35
36
37
38
 
# File 'lib/taskjuggler/UserManual.rb', line 32

def initialize
  super
  # Don't confuse this with RichTextDocument#references
  @reference = SyntaxReference.new(self)
  registerFunctionHandler(RichTextFunctionExample.new)
  @linkTarget = '_top'
end

Instance Method Details

#generate(directory) ⇒ Object 



40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
 
# File 'lib/taskjuggler/UserManual.rb', line 40

def generate(directory)
  # Directory where to find the manual RichText sources. Must be relative
  # to lib directory.
  srcDir = AppConfig.dataDirs('manual')[0]
  # Directory where to put the generated HTML files. Must be relative to
  # lib directory.
  destDir = directory + (directory[-1] == '/' ? '' : '/')
  # A list of all source files. The order is important.
  %w(
    Intro
    TaskJuggler_2x_Migration
    Reporting_Bugs
    Installation
    How_To_Contribute
    Getting_Started
    Tutorial
    The_TaskJuggler_Syntax
    Rich_Text_Attributes
    List_Attributes
    Software
    Day_To_Day_Juggling
    TaskJuggler_Internals
    fdl
  ).each do |file|
    snip = addSnip(File.join(srcDir, file))
    snip.cssClass = 'manual'
  end
  # Generate the table of contents
  tableOfContents
  # Generate the HTML files.
  generateHTML(destDir)
  checkInternalReferences
  FileUtils.cp_r(AppConfig.dataDirs('data/css')[0], destDir)
end

#generateHTML(directory) ⇒ Object

Generate the manual in HTML format. directory specifies a directory where the HTML files should be put.



77
78
79
80
81
82
83
84
85
 
# File 'lib/taskjuggler/UserManual.rb', line 77

def generateHTML(directory)
  generateHTMLindex(directory)
  generateHTMLReference(directory)
  # The SyntaxReference only generates the reference list when the HTML is
  # generated. So we have to collect it after the HTML generation.
  @references.merge!(@reference.internalReferences)

  super
end

#generateHTMLCover ⇒ Object

Callback function used by the RichTextDocument class to generate the cover page for the manual.



96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
 
# File 'lib/taskjuggler/UserManual.rb', line 96

def generateHTMLCover
  [
    DIV.new('align' => 'center',
            'style' => 'margin-top:40px; margin-botton:40px') do
      [
        H1.new { "The #{AppConfig.softwareName} User Manual" },
        EM.new { 'Project Management beyond Gantt Chart drawing' },
        BR.new,
        B.new do
          "Copyright (c) #{AppConfig.copyright.join(', ')} " +
          "by #{AppConfig.authors.join(', ')}"
        end,
        BR.new,
        "Generated on #{TjTime.new.strftime('%Y-%m-%d')}",
        BR.new,
        H3.new { "This manual covers #{AppConfig.softwareName} " +
                 "version #{AppConfig.version}." }
      ]
    end,
    BR.new,
    HR.new,
    BR.new
  ]
end

#generateHTMLFooter ⇒ Object

Callback function used by the RichTextDocument class to generate the footer for the manual pages.



138
139
140
141
142
143
144
145
146
147
148
149
 
# File 'lib/taskjuggler/UserManual.rb', line 138

def generateHTMLFooter
  DIV.new('align' => 'center', 'style' => 'font-size:10px;') do
    [
      "Copyright (c) #{AppConfig.copyright.join(', ')} by " +
      "#{AppConfig.authors.join(', ')}.",
      A.new('href' => AppConfig.contact) do
        'TaskJuggler'
      end,
      ' is a trademark of Chris Schlaeger.'
    ]
  end
end

#generateHTMLHeader ⇒ Object

Callback function used by the RichTextDocument class to generate the header for the manual pages.



123
124
125
126
127
128
129
130
131
132
133
134
 
# File 'lib/taskjuggler/UserManual.rb', line 123

def generateHTMLHeader
  DIV.new('align' => 'center') do
    [
      H3.new('align' => 'center') do
        "The #{AppConfig.softwareName} User Manual"
      end,
      EM.new('align' => 'center') do
        'Project Management beyond Gantt Chart Drawing'
      end
    ]
  end
end

#generateHTMLindex(directory) ⇒ Object

Generate the top-level file for the HTML user manual.



194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
 
# File 'lib/taskjuggler/UserManual.rb', line 194

def generateHTMLindex(directory)
  html = HTMLDocument.new(:frameset)
  html.generateHead("The #{AppConfig.softwareName} User Manual",
                    { 'description' =>
                      'A reference and user manual for the ' +
                      'TaskJuggler project management software.',
                      'keywords' => 'taskjuggler, manual, reference'})
  html.html << FRAMESET.new('cols' => '15%, 85%') do
    [
      FRAMESET.new('rows' => '140,*') do
        [
          FRAME.new('src' => 'alphabet.html', 'name' => 'alphabet'),
          FRAME.new('src' => 'navbar.html', 'name' => 'navigator')
        ]
      end,
      FRAME.new('src' => 'toc.html', 'name' => 'display')
    ]
  end

  html.write(directory + 'index.html')
end

#generateHTMLNavigationBar(predLabel, predURL, succLabel, succURL) ⇒ Object

Callback function used by the RichTextDocument and KeywordDocumentation classes to generate the navigation bars for the manual pages. predLabel: Text for the reference to the previous page. May be nil. _predURL: URL to the previous page. succLabel: Text for the reference to the next page. May be nil. _succURL: URL to the next page.



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
 
# File 'lib/taskjuggler/UserManual.rb', line 157

def generateHTMLNavigationBar(predLabel, predURL, succLabel, succURL)
  html = [ BR.new, HR.new ]
  if predLabel || succLabel
    # We use a tabel to get the desired layout.
    html += [
      TABLE.new('style' => 'width:90%; margin-left:5%; ' +
                                   'margin-right:5%') do
        TR.new do
          [
            TD.new('style' => 'text-align:left; width:35%;') do
              if predLabel
                # Link to previous page.
                [ '<< ', A.new('href' => predURL) { predLabel }, ' <<' ]
              end
            end,
            # Link to table of contents
            TD.new('style' => 'text-align:center; width:30%;') do
              A.new('href' => 'toc.html') { 'Table Of Contents' }
            end,
            TD.new('style' => 'text-align:right; width:35%;') do
              if succLabel
                # Link to next page.
                [ '>> ', A.new('href' => succURL) { succLabel }, ' >>' ]
              end
            end
          ]
        end
      end,
      HR.new
    ]
  end
  html << BR.new

  html
end

#generateStyleSheet ⇒ Object

Callback function used by the RichTextDocument and KeywordDocumentation classes to generate the HTML style sheet for the manual pages.



89
90
91
92
 
# File 'lib/taskjuggler/UserManual.rb', line 89

def generateStyleSheet
  XMLElement.new('link', 'rel' => 'stylesheet', 'type' => 'text/css',
                         'href' => 'css/tjmanual.css')
end