taskjuggler 0.0.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- data/COPYING +280 -0
- data/README +31 -0
- data/Rakefile +20 -0
- data/benchmarks/UTF-8-Strings.rb +58 -0
- data/benchmarks/allocate.tjp +30 -0
- data/benchmarks/booking.tjp +62 -0
- data/benchmarks/depends.tjp +112 -0
- data/benchmarks/htmltaskreport.tjp +45 -0
- data/benchmarks/runbench.rb +24 -0
- data/bin/tj3 +3 -0
- data/bin/tj3man +3 -0
- data/doc/classes/AppConfig.html +808 -0
- data/doc/classes/Arguments.html +226 -0
- data/doc/classes/String.html +395 -0
- data/doc/classes/TaskJuggler.html +1358 -0
- data/doc/classes/TaskJuggler/Account.html +257 -0
- data/doc/classes/TaskJuggler/AccountScenario.html +218 -0
- data/doc/classes/TaskJuggler/Allocation.html +419 -0
- data/doc/classes/TaskJuggler/AllocationAttribute.html +291 -0
- data/doc/classes/TaskJuggler/AttributeBase.html +608 -0
- data/doc/classes/TaskJuggler/AttributeDefinition.html +259 -0
- data/doc/classes/TaskJuggler/Booking.html +307 -0
- data/doc/classes/TaskJuggler/BookingListAttribute.html +263 -0
- data/doc/classes/TaskJuggler/BooleanAttribute.html +261 -0
- data/doc/classes/TaskJuggler/CSVFile.html +325 -0
- data/doc/classes/TaskJuggler/Charge.html +279 -0
- data/doc/classes/TaskJuggler/ChargeListAttribute.html +229 -0
- data/doc/classes/TaskJuggler/ChargeSet.html +440 -0
- data/doc/classes/TaskJuggler/ChargeSetListAttribute.html +276 -0
- data/doc/classes/TaskJuggler/ColumnTable.html +260 -0
- data/doc/classes/TaskJuggler/DateAttribute.html +194 -0
- data/doc/classes/TaskJuggler/DependencyListAttribute.html +267 -0
- data/doc/classes/TaskJuggler/DurationAttribute.html +229 -0
- data/doc/classes/TaskJuggler/FixnumAttribute.html +194 -0
- data/doc/classes/TaskJuggler/FlagListAttribute.html +263 -0
- data/doc/classes/TaskJuggler/FloatAttribute.html +229 -0
- data/doc/classes/TaskJuggler/GanttChart.html +667 -0
- data/doc/classes/TaskJuggler/GanttContainer.html +441 -0
- data/doc/classes/TaskJuggler/GanttHeader.html +280 -0
- data/doc/classes/TaskJuggler/GanttHeaderScaleItem.html +245 -0
- data/doc/classes/TaskJuggler/GanttLine.html +398 -0
- data/doc/classes/TaskJuggler/GanttLoadStack.html +327 -0
- data/doc/classes/TaskJuggler/GanttMilestone.html +415 -0
- data/doc/classes/TaskJuggler/GanttRouter.html +425 -0
- data/doc/classes/TaskJuggler/GanttTaskBar.html +429 -0
- data/doc/classes/TaskJuggler/HTMLDocument.html +240 -0
- data/doc/classes/TaskJuggler/HTMLGraphics.html +231 -0
- data/doc/classes/TaskJuggler/Interval.html +552 -0
- data/doc/classes/TaskJuggler/IntervalListAttribute.html +267 -0
- data/doc/classes/TaskJuggler/KeywordDocumentation.html +796 -0
- data/doc/classes/TaskJuggler/Limits.html +416 -0
- data/doc/classes/TaskJuggler/Limits/Limit.html +381 -0
- data/doc/classes/TaskJuggler/LimitsAttribute.html +261 -0
- data/doc/classes/TaskJuggler/Log.html +613 -0
- data/doc/classes/TaskJuggler/LogicalAttribute.html +226 -0
- data/doc/classes/TaskJuggler/LogicalExpression.html +251 -0
- data/doc/classes/TaskJuggler/LogicalFlag.html +229 -0
- data/doc/classes/TaskJuggler/LogicalFunction.html +324 -0
- data/doc/classes/TaskJuggler/LogicalOperation.html +299 -0
- data/doc/classes/TaskJuggler/Macro.html +194 -0
- data/doc/classes/TaskJuggler/MacroParser.html +360 -0
- data/doc/classes/TaskJuggler/MacroTable.html +366 -0
- data/doc/classes/TaskJuggler/Message.html +281 -0
- data/doc/classes/TaskJuggler/MessageHandler.html +215 -0
- data/doc/classes/TaskJuggler/Project.html +1606 -0
- data/doc/classes/TaskJuggler/ProjectFileParser.html +412 -0
- data/doc/classes/TaskJuggler/PropertyList.html +597 -0
- data/doc/classes/TaskJuggler/PropertySet.html +1200 -0
- data/doc/classes/TaskJuggler/PropertyTreeNode.html +1449 -0
- data/doc/classes/TaskJuggler/Query.html +600 -0
- data/doc/classes/TaskJuggler/RealFormat.html +252 -0
- data/doc/classes/TaskJuggler/ReferenceAttribute.html +194 -0
- data/doc/classes/TaskJuggler/Report.html +528 -0
- data/doc/classes/TaskJuggler/ReportElement.html +1070 -0
- data/doc/classes/TaskJuggler/ReportTable.html +497 -0
- data/doc/classes/TaskJuggler/ReportTableCell.html +518 -0
- data/doc/classes/TaskJuggler/ReportTableColumn.html +364 -0
- data/doc/classes/TaskJuggler/ReportTableElement.html +644 -0
- data/doc/classes/TaskJuggler/ReportTableLegend.html +343 -0
- data/doc/classes/TaskJuggler/ReportTableLine.html +431 -0
- data/doc/classes/TaskJuggler/Resource.html +211 -0
- data/doc/classes/TaskJuggler/ResourceListAttribute.html +267 -0
- data/doc/classes/TaskJuggler/ResourceListRE.html +249 -0
- data/doc/classes/TaskJuggler/ResourceScenario.html +1137 -0
- data/doc/classes/TaskJuggler/RichText.html +537 -0
- data/doc/classes/TaskJuggler/RichTextAttribute.html +229 -0
- data/doc/classes/TaskJuggler/RichTextDocument.html +418 -0
- data/doc/classes/TaskJuggler/RichTextElement.html +829 -0
- data/doc/classes/TaskJuggler/RichTextException.html +212 -0
- data/doc/classes/TaskJuggler/RichTextParser.html +317 -0
- data/doc/classes/TaskJuggler/RichTextProtocolExample.html +303 -0
- data/doc/classes/TaskJuggler/RichTextProtocolHandler.html +194 -0
- data/doc/classes/TaskJuggler/RichTextScanner.html +561 -0
- data/doc/classes/TaskJuggler/RichTextSnip.html +364 -0
- data/doc/classes/TaskJuggler/RichTextSyntaxRules.html +883 -0
- data/doc/classes/TaskJuggler/Scenario.html +163 -0
- data/doc/classes/TaskJuggler/ScenarioData.html +354 -0
- data/doc/classes/TaskJuggler/Scoreboard.html +638 -0
- data/doc/classes/TaskJuggler/Shift.html +255 -0
- data/doc/classes/TaskJuggler/ShiftAssignment.html +488 -0
- data/doc/classes/TaskJuggler/ShiftAssignments.html +715 -0
- data/doc/classes/TaskJuggler/ShiftAssignmentsAttribute.html +261 -0
- data/doc/classes/TaskJuggler/ShiftScenario.html +282 -0
- data/doc/classes/TaskJuggler/SourceFileInfo.html +247 -0
- data/doc/classes/TaskJuggler/StringAttribute.html +229 -0
- data/doc/classes/TaskJuggler/SymbolAttribute.html +194 -0
- data/doc/classes/TaskJuggler/SyntaxReference.html +516 -0
- data/doc/classes/TaskJuggler/TOCEntry.html +242 -0
- data/doc/classes/TaskJuggler/TableColumnDefinition.html +273 -0
- data/doc/classes/TaskJuggler/TableOfContents.html +256 -0
- data/doc/classes/TaskJuggler/Task.html +203 -0
- data/doc/classes/TaskJuggler/TaskDependency.html +251 -0
- data/doc/classes/TaskJuggler/TaskListAttribute.html +267 -0
- data/doc/classes/TaskJuggler/TaskListRE.html +250 -0
- data/doc/classes/TaskJuggler/TaskScenario.html +2206 -0
- data/doc/classes/TaskJuggler/TextParser.html +670 -0
- data/doc/classes/TaskJuggler/TextParser/Pattern.html +923 -0
- data/doc/classes/TaskJuggler/TextParser/Rule.html +779 -0
- data/doc/classes/TaskJuggler/TextParser/StackElement.html +267 -0
- data/doc/classes/TaskJuggler/TextParser/TextParserResultArray.html +212 -0
- data/doc/classes/TaskJuggler/TextParser/TokenDoc.html +221 -0
- data/doc/classes/TaskJuggler/TextScanner.html +708 -0
- data/doc/classes/TaskJuggler/TextScanner/BufferStreamHandle.html +355 -0
- data/doc/classes/TaskJuggler/TextScanner/FileStreamHandle.html +341 -0
- data/doc/classes/TaskJuggler/TextScanner/StreamHandle.html +260 -0
- data/doc/classes/TaskJuggler/TjException.html +185 -0
- data/doc/classes/TaskJuggler/TjTime.html +1845 -0
- data/doc/classes/TaskJuggler/TjpExample.html +310 -0
- data/doc/classes/TaskJuggler/TjpExportRE.html +329 -0
- data/doc/classes/TaskJuggler/TjpSyntaxRules.html +8928 -0
- data/doc/classes/TaskJuggler/UserManual.html +606 -0
- data/doc/classes/TaskJuggler/WorkingHours.html +582 -0
- data/doc/classes/TaskJuggler/WorkingHoursAttribute.html +284 -0
- data/doc/classes/TaskJuggler/XMLBlob.html +207 -0
- data/doc/classes/TaskJuggler/XMLComment.html +206 -0
- data/doc/classes/TaskJuggler/XMLDocument.html +293 -0
- data/doc/classes/TaskJuggler/XMLElement.html +341 -0
- data/doc/classes/TaskJuggler/XMLNamedText.html +174 -0
- data/doc/classes/TaskJuggler/XMLText.html +221 -0
- data/doc/files/COPYING.html +448 -0
- data/doc/files/README.html +134 -0
- data/doc/files/lib/AccountScenario_rb.html +116 -0
- data/doc/files/lib/Account_rb.html +118 -0
- data/doc/files/lib/Allocation_rb.html +118 -0
- data/doc/files/lib/AppConfig_rb.html +116 -0
- data/doc/files/lib/AttributeBase_rb.html +106 -0
- data/doc/files/lib/AttributeDefinition_rb.html +106 -0
- data/doc/files/lib/Attributes_rb.html +130 -0
- data/doc/files/lib/Booking_rb.html +106 -0
- data/doc/files/lib/ChargeSet_rb.html +116 -0
- data/doc/files/lib/Charge_rb.html +116 -0
- data/doc/files/lib/HTMLDocument_rb.html +116 -0
- data/doc/files/lib/Interval_rb.html +116 -0
- data/doc/files/lib/KeywordDocumentation_rb.html +122 -0
- data/doc/files/lib/Limits_rb.html +116 -0
- data/doc/files/lib/Log_rb.html +116 -0
- data/doc/files/lib/LogicalExpression_rb.html +122 -0
- data/doc/files/lib/LogicalFlag_rb.html +116 -0
- data/doc/files/lib/LogicalFunction_rb.html +116 -0
- data/doc/files/lib/LogicalOperation_rb.html +116 -0
- data/doc/files/lib/MacroParser_rb.html +118 -0
- data/doc/files/lib/MacroTable_rb.html +122 -0
- data/doc/files/lib/MessageHandler_rb.html +106 -0
- data/doc/files/lib/Message_rb.html +116 -0
- data/doc/files/lib/ProjectFileParser_rb.html +122 -0
- data/doc/files/lib/Project_rb.html +148 -0
- data/doc/files/lib/PropertyList_rb.html +106 -0
- data/doc/files/lib/PropertySet_rb.html +118 -0
- data/doc/files/lib/PropertyTreeNode_rb.html +106 -0
- data/doc/files/lib/Query_rb.html +116 -0
- data/doc/files/lib/RealFormat_rb.html +106 -0
- data/doc/files/lib/ResourceScenario_rb.html +116 -0
- data/doc/files/lib/Resource_rb.html +118 -0
- data/doc/files/lib/RichTextDocument_rb.html +120 -0
- data/doc/files/lib/RichTextElement_rb.html +120 -0
- data/doc/files/lib/RichTextParser_rb.html +120 -0
- data/doc/files/lib/RichTextProtocolExample_rb.html +120 -0
- data/doc/files/lib/RichTextProtocolHandler_rb.html +106 -0
- data/doc/files/lib/RichTextScanner_rb.html +116 -0
- data/doc/files/lib/RichTextSnip_rb.html +118 -0
- data/doc/files/lib/RichTextSyntaxRules_rb.html +106 -0
- data/doc/files/lib/RichText_rb.html +118 -0
- data/doc/files/lib/ScenarioData_rb.html +118 -0
- data/doc/files/lib/Scenario_rb.html +116 -0
- data/doc/files/lib/Scoreboard_rb.html +106 -0
- data/doc/files/lib/ShiftAssignments_rb.html +116 -0
- data/doc/files/lib/ShiftScenario_rb.html +116 -0
- data/doc/files/lib/Shift_rb.html +118 -0
- data/doc/files/lib/SourceFileInfo_rb.html +106 -0
- data/doc/files/lib/SyntaxReference_rb.html +122 -0
- data/doc/files/lib/TOCEntry_rb.html +118 -0
- data/doc/files/lib/TableColumnDefinition_rb.html +106 -0
- data/doc/files/lib/TableOfContents_rb.html +118 -0
- data/doc/files/lib/TaskDependency_rb.html +106 -0
- data/doc/files/lib/TaskJuggler_rb.html +120 -0
- data/doc/files/lib/TaskScenario_rb.html +116 -0
- data/doc/files/lib/Task_rb.html +118 -0
- data/doc/files/lib/TextParser/Pattern_rb.html +116 -0
- data/doc/files/lib/TextParser/Rule_rb.html +106 -0
- data/doc/files/lib/TextParser/StackElement_rb.html +106 -0
- data/doc/files/lib/TextParser/TokenDoc_rb.html +106 -0
- data/doc/files/lib/TextParser_rb.html +124 -0
- data/doc/files/lib/TextScanner_rb.html +128 -0
- data/doc/files/lib/Tj3Config_rb.html +118 -0
- data/doc/files/lib/TjException_rb.html +106 -0
- data/doc/files/lib/TjTime_rb.html +118 -0
- data/doc/files/lib/TjpExample_rb.html +116 -0
- data/doc/files/lib/TjpSyntaxRules_rb.html +106 -0
- data/doc/files/lib/UTF8String_rb.html +132 -0
- data/doc/files/lib/UserManual_rb.html +124 -0
- data/doc/files/lib/WorkingHours_rb.html +116 -0
- data/doc/files/lib/XMLDocument_rb.html +116 -0
- data/doc/files/lib/XMLElement_rb.html +116 -0
- data/doc/files/lib/reports/CSVFile_rb.html +116 -0
- data/doc/files/lib/reports/ColumnTable_rb.html +116 -0
- data/doc/files/lib/reports/GanttChart_rb.html +122 -0
- data/doc/files/lib/reports/GanttContainer_rb.html +116 -0
- data/doc/files/lib/reports/GanttHeaderScaleItem_rb.html +106 -0
- data/doc/files/lib/reports/GanttHeader_rb.html +116 -0
- data/doc/files/lib/reports/GanttLine_rb.html +126 -0
- data/doc/files/lib/reports/GanttLoadStack_rb.html +116 -0
- data/doc/files/lib/reports/GanttMilestone_rb.html +116 -0
- data/doc/files/lib/reports/GanttRouter_rb.html +106 -0
- data/doc/files/lib/reports/GanttTaskBar_rb.html +116 -0
- data/doc/files/lib/reports/HTMLGraphics_rb.html +106 -0
- data/doc/files/lib/reports/ReportElement_rb.html +118 -0
- data/doc/files/lib/reports/ReportTableCell_rb.html +106 -0
- data/doc/files/lib/reports/ReportTableColumn_rb.html +106 -0
- data/doc/files/lib/reports/ReportTableElement_rb.html +122 -0
- data/doc/files/lib/reports/ReportTableLegend_rb.html +106 -0
- data/doc/files/lib/reports/ReportTableLine_rb.html +116 -0
- data/doc/files/lib/reports/ReportTable_rb.html +118 -0
- data/doc/files/lib/reports/Report_rb.html +126 -0
- data/doc/files/lib/reports/ResourceListRE_rb.html +122 -0
- data/doc/files/lib/reports/TaskListRE_rb.html +122 -0
- data/doc/files/lib/reports/TjpExportRE_rb.html +116 -0
- data/doc/files/lib/taskjuggler3_rb.html +276 -0
- data/doc/files/lib/tj3man_rb.html +189 -0
- data/doc/fr_class_index.html +285 -0
- data/doc/fr_file_index.html +223 -0
- data/doc/fr_method_index.html +1953 -0
- data/doc/index.html +21 -0
- data/doc/rdoc-style.css +299 -0
- data/examples/tutorial.tjp +361 -0
- data/gem_spec.rb +30 -0
- data/lib/Account.rb +50 -0
- data/lib/AccountScenario.rb +39 -0
- data/lib/Allocation.rb +102 -0
- data/lib/AppConfig.rb +134 -0
- data/lib/AttributeBase.rb +131 -0
- data/lib/AttributeDefinition.rb +47 -0
- data/lib/Attributes.rb +478 -0
- data/lib/BatchProcessor.rb +209 -0
- data/lib/Booking.rb +59 -0
- data/lib/Charge.rb +71 -0
- data/lib/ChargeSet.rb +126 -0
- data/lib/HTMLDocument.rb +59 -0
- data/lib/Interval.rb +127 -0
- data/lib/KeywordDocumentation.rb +560 -0
- data/lib/Limits.rb +219 -0
- data/lib/Log.rb +160 -0
- data/lib/LogicalExpression.rb +71 -0
- data/lib/LogicalFlag.rb +34 -0
- data/lib/LogicalFunction.rb +102 -0
- data/lib/LogicalOperation.rb +118 -0
- data/lib/MacroParser.rb +77 -0
- data/lib/MacroTable.rb +84 -0
- data/lib/Message.rb +56 -0
- data/lib/MessageHandler.rb +34 -0
- data/lib/Project.rb +662 -0
- data/lib/ProjectFileParser.rb +333 -0
- data/lib/PropertyList.rb +181 -0
- data/lib/PropertySet.rb +304 -0
- data/lib/PropertyTreeNode.rb +461 -0
- data/lib/Query.rb +227 -0
- data/lib/RealFormat.rb +73 -0
- data/lib/Resource.rb +42 -0
- data/lib/ResourceScenario.rb +511 -0
- data/lib/RichText.rb +147 -0
- data/lib/RichTextDocument.rb +139 -0
- data/lib/RichTextElement.rb +391 -0
- data/lib/RichTextParser.rb +66 -0
- data/lib/RichTextProtocolExample.rb +65 -0
- data/lib/RichTextProtocolHandler.rb +35 -0
- data/lib/RichTextScanner.rb +390 -0
- data/lib/RichTextSnip.rb +104 -0
- data/lib/RichTextSyntaxRules.rb +265 -0
- data/lib/Scenario.rb +27 -0
- data/lib/ScenarioData.rb +65 -0
- data/lib/Scoreboard.rb +141 -0
- data/lib/Shift.rb +48 -0
- data/lib/ShiftAssignments.rb +291 -0
- data/lib/ShiftScenario.rb +46 -0
- data/lib/SourceFileInfo.rb +37 -0
- data/lib/SyntaxReference.rb +284 -0
- data/lib/TOCEntry.rb +76 -0
- data/lib/TableColumnDefinition.rb +54 -0
- data/lib/TableOfContents.rb +46 -0
- data/lib/Task.rb +37 -0
- data/lib/TaskDependency.rb +39 -0
- data/lib/TaskJuggler.rb +84 -0
- data/lib/TaskScenario.rb +1622 -0
- data/lib/TextParser.rb +416 -0
- data/lib/TextParser/Pattern.rb +263 -0
- data/lib/TextParser/Rule.rb +171 -0
- data/lib/TextParser/StackElement.rb +45 -0
- data/lib/TextParser/TokenDoc.rb +38 -0
- data/lib/TextScanner.rb +682 -0
- data/lib/Tj3Config.rb +27 -0
- data/lib/TjException.rb +27 -0
- data/lib/TjTime.rb +395 -0
- data/lib/TjpExample.rb +119 -0
- data/lib/TjpSyntaxRules.rb +4022 -0
- data/lib/UTF8String.rb +100 -0
- data/lib/UserManual.rb +282 -0
- data/lib/WorkingHours.rb +323 -0
- data/lib/XMLDocument.rb +54 -0
- data/lib/XMLElement.rb +175 -0
- data/lib/reports/CSVFile.rb +146 -0
- data/lib/reports/ColumnTable.rb +66 -0
- data/lib/reports/GanttChart.rb +308 -0
- data/lib/reports/GanttContainer.rb +107 -0
- data/lib/reports/GanttHeader.rb +141 -0
- data/lib/reports/GanttHeaderScaleItem.rb +42 -0
- data/lib/reports/GanttLine.rb +329 -0
- data/lib/reports/GanttLoadStack.rb +113 -0
- data/lib/reports/GanttMilestone.rb +80 -0
- data/lib/reports/GanttRouter.rb +375 -0
- data/lib/reports/GanttTaskBar.rb +95 -0
- data/lib/reports/HTMLGraphics.rb +65 -0
- data/lib/reports/Report.rb +344 -0
- data/lib/reports/ReportElement.rb +427 -0
- data/lib/reports/ReportTable.rb +144 -0
- data/lib/reports/ReportTableCell.rb +142 -0
- data/lib/reports/ReportTableColumn.rb +82 -0
- data/lib/reports/ReportTableElement.rb +852 -0
- data/lib/reports/ReportTableLegend.rb +167 -0
- data/lib/reports/ReportTableLine.rb +87 -0
- data/lib/reports/ResourceListRE.rb +72 -0
- data/lib/reports/TaskListRE.rb +73 -0
- data/lib/reports/TjpExportRE.rb +394 -0
- data/lib/taskjuggler3.rb +106 -0
- data/lib/tj3man.rb +88 -0
- data/manual/Day_To_Day_Juggling +168 -0
- data/manual/Getting_Started +61 -0
- data/manual/How_To_Contribute +185 -0
- data/manual/Installation +68 -0
- data/manual/Intro +102 -0
- data/manual/Reporting_Bugs +26 -0
- data/manual/Rich_Text_Attributes +90 -0
- data/manual/TaskJuggler_2x_Migration +40 -0
- data/manual/Tutorial +579 -0
- data/manual/fdl +450 -0
- data/prj_cfg.rb +43 -0
- data/setup.rb +1585 -0
- data/tasks/csts.rake +72 -0
- data/tasks/gem.rake +14 -0
- data/tasks/manual.rake +10 -0
- data/tasks/missing.rake +21 -0
- data/tasks/rcov.rake +14 -0
- data/tasks/rdoc.rake +17 -0
- data/tasks/rexml_fix.rb +16 -0
- data/tasks/rexml_fix_19.rb +49 -0
- data/tasks/show.rake +21 -0
- data/tasks/stats.rake +25 -0
- data/tasks/test.rake +11 -0
- data/test/MessageChecker.rb +53 -0
- data/test/TestSuite/CSV-Reports/celltext-Reference.csv +14 -0
- data/test/TestSuite/CSV-Reports/celltext.tjp +7 -0
- data/test/TestSuite/CSV-Reports/genrefs +6 -0
- data/test/TestSuite/CSV-Reports/project-1.tji +57 -0
- data/test/TestSuite/CSV-Reports/resourcereport-Reference.csv +4 -0
- data/test/TestSuite/CSV-Reports/resourcereport.tjp +10 -0
- data/test/TestSuite/CSV-Reports/resourcereport_with_tasks-Reference.csv +22 -0
- data/test/TestSuite/CSV-Reports/resourcereport_with_tasks.tjp +11 -0
- data/test/TestSuite/CSV-Reports/sortByTree-Reference.csv +14 -0
- data/test/TestSuite/CSV-Reports/sortByTree.tjp +8 -0
- data/test/TestSuite/CSV-Reports/sortBy_duration.down-Reference.csv +14 -0
- data/test/TestSuite/CSV-Reports/sortBy_duration.down.tjp +10 -0
- data/test/TestSuite/CSV-Reports/sortBy_effort.up-Reference.csv +14 -0
- data/test/TestSuite/CSV-Reports/sortBy_effort.up.tjp +10 -0
- data/test/TestSuite/CSV-Reports/sortBy_plan.start.down-Reference.csv +14 -0
- data/test/TestSuite/CSV-Reports/sortBy_plan.start.down.tjp +10 -0
- data/test/TestSuite/CSV-Reports/taskreport-Reference.csv +14 -0
- data/test/TestSuite/CSV-Reports/taskreport.tjp +10 -0
- data/test/TestSuite/CSV-Reports/taskreport_with_resources-Reference.csv +24 -0
- data/test/TestSuite/CSV-Reports/taskreport_with_resources.tjp +11 -0
- data/test/TestSuite/Scheduler/Correct/Allocate.tjp +86 -0
- data/test/TestSuite/Scheduler/Correct/AutomaticMilestones.tjp +63 -0
- data/test/TestSuite/Scheduler/Correct/Booking.tjp +161 -0
- data/test/TestSuite/Scheduler/Correct/Depends.tjp +50 -0
- data/test/TestSuite/Scheduler/Correct/Duration.tjp +34 -0
- data/test/TestSuite/Scheduler/Correct/InheritStartEnd.tjp +129 -0
- data/test/TestSuite/Scheduler/Correct/Limits.tjp +81 -0
- data/test/TestSuite/Scheduler/Correct/MultipleMandatories.tjp +43 -0
- data/test/TestSuite/Scheduler/Correct/Optimize-1.tjp +28 -0
- data/test/TestSuite/Scheduler/Correct/Optimize-2.tjp +33 -0
- data/test/TestSuite/Scheduler/Correct/Optimize-3.tjp +33 -0
- data/test/TestSuite/Scheduler/Correct/Optimize-4.tjp +34 -0
- data/test/TestSuite/Scheduler/Correct/Optimize-5.tjp +62 -0
- data/test/TestSuite/Scheduler/Correct/Precedes.tjp +50 -0
- data/test/TestSuite/Scheduler/Correct/Shift.tjp +102 -0
- data/test/TestSuite/Scheduler/Errors/account_no_leaf.tjp +13 -0
- data/test/TestSuite/Scheduler/Errors/booking_conflict.tjp +10 -0
- data/test/TestSuite/Scheduler/Errors/booking_no_duty.tjp +9 -0
- data/test/TestSuite/Scheduler/Errors/booking_on_vacation.tjp +9 -0
- data/test/TestSuite/Scheduler/Errors/container_booking.tjp +14 -0
- data/test/TestSuite/Scheduler/Errors/container_duration.tjp +11 -0
- data/test/TestSuite/Scheduler/Errors/effort_no_allocations.tjp +7 -0
- data/test/TestSuite/Scheduler/Errors/loop_detected_1.tjp +19 -0
- data/test/TestSuite/Scheduler/Errors/loop_detected_10.tjp +36 -0
- data/test/TestSuite/Scheduler/Errors/loop_detected_11.tjp +27 -0
- data/test/TestSuite/Scheduler/Errors/loop_detected_12.tjp +20 -0
- data/test/TestSuite/Scheduler/Errors/loop_detected_13.tjp +27 -0
- data/test/TestSuite/Scheduler/Errors/loop_detected_14.tjp +26 -0
- data/test/TestSuite/Scheduler/Errors/loop_detected_2.tjp +24 -0
- data/test/TestSuite/Scheduler/Errors/loop_detected_3.tjp +18 -0
- data/test/TestSuite/Scheduler/Errors/loop_detected_4.tjp +36 -0
- data/test/TestSuite/Scheduler/Errors/loop_detected_5.tjp +37 -0
- data/test/TestSuite/Scheduler/Errors/loop_detected_6.tjp +35 -0
- data/test/TestSuite/Scheduler/Errors/loop_detected_7.tjp +46 -0
- data/test/TestSuite/Scheduler/Errors/loop_detected_8.tjp +51 -0
- data/test/TestSuite/Scheduler/Errors/loop_detected_9.tjp +20 -0
- data/test/TestSuite/Scheduler/Errors/maxend.tjp +8 -0
- data/test/TestSuite/Scheduler/Errors/maxstart.tjp +8 -0
- data/test/TestSuite/Scheduler/Errors/milestone_booking.tjp +10 -0
- data/test/TestSuite/Scheduler/Errors/milestone_duration.tjp +8 -0
- data/test/TestSuite/Scheduler/Errors/milestone_start_end.tjp +8 -0
- data/test/TestSuite/Scheduler/Errors/minend.tjp +8 -0
- data/test/TestSuite/Scheduler/Errors/minstart.tjp +8 -0
- data/test/TestSuite/Scheduler/Errors/multiple_durations.tjp +11 -0
- data/test/TestSuite/Scheduler/Errors/no_tasks.tjp +6 -0
- data/test/TestSuite/Scheduler/Errors/not_scheduled.tjp +8 -0
- data/test/TestSuite/Scheduler/Errors/task_depend_child.tjp +10 -0
- data/test/TestSuite/Scheduler/Errors/task_depend_multi.tjp +13 -0
- data/test/TestSuite/Scheduler/Errors/task_depend_parent.tjp +11 -0
- data/test/TestSuite/Scheduler/Errors/task_depend_self.tjp +10 -0
- data/test/TestSuite/Scheduler/Errors/task_depend_unknown.tjp +10 -0
- data/test/TestSuite/Scheduler/Errors/task_overspecified_1.tjp +9 -0
- data/test/TestSuite/Scheduler/Errors/task_overspecified_2.tjp +14 -0
- data/test/TestSuite/Scheduler/Errors/task_overspecified_3.tjp +14 -0
- data/test/TestSuite/Scheduler/Errors/task_underspecified_1.tjp +8 -0
- data/test/TestSuite/Scheduler/Errors/task_underspecified_2.tjp +8 -0
- data/test/TestSuite/Scheduler/Errors/task_underspecified_3.tjp +9 -0
- data/test/TestSuite/Syntax/Correct/Account.tjp +53 -0
- data/test/TestSuite/Syntax/Correct/Allocate-1.tjp +24 -0
- data/test/TestSuite/Syntax/Correct/Alternative.tjp +13 -0
- data/test/TestSuite/Syntax/Correct/AutoMacros.tjp +14 -0
- data/test/TestSuite/Syntax/Correct/Booking.tjp +26 -0
- data/test/TestSuite/Syntax/Correct/Caption.tjp +33 -0
- data/test/TestSuite/Syntax/Correct/Celltext.tjp +28 -0
- data/test/TestSuite/Syntax/Correct/Comments.tjp +29 -0
- data/test/TestSuite/Syntax/Correct/Complete.tjp +16 -0
- data/test/TestSuite/Syntax/Correct/CompletedWork.tji +20 -0
- data/test/TestSuite/Syntax/Correct/CriticalPath.tjp +31 -0
- data/test/TestSuite/Syntax/Correct/Currencyformat.tjp +12 -0
- data/test/TestSuite/Syntax/Correct/CustomAttributes.tjp +14 -0
- data/test/TestSuite/Syntax/Correct/Depends1.tjp +22 -0
- data/test/TestSuite/Syntax/Correct/Durations.tjp +29 -0
- data/test/TestSuite/Syntax/Correct/Efficiency.tjp +19 -0
- data/test/TestSuite/Syntax/Correct/Export.tjp +40 -0
- data/test/TestSuite/Syntax/Correct/Flags.tjp +32 -0
- data/test/TestSuite/Syntax/Correct/Freeze.tjp +28 -0
- data/test/TestSuite/Syntax/Correct/Gap.tjp +15 -0
- data/test/TestSuite/Syntax/Correct/HtmlTaskReport.tjp +33 -0
- data/test/TestSuite/Syntax/Correct/Limits-1.tjp +71 -0
- data/test/TestSuite/Syntax/Correct/LoadUnits.tjp +31 -0
- data/test/TestSuite/Syntax/Correct/Macro-1.tjp +19 -0
- data/test/TestSuite/Syntax/Correct/Mandatory.tjp +17 -0
- data/test/TestSuite/Syntax/Correct/Milestone.tjp +12 -0
- data/test/TestSuite/Syntax/Correct/MinMax.tjp +17 -0
- data/test/TestSuite/Syntax/Correct/Numberformat.tjp +12 -0
- data/test/TestSuite/Syntax/Correct/Period.tjp +16 -0
- data/test/TestSuite/Syntax/Correct/Persistent.tjp +11 -0
- data/test/TestSuite/Syntax/Correct/Precedes1.tjp +17 -0
- data/test/TestSuite/Syntax/Correct/Priority.tjp +30 -0
- data/test/TestSuite/Syntax/Correct/Project.tjp +21 -0
- data/test/TestSuite/Syntax/Correct/ProjectIDs.tjp +23 -0
- data/test/TestSuite/Syntax/Correct/RawHTML.tjp +29 -0
- data/test/TestSuite/Syntax/Correct/Reports.tjp +54 -0
- data/test/TestSuite/Syntax/Correct/Resource.tjp +20 -0
- data/test/TestSuite/Syntax/Correct/Responsible.tjp +16 -0
- data/test/TestSuite/Syntax/Correct/Scenario.tjp +15 -0
- data/test/TestSuite/Syntax/Correct/Scheduling.tjp +26 -0
- data/test/TestSuite/Syntax/Correct/Select.tjp +27 -0
- data/test/TestSuite/Syntax/Correct/Shift.tjp +55 -0
- data/test/TestSuite/Syntax/Correct/Simple.tjp +25 -0
- data/test/TestSuite/Syntax/Correct/String.tjp +12 -0
- data/test/TestSuite/Syntax/Correct/Supplement.tjp +24 -0
- data/test/TestSuite/Syntax/Correct/TaskRoot.tjp +34 -0
- data/test/TestSuite/Syntax/Correct/TimeFrame.tjp +19 -0
- data/test/TestSuite/Syntax/Correct/Timezone.tjp +8 -0
- data/test/TestSuite/Syntax/Correct/Vacation.tjp +33 -0
- data/test/TestSuite/Syntax/Correct/csvtest +16 -0
- data/test/TestSuite/Syntax/Correct/manual2example.rb +24 -0
- data/test/TestSuite/Syntax/Correct/tutorial.tjp +485 -0
- data/test/TestSuite/Syntax/Errors/bad_include.tjp +11 -0
- data/test/TestSuite/Syntax/Errors/booking_group.tjp +14 -0
- data/test/TestSuite/Syntax/Errors/booking_milestone.tjp +13 -0
- data/test/TestSuite/Syntax/Errors/booking_no_leaf.tjp +13 -0
- data/test/TestSuite/Syntax/Errors/chargeset.tjp +14 -0
- data/test/TestSuite/Syntax/Errors/chargeset_master.tjp +15 -0
- data/test/TestSuite/Syntax/Errors/container_attribute.tjp +13 -0
- data/test/TestSuite/Syntax/Errors/cost_acct_no_top.tjp +24 -0
- data/test/TestSuite/Syntax/Errors/cost_rev_same.tjp +24 -0
- data/test/TestSuite/Syntax/Errors/date_in_range.tjp +7 -0
- data/test/TestSuite/Syntax/Errors/effort_zero.tjp +8 -0
- data/test/TestSuite/Syntax/Errors/empty.tjp +1 -0
- data/test/TestSuite/Syntax/Errors/export_bad_extn.tjp +9 -0
- data/test/TestSuite/Syntax/Errors/extend_id_cap.tjp +7 -0
- data/test/TestSuite/Syntax/Errors/interval_end_in_range.tjp +7 -0
- data/test/TestSuite/Syntax/Errors/interval_start_in_range.tjp +7 -0
- data/test/TestSuite/Syntax/Errors/leaf_resource_id_expected.tjp +12 -0
- data/test/TestSuite/Syntax/Errors/misaligned_date.tjp +7 -0
- data/test/TestSuite/Syntax/Errors/no_csv_suffix.tjp +10 -0
- data/test/TestSuite/Syntax/Errors/no_html_suffix.tjp +10 -0
- data/test/TestSuite/Syntax/Errors/operand_attribute.tjp +11 -0
- data/test/TestSuite/Syntax/Errors/operand_unkn_flag.tjp +11 -0
- data/test/TestSuite/Syntax/Errors/operand_unkn_scen.tjp +11 -0
- data/test/TestSuite/Syntax/Errors/overtime_range.tjp +13 -0
- data/test/TestSuite/Syntax/Errors/purge_no_list.tjp +8 -0
- data/test/TestSuite/Syntax/Errors/purge_unknown_id.tjp +8 -0
- data/test/TestSuite/Syntax/Errors/report_end.tjp +10 -0
- data/test/TestSuite/Syntax/Errors/report_redifinition.tjp +10 -0
- data/test/TestSuite/Syntax/Errors/report_start.tjp +10 -0
- data/test/TestSuite/Syntax/Errors/resource_exists.tjp +7 -0
- data/test/TestSuite/Syntax/Errors/resource_id_expected.tjp +8 -0
- data/test/TestSuite/Syntax/Errors/rev_acct_no_top.tjp +24 -0
- data/test/TestSuite/Syntax/Errors/scenario_exists.tjp +7 -0
- data/test/TestSuite/Syntax/Errors/shift_assignment_overlap.tjp +15 -0
- data/test/TestSuite/Syntax/Errors/shift_exists.tjp +7 -0
- data/test/TestSuite/Syntax/Errors/shift_id_expected.tjp +7 -0
- data/test/TestSuite/Syntax/Errors/sloppy_range.tjp +13 -0
- data/test/TestSuite/Syntax/Errors/sort_direction.tjp +11 -0
- data/test/TestSuite/Syntax/Errors/sort_unknown_scen.tjp +11 -0
- data/test/TestSuite/Syntax/Errors/sorting_crit_exptd1.tjp +11 -0
- data/test/TestSuite/Syntax/Errors/sorting_crit_exptd2.tjp +11 -0
- data/test/TestSuite/Syntax/Errors/sorting_wbs.tjp +11 -0
- data/test/TestSuite/Syntax/Errors/start_before_end1.tjp +7 -0
- data/test/TestSuite/Syntax/Errors/start_before_end2.tjp +6 -0
- data/test/TestSuite/Syntax/Errors/task_complete.tjp +8 -0
- data/test/TestSuite/Syntax/Errors/task_exists.tjp +7 -0
- data/test/TestSuite/Syntax/Errors/task_priority.tjp +8 -0
- data/test/TestSuite/Syntax/Errors/task_without_chargeset.tjp +9 -0
- data/test/TestSuite/Syntax/Errors/time_interval.tjp +12 -0
- data/test/TestSuite/Syntax/Errors/too_many_bangs.tjp +10 -0
- data/test/TestSuite/Syntax/Errors/undecl_flag.tjp +6 -0
- data/test/TestSuite/Syntax/Errors/unknown_projectid.tjp +7 -0
- data/test/TestSuite/Syntax/Errors/unknown_scenario_id.tjp +6 -0
- data/test/TestSuite/Syntax/Errors/unknown_scenario_idx.tjp +11 -0
- data/test/TestSuite/Syntax/Errors/unknown_task.tjp +10 -0
- data/test/all.rb +31 -0
- data/test/test_BatchProcessor.rb +54 -0
- data/test/test_CSV-Reports.rb +101 -0
- data/test/test_Limits.rb +104 -0
- data/test/test_LogicalExpression.rb +110 -0
- data/test/test_MacroTable.rb +51 -0
- data/test/test_Project.rb +57 -0
- data/test/test_PropertySet.rb +71 -0
- data/test/test_Query.rb +83 -0
- data/test/test_RealFormat.rb +83 -0
- data/test/test_RichText.rb +869 -0
- data/test/test_Scheduler.rb +42 -0
- data/test/test_ShiftAssignments.rb +77 -0
- data/test/test_Syntax.rb +41 -0
- data/test/test_TextScanner.rb +95 -0
- data/test/test_TjTime.rb +114 -0
- data/test/test_TjpExample.rb +169 -0
- data/test/test_UTF8String.rb +84 -0
- data/test/test_WorkingHours.rb +56 -0
- metadata +649 -0
|
@@ -0,0 +1,606 @@
|
|
|
1
|
+
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
|
|
2
|
+
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
|
|
3
|
+
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
|
|
4
|
+
<head>
|
|
5
|
+
<title>Class: TaskJuggler::UserManual [TaskJuggler III API documentation]</title>
|
|
6
|
+
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
|
7
|
+
<meta http-equiv="Content-Script-Type" content="text/javascript" />
|
|
8
|
+
<link rel="stylesheet" href="../.././rdoc-style.css" type="text/css" media="screen" />
|
|
9
|
+
<script type="text/javascript">
|
|
10
|
+
// <![CDATA[
|
|
11
|
+
|
|
12
|
+
function popupCode( url ) {
|
|
13
|
+
window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
|
|
14
|
+
}
|
|
15
|
+
|
|
16
|
+
function toggleCode( id ) {
|
|
17
|
+
if ( document.getElementById )
|
|
18
|
+
elem = document.getElementById( id );
|
|
19
|
+
else if ( document.all )
|
|
20
|
+
elem = eval( "document.all." + id );
|
|
21
|
+
else
|
|
22
|
+
return false;
|
|
23
|
+
|
|
24
|
+
elemStyle = elem.style;
|
|
25
|
+
|
|
26
|
+
if ( elemStyle.display != "block" ) {
|
|
27
|
+
elemStyle.display = "block"
|
|
28
|
+
} else {
|
|
29
|
+
elemStyle.display = "none"
|
|
30
|
+
}
|
|
31
|
+
|
|
32
|
+
return true;
|
|
33
|
+
}
|
|
34
|
+
|
|
35
|
+
// Make codeblocks hidden by default
|
|
36
|
+
document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }<\/style>" )
|
|
37
|
+
|
|
38
|
+
// ]]>
|
|
39
|
+
</script>
|
|
40
|
+
|
|
41
|
+
</head>
|
|
42
|
+
<body>
|
|
43
|
+
|
|
44
|
+
|
|
45
|
+
<div id="classHeader">
|
|
46
|
+
<table class="header-table">
|
|
47
|
+
<tr class="top-aligned-row">
|
|
48
|
+
<td><strong>Class</strong></td>
|
|
49
|
+
<td class="class-name-in-header">TaskJuggler::UserManual</td>
|
|
50
|
+
</tr>
|
|
51
|
+
<tr class="top-aligned-row">
|
|
52
|
+
<td><strong>In:</strong></td>
|
|
53
|
+
<td>
|
|
54
|
+
|
|
55
|
+
|
|
56
|
+
<a href="../../files/lib/UserManual_rb.html">
|
|
57
|
+
|
|
58
|
+
lib/UserManual.rb
|
|
59
|
+
|
|
60
|
+
</a>
|
|
61
|
+
|
|
62
|
+
|
|
63
|
+
<br />
|
|
64
|
+
|
|
65
|
+
</td>
|
|
66
|
+
</tr>
|
|
67
|
+
|
|
68
|
+
|
|
69
|
+
<tr class="top-aligned-row">
|
|
70
|
+
<td><strong>Parent:</strong></td>
|
|
71
|
+
<td>
|
|
72
|
+
|
|
73
|
+
<a href="RichTextDocument.html">
|
|
74
|
+
|
|
75
|
+
TaskJuggler::RichTextDocument
|
|
76
|
+
|
|
77
|
+
</a>
|
|
78
|
+
|
|
79
|
+
</td>
|
|
80
|
+
</tr>
|
|
81
|
+
|
|
82
|
+
</table>
|
|
83
|
+
</div>
|
|
84
|
+
<!-- banner header -->
|
|
85
|
+
|
|
86
|
+
<div id="bodyContent">
|
|
87
|
+
|
|
88
|
+
<div id="contextContent">
|
|
89
|
+
|
|
90
|
+
<div id="description">
|
|
91
|
+
<p>
|
|
92
|
+
This class specializes the <a
|
|
93
|
+
href="RichTextDocument.html">RichTextDocument</a> class for the <a
|
|
94
|
+
href="../TaskJuggler.html">TaskJuggler</a> user manual. This manual is not
|
|
95
|
+
only generated from a set of <a href="RichTextSnip.html">RichTextSnip</a>
|
|
96
|
+
files, but also contains the <a
|
|
97
|
+
href="SyntaxReference.html">SyntaxReference</a> for the TJP syntax.
|
|
98
|
+
</p>
|
|
99
|
+
|
|
100
|
+
</div>
|
|
101
|
+
|
|
102
|
+
</div>
|
|
103
|
+
|
|
104
|
+
|
|
105
|
+
<div id="method-list">
|
|
106
|
+
<h3 class="section-bar">Methods</h3>
|
|
107
|
+
|
|
108
|
+
<div class="name-list">
|
|
109
|
+
|
|
110
|
+
<a href="#M000813">generate</a>
|
|
111
|
+
|
|
112
|
+
<a href="#M000814">generateHTML</a>
|
|
113
|
+
|
|
114
|
+
<a href="#M000816">generateHTMLCover</a>
|
|
115
|
+
|
|
116
|
+
<a href="#M000818">generateHTMLFooter</a>
|
|
117
|
+
|
|
118
|
+
<a href="#M000817">generateHTMLHeader</a>
|
|
119
|
+
|
|
120
|
+
<a href="#M000819">generateHTMLNavigationBar</a>
|
|
121
|
+
|
|
122
|
+
<a href="#M000820">generateHTMLindex</a>
|
|
123
|
+
|
|
124
|
+
<a href="#M000815">generateStyleSheet</a>
|
|
125
|
+
|
|
126
|
+
<a href="#M000812">new</a>
|
|
127
|
+
|
|
128
|
+
</div>
|
|
129
|
+
</div>
|
|
130
|
+
|
|
131
|
+
</div>
|
|
132
|
+
|
|
133
|
+
<!-- if includes -->
|
|
134
|
+
|
|
135
|
+
<div id="section">
|
|
136
|
+
|
|
137
|
+
|
|
138
|
+
|
|
139
|
+
|
|
140
|
+
<!-- if method_list -->
|
|
141
|
+
|
|
142
|
+
<div id="methods">
|
|
143
|
+
|
|
144
|
+
<h3 class="section-bar">Public Class methods</h3>
|
|
145
|
+
|
|
146
|
+
|
|
147
|
+
<div id="method-M000812" class="method-detail">
|
|
148
|
+
<a name="M000812"></a>
|
|
149
|
+
|
|
150
|
+
<div class="method-heading">
|
|
151
|
+
|
|
152
|
+
<a href="#M000812" class="method-signature">
|
|
153
|
+
|
|
154
|
+
<span class="method-name">new</span><span class="method-args">()</span>
|
|
155
|
+
|
|
156
|
+
</a>
|
|
157
|
+
|
|
158
|
+
</div>
|
|
159
|
+
|
|
160
|
+
<div class="method-description">
|
|
161
|
+
|
|
162
|
+
<p>
|
|
163
|
+
Create a <a href="UserManual.html">UserManual</a> object and gather the TJP
|
|
164
|
+
syntax information.
|
|
165
|
+
</p>
|
|
166
|
+
|
|
167
|
+
<p><a class="source-toggle" href="#"
|
|
168
|
+
onclick="toggleCode('M000812-source');return false;">[Source]</a></p>
|
|
169
|
+
<div class="method-source-code" id="M000812-source">
|
|
170
|
+
<pre>
|
|
171
|
+
<span class="ruby-comment cmt"># File lib/UserManual.rb, line 27</span>
|
|
172
|
+
27: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">initialize</span>
|
|
173
|
+
28: <span class="ruby-keyword kw">super</span>
|
|
174
|
+
29: <span class="ruby-comment cmt"># Don't confuse this with RichTextDocument#references</span>
|
|
175
|
+
30: <span class="ruby-ivar">@reference</span> = <span class="ruby-constant">SyntaxReference</span>.<span class="ruby-identifier">new</span>(<span class="ruby-keyword kw">self</span>)
|
|
176
|
+
31: <span class="ruby-identifier">registerProtocolHandler</span>(<span class="ruby-constant">RichTextProtocolExample</span>.<span class="ruby-identifier">new</span>)
|
|
177
|
+
32: <span class="ruby-keyword kw">end</span>
|
|
178
|
+
</pre>
|
|
179
|
+
</div>
|
|
180
|
+
|
|
181
|
+
</div>
|
|
182
|
+
</div>
|
|
183
|
+
|
|
184
|
+
|
|
185
|
+
<h3 class="section-bar">Public Instance methods</h3>
|
|
186
|
+
|
|
187
|
+
|
|
188
|
+
<div id="method-M000813" class="method-detail">
|
|
189
|
+
<a name="M000813"></a>
|
|
190
|
+
|
|
191
|
+
<div class="method-heading">
|
|
192
|
+
|
|
193
|
+
<a href="#M000813" class="method-signature">
|
|
194
|
+
|
|
195
|
+
<span class="method-name">generate</span><span class="method-args">(directory)</span>
|
|
196
|
+
|
|
197
|
+
</a>
|
|
198
|
+
|
|
199
|
+
</div>
|
|
200
|
+
|
|
201
|
+
<div class="method-description">
|
|
202
|
+
|
|
203
|
+
<p><a class="source-toggle" href="#"
|
|
204
|
+
onclick="toggleCode('M000813-source');return false;">[Source]</a></p>
|
|
205
|
+
<div class="method-source-code" id="M000813-source">
|
|
206
|
+
<pre>
|
|
207
|
+
<span class="ruby-comment cmt"># File lib/UserManual.rb, line 34</span>
|
|
208
|
+
34: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">generate</span>(<span class="ruby-identifier">directory</span>)
|
|
209
|
+
35: <span class="ruby-comment cmt"># Directory where to find the manual RichText sources. Must be relative</span>
|
|
210
|
+
36: <span class="ruby-comment cmt"># to lib directory.</span>
|
|
211
|
+
37: <span class="ruby-identifier">srcDir</span> = <span class="ruby-constant">AppConfig</span>.<span class="ruby-identifier">dataDirs</span>(<span class="ruby-value str">'manual'</span>)[<span class="ruby-value">0</span>]
|
|
212
|
+
38: <span class="ruby-comment cmt"># Directory where to put the generated HTML files. Must be relative to lib</span>
|
|
213
|
+
39: <span class="ruby-comment cmt"># directory.</span>
|
|
214
|
+
40: <span class="ruby-identifier">destDir</span> = <span class="ruby-identifier">directory</span> <span class="ruby-operator">+</span> (<span class="ruby-identifier">directory</span>[<span class="ruby-value">-1</span>] <span class="ruby-operator">==</span> <span class="ruby-value str">'/'</span> <span class="ruby-operator">?</span> <span class="ruby-value str">''</span> <span class="ruby-operator">:</span> <span class="ruby-value str">'/'</span>)
|
|
215
|
+
41: <span class="ruby-comment cmt"># A list of all source files. The order is important.</span>
|
|
216
|
+
42: <span class="ruby-node">%w(
|
|
217
|
+
43: Intro
|
|
218
|
+
44: TaskJuggler_2x_Migration
|
|
219
|
+
45: How_To_Contribute
|
|
220
|
+
46: Reporting_Bugs
|
|
221
|
+
47: Installation
|
|
222
|
+
48: Getting_Started
|
|
223
|
+
49: Rich_Text_Attributes
|
|
224
|
+
50: Tutorial
|
|
225
|
+
51: Day_To_Day_Juggling
|
|
226
|
+
52: fdl
|
|
227
|
+
53: )</span>.<span class="ruby-identifier">each</span> <span class="ruby-keyword kw">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">file</span><span class="ruby-operator">|</span>
|
|
228
|
+
54: <span class="ruby-identifier">addSnip</span>(<span class="ruby-identifier">srcDir</span> <span class="ruby-operator">+</span> <span class="ruby-identifier">file</span>)
|
|
229
|
+
55: <span class="ruby-keyword kw">end</span>
|
|
230
|
+
56: <span class="ruby-comment cmt"># Generate the table of contense</span>
|
|
231
|
+
57: <span class="ruby-identifier">tableOfContents</span>
|
|
232
|
+
58: <span class="ruby-comment cmt"># Generate the HTML files.</span>
|
|
233
|
+
59: <span class="ruby-identifier">generateHTML</span>(<span class="ruby-identifier">destDir</span>)
|
|
234
|
+
60: <span class="ruby-identifier">checkInternalReferences</span>
|
|
235
|
+
61: <span class="ruby-keyword kw">end</span>
|
|
236
|
+
</pre>
|
|
237
|
+
</div>
|
|
238
|
+
|
|
239
|
+
</div>
|
|
240
|
+
</div>
|
|
241
|
+
|
|
242
|
+
|
|
243
|
+
<div id="method-M000814" class="method-detail">
|
|
244
|
+
<a name="M000814"></a>
|
|
245
|
+
|
|
246
|
+
<div class="method-heading">
|
|
247
|
+
|
|
248
|
+
<a href="#M000814" class="method-signature">
|
|
249
|
+
|
|
250
|
+
<span class="method-name">generateHTML</span><span class="method-args">(directory)</span>
|
|
251
|
+
|
|
252
|
+
</a>
|
|
253
|
+
|
|
254
|
+
</div>
|
|
255
|
+
|
|
256
|
+
<div class="method-description">
|
|
257
|
+
|
|
258
|
+
<p>
|
|
259
|
+
Generate the manual in HTML format. <em>directory</em> specifies a
|
|
260
|
+
directory where the HTML files should be put.
|
|
261
|
+
</p>
|
|
262
|
+
|
|
263
|
+
<p><a class="source-toggle" href="#"
|
|
264
|
+
onclick="toggleCode('M000814-source');return false;">[Source]</a></p>
|
|
265
|
+
<div class="method-source-code" id="M000814-source">
|
|
266
|
+
<pre>
|
|
267
|
+
<span class="ruby-comment cmt"># File lib/UserManual.rb, line 65</span>
|
|
268
|
+
65: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">generateHTML</span>(<span class="ruby-identifier">directory</span>)
|
|
269
|
+
66: <span class="ruby-identifier">generateHTMLindex</span>(<span class="ruby-identifier">directory</span>)
|
|
270
|
+
67: <span class="ruby-identifier">generateHTMLReference</span>(<span class="ruby-identifier">directory</span>)
|
|
271
|
+
68: <span class="ruby-comment cmt"># The SyntaxReference only generates the reference list when the HTML is</span>
|
|
272
|
+
69: <span class="ruby-comment cmt"># generated. So we have to collect it after the HTML generation.</span>
|
|
273
|
+
70: <span class="ruby-ivar">@references</span>.<span class="ruby-identifier">merge!</span>(<span class="ruby-ivar">@reference</span>.<span class="ruby-identifier">internalReferences</span>)
|
|
274
|
+
71:
|
|
275
|
+
72: <span class="ruby-keyword kw">super</span>
|
|
276
|
+
73: <span class="ruby-keyword kw">end</span>
|
|
277
|
+
</pre>
|
|
278
|
+
</div>
|
|
279
|
+
|
|
280
|
+
</div>
|
|
281
|
+
</div>
|
|
282
|
+
|
|
283
|
+
|
|
284
|
+
<div id="method-M000816" class="method-detail">
|
|
285
|
+
<a name="M000816"></a>
|
|
286
|
+
|
|
287
|
+
<div class="method-heading">
|
|
288
|
+
|
|
289
|
+
<a href="#M000816" class="method-signature">
|
|
290
|
+
|
|
291
|
+
<span class="method-name">generateHTMLCover</span><span class="method-args">()</span>
|
|
292
|
+
|
|
293
|
+
</a>
|
|
294
|
+
|
|
295
|
+
</div>
|
|
296
|
+
|
|
297
|
+
<div class="method-description">
|
|
298
|
+
|
|
299
|
+
<p>
|
|
300
|
+
Callback function used by the <a
|
|
301
|
+
href="RichTextDocument.html">RichTextDocument</a> class to generate the
|
|
302
|
+
cover page for the manual.
|
|
303
|
+
</p>
|
|
304
|
+
|
|
305
|
+
<p><a class="source-toggle" href="#"
|
|
306
|
+
onclick="toggleCode('M000816-source');return false;">[Source]</a></p>
|
|
307
|
+
<div class="method-source-code" id="M000816-source">
|
|
308
|
+
<pre>
|
|
309
|
+
<span class="ruby-comment cmt"># File lib/UserManual.rb, line 141</span>
|
|
310
|
+
141: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">generateHTMLCover</span>
|
|
311
|
+
142: <span class="ruby-identifier">html</span> = []
|
|
312
|
+
143: <span class="ruby-identifier">html</span> <span class="ruby-operator"><<</span> (<span class="ruby-identifier">div</span> = <span class="ruby-constant">XMLElement</span>.<span class="ruby-identifier">new</span>(<span class="ruby-value str">'div'</span>, <span class="ruby-value str">'align'</span> =<span class="ruby-operator">></span> <span class="ruby-value str">'center'</span>,
|
|
313
|
+
144: <span class="ruby-value str">'style'</span> =<span class="ruby-operator">></span> <span class="ruby-value str">'margin-top:40px; margin-botton:40px'</span>))
|
|
314
|
+
145: <span class="ruby-identifier">div</span> <span class="ruby-operator"><<</span> <span class="ruby-constant">XMLNamedText</span>.<span class="ruby-identifier">new</span>(<span class="ruby-node">"The #{AppConfig.packageName} User Manual"</span>,
|
|
315
|
+
146: <span class="ruby-value str">'h1'</span>)
|
|
316
|
+
147: <span class="ruby-identifier">div</span> <span class="ruby-operator"><<</span> <span class="ruby-constant">XMLNamedText</span>.<span class="ruby-identifier">new</span>(<span class="ruby-value str">'Project Management beyond Gantt Chart drawing'</span>,
|
|
317
|
+
148: <span class="ruby-value str">'em'</span>)
|
|
318
|
+
149: <span class="ruby-identifier">div</span> <span class="ruby-operator"><<</span> <span class="ruby-constant">XMLElement</span>.<span class="ruby-identifier">new</span>(<span class="ruby-value str">'br'</span>)
|
|
319
|
+
150: <span class="ruby-identifier">div</span> <span class="ruby-operator"><<</span> <span class="ruby-constant">XMLNamedText</span>.<span class="ruby-identifier">new</span>(
|
|
320
|
+
151: <span class="ruby-node">"Copyright (c) #{AppConfig.copyright.join(', ')} "</span> <span class="ruby-operator">+</span>
|
|
321
|
+
152: <span class="ruby-node">"by #{AppConfig.authors.join(', ')}"</span>, <span class="ruby-value str">'b'</span>)
|
|
322
|
+
153: <span class="ruby-identifier">div</span> <span class="ruby-operator"><<</span> <span class="ruby-constant">XMLElement</span>.<span class="ruby-identifier">new</span>(<span class="ruby-value str">'br'</span>)
|
|
323
|
+
154: <span class="ruby-identifier">div</span> <span class="ruby-operator"><<</span> <span class="ruby-constant">XMLText</span>.<span class="ruby-identifier">new</span>(<span class="ruby-node">"Generated on #{TjTime.now.strftime('%Y-%m-%d')}"</span>)
|
|
324
|
+
155: <span class="ruby-identifier">div</span> <span class="ruby-operator"><<</span> <span class="ruby-constant">XMLElement</span>.<span class="ruby-identifier">new</span>(<span class="ruby-value str">'br'</span>)
|
|
325
|
+
156: <span class="ruby-identifier">div</span> <span class="ruby-operator"><<</span> <span class="ruby-constant">XMLNamedText</span>.<span class="ruby-identifier">new</span>(<span class="ruby-node">"This manual covers #{AppConfig.packageName} "</span> <span class="ruby-operator">+</span>
|
|
326
|
+
157: <span class="ruby-node">"version #{AppConfig.version}."</span>, <span class="ruby-value str">'h3'</span>)
|
|
327
|
+
158: <span class="ruby-identifier">html</span> <span class="ruby-operator"><<</span> <span class="ruby-constant">XMLElement</span>.<span class="ruby-identifier">new</span>(<span class="ruby-value str">'br'</span>)
|
|
328
|
+
159: <span class="ruby-identifier">html</span> <span class="ruby-operator"><<</span> <span class="ruby-constant">XMLElement</span>.<span class="ruby-identifier">new</span>(<span class="ruby-value str">'hr'</span>)
|
|
329
|
+
160: <span class="ruby-identifier">html</span> <span class="ruby-operator"><<</span> <span class="ruby-constant">XMLElement</span>.<span class="ruby-identifier">new</span>(<span class="ruby-value str">'br'</span>)
|
|
330
|
+
161:
|
|
331
|
+
162: <span class="ruby-identifier">html</span>
|
|
332
|
+
163: <span class="ruby-keyword kw">end</span>
|
|
333
|
+
</pre>
|
|
334
|
+
</div>
|
|
335
|
+
|
|
336
|
+
</div>
|
|
337
|
+
</div>
|
|
338
|
+
|
|
339
|
+
|
|
340
|
+
<div id="method-M000818" class="method-detail">
|
|
341
|
+
<a name="M000818"></a>
|
|
342
|
+
|
|
343
|
+
<div class="method-heading">
|
|
344
|
+
|
|
345
|
+
<a href="#M000818" class="method-signature">
|
|
346
|
+
|
|
347
|
+
<span class="method-name">generateHTMLFooter</span><span class="method-args">()</span>
|
|
348
|
+
|
|
349
|
+
</a>
|
|
350
|
+
|
|
351
|
+
</div>
|
|
352
|
+
|
|
353
|
+
<div class="method-description">
|
|
354
|
+
|
|
355
|
+
<p>
|
|
356
|
+
Callback function used by the <a
|
|
357
|
+
href="RichTextDocument.html">RichTextDocument</a> class to generate the
|
|
358
|
+
footer for the manual pages.
|
|
359
|
+
</p>
|
|
360
|
+
|
|
361
|
+
<p><a class="source-toggle" href="#"
|
|
362
|
+
onclick="toggleCode('M000818-source');return false;">[Source]</a></p>
|
|
363
|
+
<div class="method-source-code" id="M000818-source">
|
|
364
|
+
<pre>
|
|
365
|
+
<span class="ruby-comment cmt"># File lib/UserManual.rb, line 182</span>
|
|
366
|
+
182: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">generateHTMLFooter</span>
|
|
367
|
+
183: <span class="ruby-identifier">html</span> = []
|
|
368
|
+
184: <span class="ruby-identifier">html</span> <span class="ruby-operator"><<</span> (<span class="ruby-identifier">div</span> = <span class="ruby-constant">XMLElement</span>.<span class="ruby-identifier">new</span>(<span class="ruby-value str">'div'</span>, <span class="ruby-value str">'align'</span> =<span class="ruby-operator">></span> <span class="ruby-value str">'center'</span>,
|
|
369
|
+
185: <span class="ruby-value str">'style'</span> =<span class="ruby-operator">></span> <span class="ruby-value str">'font-size:10px;'</span>))
|
|
370
|
+
186: <span class="ruby-identifier">div</span> <span class="ruby-operator"><<</span> <span class="ruby-constant">XMLText</span>.<span class="ruby-identifier">new</span>(<span class="ruby-node">"Copyright (c) #{AppConfig.copyright.join(', ')} by "</span> <span class="ruby-operator">+</span>
|
|
371
|
+
187: <span class="ruby-node">"#{AppConfig.authors.join(', ')}."</span>)
|
|
372
|
+
188: <span class="ruby-identifier">div</span> <span class="ruby-operator"><<</span> <span class="ruby-constant">XMLNamedText</span>.<span class="ruby-identifier">new</span>(<span class="ruby-value str">'TaskJuggler'</span>, <span class="ruby-value str">'a'</span>, <span class="ruby-value str">'href'</span> =<span class="ruby-operator">></span> <span class="ruby-constant">AppConfig</span>.<span class="ruby-identifier">contact</span>)
|
|
373
|
+
189: <span class="ruby-identifier">div</span> <span class="ruby-operator"><<</span> <span class="ruby-constant">XMLText</span>.<span class="ruby-identifier">new</span>(<span class="ruby-value str">' is a trademark of Chris Schlaeger.'</span>)
|
|
374
|
+
190:
|
|
375
|
+
191: <span class="ruby-identifier">html</span>
|
|
376
|
+
192: <span class="ruby-keyword kw">end</span>
|
|
377
|
+
</pre>
|
|
378
|
+
</div>
|
|
379
|
+
|
|
380
|
+
</div>
|
|
381
|
+
</div>
|
|
382
|
+
|
|
383
|
+
|
|
384
|
+
<div id="method-M000817" class="method-detail">
|
|
385
|
+
<a name="M000817"></a>
|
|
386
|
+
|
|
387
|
+
<div class="method-heading">
|
|
388
|
+
|
|
389
|
+
<a href="#M000817" class="method-signature">
|
|
390
|
+
|
|
391
|
+
<span class="method-name">generateHTMLHeader</span><span class="method-args">()</span>
|
|
392
|
+
|
|
393
|
+
</a>
|
|
394
|
+
|
|
395
|
+
</div>
|
|
396
|
+
|
|
397
|
+
<div class="method-description">
|
|
398
|
+
|
|
399
|
+
<p>
|
|
400
|
+
Callback function used by the <a
|
|
401
|
+
href="RichTextDocument.html">RichTextDocument</a> class to generate the
|
|
402
|
+
header for the manual pages.
|
|
403
|
+
</p>
|
|
404
|
+
|
|
405
|
+
<p><a class="source-toggle" href="#"
|
|
406
|
+
onclick="toggleCode('M000817-source');return false;">[Source]</a></p>
|
|
407
|
+
<div class="method-source-code" id="M000817-source">
|
|
408
|
+
<pre>
|
|
409
|
+
<span class="ruby-comment cmt"># File lib/UserManual.rb, line 167</span>
|
|
410
|
+
167: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">generateHTMLHeader</span>
|
|
411
|
+
168: <span class="ruby-identifier">html</span> = []
|
|
412
|
+
169: <span class="ruby-identifier">html</span> <span class="ruby-operator"><<</span> (<span class="ruby-identifier">headline</span> = <span class="ruby-constant">XMLElement</span>.<span class="ruby-identifier">new</span>(<span class="ruby-value str">'div'</span>, <span class="ruby-value str">'align'</span> =<span class="ruby-operator">></span> <span class="ruby-value str">'center'</span>))
|
|
413
|
+
170: <span class="ruby-identifier">headline</span> <span class="ruby-operator"><<</span> <span class="ruby-constant">XMLNamedText</span>.<span class="ruby-identifier">new</span>(
|
|
414
|
+
171: <span class="ruby-node">"The #{AppConfig.packageName} User Manual"</span>, <span class="ruby-value str">'h3'</span>,
|
|
415
|
+
172: <span class="ruby-value str">'align'</span> =<span class="ruby-operator">></span> <span class="ruby-value str">'center'</span>)
|
|
416
|
+
173: <span class="ruby-identifier">headline</span> <span class="ruby-operator"><<</span> <span class="ruby-constant">XMLNamedText</span>.<span class="ruby-identifier">new</span>(
|
|
417
|
+
174: <span class="ruby-value str">'Project Management beyond Gantt Chart Drawing'</span>, <span class="ruby-value str">'em'</span>,
|
|
418
|
+
175: <span class="ruby-value str">'align'</span> =<span class="ruby-operator">></span> <span class="ruby-value str">'center'</span>)
|
|
419
|
+
176:
|
|
420
|
+
177: <span class="ruby-identifier">html</span>
|
|
421
|
+
178: <span class="ruby-keyword kw">end</span>
|
|
422
|
+
</pre>
|
|
423
|
+
</div>
|
|
424
|
+
|
|
425
|
+
</div>
|
|
426
|
+
</div>
|
|
427
|
+
|
|
428
|
+
|
|
429
|
+
<div id="method-M000819" class="method-detail">
|
|
430
|
+
<a name="M000819"></a>
|
|
431
|
+
|
|
432
|
+
<div class="method-heading">
|
|
433
|
+
|
|
434
|
+
<a href="#M000819" class="method-signature">
|
|
435
|
+
|
|
436
|
+
<span class="method-name">generateHTMLNavigationBar</span><span class="method-args">(predLabel, predURL, succLabel, succURL)</span>
|
|
437
|
+
|
|
438
|
+
</a>
|
|
439
|
+
|
|
440
|
+
</div>
|
|
441
|
+
|
|
442
|
+
<div class="method-description">
|
|
443
|
+
|
|
444
|
+
<p>
|
|
445
|
+
Callback function used by the <a
|
|
446
|
+
href="RichTextDocument.html">RichTextDocument</a> and <a
|
|
447
|
+
href="KeywordDocumentation.html">KeywordDocumentation</a> classes to
|
|
448
|
+
generate the navigation bars for the manual pages. <em>predLabel</em>: Text
|
|
449
|
+
for the reference to the previous page. May be nil. _predURL: URL to the
|
|
450
|
+
previous page. <em>succLabel</em>: Text for the reference to the next page.
|
|
451
|
+
May be nil. _succURL: URL to the next page.
|
|
452
|
+
</p>
|
|
453
|
+
|
|
454
|
+
<p><a class="source-toggle" href="#"
|
|
455
|
+
onclick="toggleCode('M000819-source');return false;">[Source]</a></p>
|
|
456
|
+
<div class="method-source-code" id="M000819-source">
|
|
457
|
+
<pre>
|
|
458
|
+
<span class="ruby-comment cmt"># File lib/UserManual.rb, line 200</span>
|
|
459
|
+
200: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">generateHTMLNavigationBar</span>(<span class="ruby-identifier">predLabel</span>, <span class="ruby-identifier">predURL</span>, <span class="ruby-identifier">succLabel</span>, <span class="ruby-identifier">succURL</span>)
|
|
460
|
+
201: <span class="ruby-identifier">html</span> = []
|
|
461
|
+
202: <span class="ruby-identifier">html</span> <span class="ruby-operator"><<</span> <span class="ruby-constant">XMLElement</span>.<span class="ruby-identifier">new</span>(<span class="ruby-value str">'br'</span>)
|
|
462
|
+
203: <span class="ruby-identifier">html</span> <span class="ruby-operator"><<</span> <span class="ruby-constant">XMLElement</span>.<span class="ruby-identifier">new</span>(<span class="ruby-value str">'hr'</span>)
|
|
463
|
+
204: <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">predLabel</span> <span class="ruby-operator">||</span> <span class="ruby-identifier">succLabel</span>
|
|
464
|
+
205: <span class="ruby-comment cmt"># We use a tabel to get the desired layout.</span>
|
|
465
|
+
206: <span class="ruby-identifier">html</span> <span class="ruby-operator"><<</span> (<span class="ruby-identifier">tab</span> = <span class="ruby-constant">XMLElement</span>.<span class="ruby-identifier">new</span>(<span class="ruby-value str">'table'</span>,
|
|
466
|
+
207: <span class="ruby-value str">'style'</span> =<span class="ruby-operator">></span> <span class="ruby-value str">'width:90%; margin-left:5%; margin-right:5%'</span>))
|
|
467
|
+
208: <span class="ruby-identifier">tab</span> <span class="ruby-operator"><<</span> (<span class="ruby-identifier">tr</span> = <span class="ruby-constant">XMLElement</span>.<span class="ruby-identifier">new</span>(<span class="ruby-value str">'tr'</span>))
|
|
468
|
+
209: <span class="ruby-identifier">tr</span> <span class="ruby-operator"><<</span> (<span class="ruby-identifier">td</span> = <span class="ruby-constant">XMLElement</span>.<span class="ruby-identifier">new</span>(<span class="ruby-value str">'td'</span>,
|
|
469
|
+
210: <span class="ruby-value str">'style'</span> =<span class="ruby-operator">></span> <span class="ruby-value str">'text-align:left; width:35%;'</span>))
|
|
470
|
+
211: <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">predLabel</span>
|
|
471
|
+
212: <span class="ruby-comment cmt"># Link to previous page.</span>
|
|
472
|
+
213: <span class="ruby-identifier">td</span> <span class="ruby-operator"><<</span> <span class="ruby-constant">XMLText</span>.<span class="ruby-identifier">new</span>(<span class="ruby-value str">'<< '</span>)
|
|
473
|
+
214: <span class="ruby-identifier">td</span> <span class="ruby-operator"><<</span> <span class="ruby-constant">XMLNamedText</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">predLabel</span>, <span class="ruby-value str">'a'</span>, <span class="ruby-value str">'href'</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">predURL</span>)
|
|
474
|
+
215: <span class="ruby-identifier">td</span> <span class="ruby-operator"><<</span> <span class="ruby-constant">XMLText</span>.<span class="ruby-identifier">new</span>(<span class="ruby-value str">' <<'</span>)
|
|
475
|
+
216: <span class="ruby-keyword kw">end</span>
|
|
476
|
+
217: <span class="ruby-comment cmt"># Link to table of contents</span>
|
|
477
|
+
218: <span class="ruby-identifier">tr</span> <span class="ruby-operator"><<</span> (<span class="ruby-identifier">td</span> = <span class="ruby-constant">XMLElement</span>.<span class="ruby-identifier">new</span>(<span class="ruby-value str">'td'</span>,
|
|
478
|
+
219: <span class="ruby-value str">'style'</span> =<span class="ruby-operator">></span> <span class="ruby-value str">'text-align:center; width:30%;'</span>))
|
|
479
|
+
220: <span class="ruby-identifier">td</span> <span class="ruby-operator"><<</span> <span class="ruby-constant">XMLNamedText</span>.<span class="ruby-identifier">new</span>(<span class="ruby-value str">'Table Of Contents'</span>, <span class="ruby-value str">'a'</span>, <span class="ruby-value str">'href'</span> =<span class="ruby-operator">></span> <span class="ruby-value str">'toc.html'</span>)
|
|
480
|
+
221: <span class="ruby-identifier">tr</span> <span class="ruby-operator"><<</span> (<span class="ruby-identifier">td</span> = <span class="ruby-constant">XMLElement</span>.<span class="ruby-identifier">new</span>(<span class="ruby-value str">'td'</span>,
|
|
481
|
+
222: <span class="ruby-value str">'style'</span> =<span class="ruby-operator">></span> <span class="ruby-value str">'text-align:right; width:35%;'</span>))
|
|
482
|
+
223: <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">succLabel</span>
|
|
483
|
+
224: <span class="ruby-comment cmt"># Link to next page.</span>
|
|
484
|
+
225: <span class="ruby-identifier">td</span> <span class="ruby-operator"><<</span> <span class="ruby-constant">XMLText</span>.<span class="ruby-identifier">new</span>(<span class="ruby-value str">'>> '</span>)
|
|
485
|
+
226: <span class="ruby-identifier">td</span> <span class="ruby-operator"><<</span> <span class="ruby-constant">XMLNamedText</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">succLabel</span>, <span class="ruby-value str">'a'</span>, <span class="ruby-value str">'href'</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">succURL</span>)
|
|
486
|
+
227: <span class="ruby-identifier">td</span> <span class="ruby-operator"><<</span> <span class="ruby-constant">XMLText</span>.<span class="ruby-identifier">new</span>(<span class="ruby-value str">' >>'</span>)
|
|
487
|
+
228: <span class="ruby-keyword kw">end</span>
|
|
488
|
+
229: <span class="ruby-identifier">html</span> <span class="ruby-operator"><<</span> <span class="ruby-constant">XMLElement</span>.<span class="ruby-identifier">new</span>(<span class="ruby-value str">'hr'</span>)
|
|
489
|
+
230: <span class="ruby-keyword kw">end</span>
|
|
490
|
+
231: <span class="ruby-identifier">html</span> <span class="ruby-operator"><<</span> <span class="ruby-constant">XMLElement</span>.<span class="ruby-identifier">new</span>(<span class="ruby-value str">'br'</span>)
|
|
491
|
+
232:
|
|
492
|
+
233: <span class="ruby-identifier">html</span>
|
|
493
|
+
234: <span class="ruby-keyword kw">end</span>
|
|
494
|
+
</pre>
|
|
495
|
+
</div>
|
|
496
|
+
|
|
497
|
+
</div>
|
|
498
|
+
</div>
|
|
499
|
+
|
|
500
|
+
|
|
501
|
+
<div id="method-M000820" class="method-detail">
|
|
502
|
+
<a name="M000820"></a>
|
|
503
|
+
|
|
504
|
+
<div class="method-heading">
|
|
505
|
+
|
|
506
|
+
<a href="#M000820" class="method-signature">
|
|
507
|
+
|
|
508
|
+
<span class="method-name">generateHTMLindex</span><span class="method-args">(directory)</span>
|
|
509
|
+
|
|
510
|
+
</a>
|
|
511
|
+
|
|
512
|
+
</div>
|
|
513
|
+
|
|
514
|
+
<div class="method-description">
|
|
515
|
+
|
|
516
|
+
<p>
|
|
517
|
+
Generate the top-level file for the HTML user manual.
|
|
518
|
+
</p>
|
|
519
|
+
|
|
520
|
+
<p><a class="source-toggle" href="#"
|
|
521
|
+
onclick="toggleCode('M000820-source');return false;">[Source]</a></p>
|
|
522
|
+
<div class="method-source-code" id="M000820-source">
|
|
523
|
+
<pre>
|
|
524
|
+
<span class="ruby-comment cmt"># File lib/UserManual.rb, line 237</span>
|
|
525
|
+
237: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">generateHTMLindex</span>(<span class="ruby-identifier">directory</span>)
|
|
526
|
+
238: <span class="ruby-identifier">html</span> = <span class="ruby-constant">HTMLDocument</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">:frameset</span>)
|
|
527
|
+
239: <span class="ruby-identifier">html</span> <span class="ruby-operator"><<</span> (<span class="ruby-identifier">head</span> = <span class="ruby-constant">XMLElement</span>.<span class="ruby-identifier">new</span>(<span class="ruby-value str">'head'</span>))
|
|
528
|
+
240: <span class="ruby-identifier">head</span> <span class="ruby-operator"><<</span> (<span class="ruby-identifier">e</span> = <span class="ruby-constant">XMLNamedText</span>.<span class="ruby-identifier">new</span>(<span class="ruby-node">"The #{AppConfig.packageName} User Manual"</span>,
|
|
529
|
+
241: <span class="ruby-value str">'title'</span>))
|
|
530
|
+
242: <span class="ruby-identifier">head</span> <span class="ruby-operator"><<</span> <span class="ruby-constant">XMLElement</span>.<span class="ruby-identifier">new</span>(<span class="ruby-value str">'meta'</span>, <span class="ruby-value str">'http-equiv'</span> =<span class="ruby-operator">></span> <span class="ruby-value str">'Content-Type'</span>,
|
|
531
|
+
243: <span class="ruby-value str">'content'</span> =<span class="ruby-operator">></span> <span class="ruby-value str">'text/html; charset=utf-8'</span>)
|
|
532
|
+
244:
|
|
533
|
+
245: <span class="ruby-identifier">html</span> <span class="ruby-operator"><<</span> (<span class="ruby-identifier">frameset</span> = <span class="ruby-constant">XMLElement</span>.<span class="ruby-identifier">new</span>(<span class="ruby-value str">'frameset'</span>, <span class="ruby-value str">'cols'</span> =<span class="ruby-operator">></span> <span class="ruby-value str">'15%, 85%'</span>))
|
|
534
|
+
246: <span class="ruby-identifier">frameset</span> <span class="ruby-operator"><<</span> (<span class="ruby-identifier">navFrames</span> = <span class="ruby-constant">XMLElement</span>.<span class="ruby-identifier">new</span>(<span class="ruby-value str">'frameset'</span>, <span class="ruby-value str">'rows'</span> =<span class="ruby-operator">></span> <span class="ruby-value str">'15%, 85%'</span>))
|
|
535
|
+
247: <span class="ruby-identifier">navFrames</span> <span class="ruby-operator"><<</span> <span class="ruby-constant">XMLElement</span>.<span class="ruby-identifier">new</span>(<span class="ruby-value str">'frame'</span>, <span class="ruby-value str">'src'</span> =<span class="ruby-operator">></span> <span class="ruby-value str">'alphabet.html'</span>,
|
|
536
|
+
248: <span class="ruby-value str">'name'</span> =<span class="ruby-operator">></span> <span class="ruby-value str">'alphabet'</span>)
|
|
537
|
+
249: <span class="ruby-identifier">navFrames</span> <span class="ruby-operator"><<</span> <span class="ruby-constant">XMLElement</span>.<span class="ruby-identifier">new</span>(<span class="ruby-value str">'frame'</span>, <span class="ruby-value str">'src'</span> =<span class="ruby-operator">></span> <span class="ruby-value str">'navbar.html'</span>,
|
|
538
|
+
250: <span class="ruby-value str">'name'</span> =<span class="ruby-operator">></span> <span class="ruby-value str">'navigator'</span>)
|
|
539
|
+
251: <span class="ruby-identifier">frameset</span> <span class="ruby-operator"><<</span> <span class="ruby-constant">XMLElement</span>.<span class="ruby-identifier">new</span>(<span class="ruby-value str">'frame'</span>, <span class="ruby-value str">'src'</span> =<span class="ruby-operator">></span> <span class="ruby-value str">'toc.html'</span>,
|
|
540
|
+
252: <span class="ruby-value str">'name'</span> =<span class="ruby-operator">></span> <span class="ruby-value str">'display'</span>)
|
|
541
|
+
253:
|
|
542
|
+
254: <span class="ruby-identifier">html</span>.<span class="ruby-identifier">write</span>(<span class="ruby-identifier">directory</span> <span class="ruby-operator">+</span> <span class="ruby-value str">'index.html'</span>)
|
|
543
|
+
255: <span class="ruby-keyword kw">end</span>
|
|
544
|
+
</pre>
|
|
545
|
+
</div>
|
|
546
|
+
|
|
547
|
+
</div>
|
|
548
|
+
</div>
|
|
549
|
+
|
|
550
|
+
|
|
551
|
+
<div id="method-M000815" class="method-detail">
|
|
552
|
+
<a name="M000815"></a>
|
|
553
|
+
|
|
554
|
+
<div class="method-heading">
|
|
555
|
+
|
|
556
|
+
<a href="#M000815" class="method-signature">
|
|
557
|
+
|
|
558
|
+
<span class="method-name">generateStyleSheet</span><span class="method-args">()</span>
|
|
559
|
+
|
|
560
|
+
</a>
|
|
561
|
+
|
|
562
|
+
</div>
|
|
563
|
+
|
|
564
|
+
<div class="method-description">
|
|
565
|
+
|
|
566
|
+
<p>
|
|
567
|
+
Callback function used by the <a
|
|
568
|
+
href="RichTextDocument.html">RichTextDocument</a> and <a
|
|
569
|
+
href="KeywordDocumentation.html">KeywordDocumentation</a> classes to
|
|
570
|
+
generate the HTML style sheet for the manual pages.
|
|
571
|
+
</p>
|
|
572
|
+
|
|
573
|
+
<p><a class="source-toggle" href="#"
|
|
574
|
+
onclick="toggleCode('M000815-source');return false;">[Source]</a></p>
|
|
575
|
+
<div class="method-source-code" id="M000815-source">
|
|
576
|
+
<pre>
|
|
577
|
+
<span class="ruby-comment cmt"># File lib/UserManual.rb, line 77</span>
|
|
578
|
+
77: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">generateStyleSheet</span>
|
|
579
|
+
78: <span class="ruby-identifier">html</span> = []
|
|
580
|
+
79: <span class="ruby-identifier">html</span> <span class="ruby-operator"><<</span> (<span class="ruby-identifier">style</span> = <span class="ruby-constant">XMLElement</span>.<span class="ruby-identifier">new</span>(<span class="ruby-value str">'style'</span>, <span class="ruby-value str">'type'</span> =<span class="ruby-operator">></span> <span class="ruby-value str">'text/css'</span>))
|
|
581
|
+
80: <span class="ruby-identifier">style</span> <span class="ruby-operator"><<</span> <span class="ruby-constant">XMLBlob</span>.<span class="ruby-identifier">new</span>(<span class="ruby-value str">"pre {\n font-size:16px;\n font-family: Courier;\n padding-left:8px;\n padding-right:8px;\n padding-top:0px;\n padding-bottom:0px;\n}\np {\n margin-top:8px;\n margin-bottom:8px;\n}\ncode {\n font-size:16px;\n font-family: Courier;\n}\n.table {\n background-color:#ABABAB;\n width:100%;\n}\n.tag {\n background-color:#E0E0F0;\n font-size:16px;\n font-weight:bold;\n padding-left:8px;\n padding-right:8px;\n padding-top:5px;\n padding-bottom:5px;\n}\n.descr {\n background-color:#F0F0F0;\n font-size:16px;\n padding-left:8px;\n padding-right:8px;\n padding-top:5px;\n padding-bottom:5px;\n}\n.codeframe{\n border-width:2px;\n border-color:#ABABAB;\n border-style:solid;\n background-color:#F0F0F0;\n margin-top:8px;\n margin-bottom:8px;\n}\n.code {\n padding-left:15px;\n padding-right:15px;\n padding-top:0px;\n padding-bottom:0px;\n}\n"</span>
|
|
582
|
+
81: )
|
|
583
|
+
82:
|
|
584
|
+
83: <span class="ruby-identifier">html</span>
|
|
585
|
+
84: <span class="ruby-keyword kw">end</span>
|
|
586
|
+
</pre>
|
|
587
|
+
</div>
|
|
588
|
+
|
|
589
|
+
</div>
|
|
590
|
+
</div>
|
|
591
|
+
|
|
592
|
+
|
|
593
|
+
|
|
594
|
+
</div>
|
|
595
|
+
|
|
596
|
+
|
|
597
|
+
|
|
598
|
+
|
|
599
|
+
</div>
|
|
600
|
+
|
|
601
|
+
<div id="validator-badges">
|
|
602
|
+
<p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
|
|
603
|
+
</div>
|
|
604
|
+
|
|
605
|
+
</body>
|
|
606
|
+
</html>
|