taskjuggler 0.0.2
Sign up to get free protection for your applications and to get access to all the features.
- 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,267 @@
|
|
|
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::IntervalListAttribute [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::IntervalListAttribute</td>
|
|
50
|
+
</tr>
|
|
51
|
+
<tr class="top-aligned-row">
|
|
52
|
+
<td><strong>In:</strong></td>
|
|
53
|
+
<td>
|
|
54
|
+
|
|
55
|
+
|
|
56
|
+
<a href="../../files/lib/Attributes_rb.html">
|
|
57
|
+
|
|
58
|
+
lib/Attributes.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="AttributeBase.html">
|
|
74
|
+
|
|
75
|
+
TaskJuggler::AttributeBase
|
|
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>
|
|
91
|
+
|
|
92
|
+
|
|
93
|
+
<div id="method-list">
|
|
94
|
+
<h3 class="section-bar">Methods</h3>
|
|
95
|
+
|
|
96
|
+
<div class="name-list">
|
|
97
|
+
|
|
98
|
+
<a href="#M000739">new</a>
|
|
99
|
+
|
|
100
|
+
<a href="#M000740">tjpId</a>
|
|
101
|
+
|
|
102
|
+
<a href="#M000741">to_s</a>
|
|
103
|
+
|
|
104
|
+
<a href="#M000742">to_tjp</a>
|
|
105
|
+
|
|
106
|
+
</div>
|
|
107
|
+
</div>
|
|
108
|
+
|
|
109
|
+
</div>
|
|
110
|
+
|
|
111
|
+
<!-- if includes -->
|
|
112
|
+
|
|
113
|
+
<div id="section">
|
|
114
|
+
|
|
115
|
+
|
|
116
|
+
|
|
117
|
+
|
|
118
|
+
<!-- if method_list -->
|
|
119
|
+
|
|
120
|
+
<div id="methods">
|
|
121
|
+
|
|
122
|
+
<h3 class="section-bar">Public Class methods</h3>
|
|
123
|
+
|
|
124
|
+
|
|
125
|
+
<div id="method-M000739" class="method-detail">
|
|
126
|
+
<a name="M000739"></a>
|
|
127
|
+
|
|
128
|
+
<div class="method-heading">
|
|
129
|
+
|
|
130
|
+
<a href="#M000739" class="method-signature">
|
|
131
|
+
|
|
132
|
+
<span class="method-name">new</span><span class="method-args">(property, type)</span>
|
|
133
|
+
|
|
134
|
+
</a>
|
|
135
|
+
|
|
136
|
+
</div>
|
|
137
|
+
|
|
138
|
+
<div class="method-description">
|
|
139
|
+
|
|
140
|
+
<p><a class="source-toggle" href="#"
|
|
141
|
+
onclick="toggleCode('M000739-source');return false;">[Source]</a></p>
|
|
142
|
+
<div class="method-source-code" id="M000739-source">
|
|
143
|
+
<pre>
|
|
144
|
+
<span class="ruby-comment cmt"># File lib/Attributes.rb, line 253</span>
|
|
145
|
+
253: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">initialize</span>(<span class="ruby-identifier">property</span>, <span class="ruby-identifier">type</span>)
|
|
146
|
+
254: <span class="ruby-keyword kw">super</span>(<span class="ruby-identifier">property</span>, <span class="ruby-identifier">type</span>)
|
|
147
|
+
255:
|
|
148
|
+
256: <span class="ruby-ivar">@value</span> = <span class="ruby-constant">Array</span>.<span class="ruby-identifier">new</span>
|
|
149
|
+
257: <span class="ruby-keyword kw">end</span>
|
|
150
|
+
</pre>
|
|
151
|
+
</div>
|
|
152
|
+
|
|
153
|
+
</div>
|
|
154
|
+
</div>
|
|
155
|
+
|
|
156
|
+
|
|
157
|
+
<div id="method-M000740" class="method-detail">
|
|
158
|
+
<a name="M000740"></a>
|
|
159
|
+
|
|
160
|
+
<div class="method-heading">
|
|
161
|
+
|
|
162
|
+
<a href="#M000740" class="method-signature">
|
|
163
|
+
|
|
164
|
+
<span class="method-name">tjpId</span><span class="method-args">()</span>
|
|
165
|
+
|
|
166
|
+
</a>
|
|
167
|
+
|
|
168
|
+
</div>
|
|
169
|
+
|
|
170
|
+
<div class="method-description">
|
|
171
|
+
|
|
172
|
+
<p><a class="source-toggle" href="#"
|
|
173
|
+
onclick="toggleCode('M000740-source');return false;">[Source]</a></p>
|
|
174
|
+
<div class="method-source-code" id="M000740-source">
|
|
175
|
+
<pre>
|
|
176
|
+
<span class="ruby-comment cmt"># File lib/Attributes.rb, line 259</span>
|
|
177
|
+
259: <span class="ruby-keyword kw">def</span> <span class="ruby-constant">IntervalListAttribute</span><span class="ruby-operator">::</span><span class="ruby-identifier">tjpId</span>
|
|
178
|
+
260: <span class="ruby-value str">'intervallist'</span>
|
|
179
|
+
261: <span class="ruby-keyword kw">end</span>
|
|
180
|
+
</pre>
|
|
181
|
+
</div>
|
|
182
|
+
|
|
183
|
+
</div>
|
|
184
|
+
</div>
|
|
185
|
+
|
|
186
|
+
|
|
187
|
+
<h3 class="section-bar">Public Instance methods</h3>
|
|
188
|
+
|
|
189
|
+
|
|
190
|
+
<div id="method-M000741" class="method-detail">
|
|
191
|
+
<a name="M000741"></a>
|
|
192
|
+
|
|
193
|
+
<div class="method-heading">
|
|
194
|
+
|
|
195
|
+
<a href="#M000741" class="method-signature">
|
|
196
|
+
|
|
197
|
+
<span class="method-name">to_s</span><span class="method-args">()</span>
|
|
198
|
+
|
|
199
|
+
</a>
|
|
200
|
+
|
|
201
|
+
</div>
|
|
202
|
+
|
|
203
|
+
<div class="method-description">
|
|
204
|
+
|
|
205
|
+
<p><a class="source-toggle" href="#"
|
|
206
|
+
onclick="toggleCode('M000741-source');return false;">[Source]</a></p>
|
|
207
|
+
<div class="method-source-code" id="M000741-source">
|
|
208
|
+
<pre>
|
|
209
|
+
<span class="ruby-comment cmt"># File lib/Attributes.rb, line 263</span>
|
|
210
|
+
263: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">to_s</span>
|
|
211
|
+
264: <span class="ruby-identifier">out</span> = []
|
|
212
|
+
265: <span class="ruby-ivar">@value</span>.<span class="ruby-identifier">each</span> { <span class="ruby-operator">|</span><span class="ruby-identifier">i</span><span class="ruby-operator">|</span> <span class="ruby-identifier">out</span> <span class="ruby-operator"><<</span> <span class="ruby-identifier">i</span>.<span class="ruby-identifier">to_s</span> }
|
|
213
|
+
266: <span class="ruby-identifier">out</span>.<span class="ruby-identifier">join</span>(<span class="ruby-value str">", "</span>)
|
|
214
|
+
267: <span class="ruby-keyword kw">end</span>
|
|
215
|
+
</pre>
|
|
216
|
+
</div>
|
|
217
|
+
|
|
218
|
+
</div>
|
|
219
|
+
</div>
|
|
220
|
+
|
|
221
|
+
|
|
222
|
+
<div id="method-M000742" class="method-detail">
|
|
223
|
+
<a name="M000742"></a>
|
|
224
|
+
|
|
225
|
+
<div class="method-heading">
|
|
226
|
+
|
|
227
|
+
<a href="#M000742" class="method-signature">
|
|
228
|
+
|
|
229
|
+
<span class="method-name">to_tjp</span><span class="method-args">()</span>
|
|
230
|
+
|
|
231
|
+
</a>
|
|
232
|
+
|
|
233
|
+
</div>
|
|
234
|
+
|
|
235
|
+
<div class="method-description">
|
|
236
|
+
|
|
237
|
+
<p><a class="source-toggle" href="#"
|
|
238
|
+
onclick="toggleCode('M000742-source');return false;">[Source]</a></p>
|
|
239
|
+
<div class="method-source-code" id="M000742-source">
|
|
240
|
+
<pre>
|
|
241
|
+
<span class="ruby-comment cmt"># File lib/Attributes.rb, line 269</span>
|
|
242
|
+
269: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">to_tjp</span>
|
|
243
|
+
270: <span class="ruby-identifier">out</span> = []
|
|
244
|
+
271: <span class="ruby-ivar">@value</span>.<span class="ruby-identifier">each</span> { <span class="ruby-operator">|</span><span class="ruby-identifier">i</span><span class="ruby-operator">|</span> <span class="ruby-identifier">out</span> <span class="ruby-operator"><<</span> <span class="ruby-identifier">i</span>.<span class="ruby-identifier">to_s</span> }
|
|
245
|
+
272: <span class="ruby-ivar">@type</span>.<span class="ruby-identifier">id</span> <span class="ruby-operator">+</span> <span class="ruby-value str">" "</span> <span class="ruby-operator">+</span> <span class="ruby-identifier">out</span>.<span class="ruby-identifier">join</span>(<span class="ruby-value str">', '</span>)
|
|
246
|
+
273: <span class="ruby-keyword kw">end</span>
|
|
247
|
+
</pre>
|
|
248
|
+
</div>
|
|
249
|
+
|
|
250
|
+
</div>
|
|
251
|
+
</div>
|
|
252
|
+
|
|
253
|
+
|
|
254
|
+
|
|
255
|
+
</div>
|
|
256
|
+
|
|
257
|
+
|
|
258
|
+
|
|
259
|
+
|
|
260
|
+
</div>
|
|
261
|
+
|
|
262
|
+
<div id="validator-badges">
|
|
263
|
+
<p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
|
|
264
|
+
</div>
|
|
265
|
+
|
|
266
|
+
</body>
|
|
267
|
+
</html>
|
|
@@ -0,0 +1,796 @@
|
|
|
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::KeywordDocumentation [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::KeywordDocumentation</td>
|
|
50
|
+
</tr>
|
|
51
|
+
<tr class="top-aligned-row">
|
|
52
|
+
<td><strong>In:</strong></td>
|
|
53
|
+
<td>
|
|
54
|
+
|
|
55
|
+
|
|
56
|
+
<a href="../../files/lib/KeywordDocumentation_rb.html">
|
|
57
|
+
|
|
58
|
+
lib/KeywordDocumentation.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
|
+
Object
|
|
74
|
+
|
|
75
|
+
</td>
|
|
76
|
+
</tr>
|
|
77
|
+
|
|
78
|
+
</table>
|
|
79
|
+
</div>
|
|
80
|
+
<!-- banner header -->
|
|
81
|
+
|
|
82
|
+
<div id="bodyContent">
|
|
83
|
+
|
|
84
|
+
<div id="contextContent">
|
|
85
|
+
|
|
86
|
+
<div id="description">
|
|
87
|
+
<p>
|
|
88
|
+
The textual <a href="../TaskJuggler.html">TaskJuggler</a> <a
|
|
89
|
+
href="Project.html">Project</a> description consists of many keywords. The
|
|
90
|
+
parser has built-in support to document the meaning and usage of these
|
|
91
|
+
keywords. Most keywords are unique, but there can be exceptions. To resolve
|
|
92
|
+
ambiguoties the keywords can be prefixed by a scope. The scope is usually a
|
|
93
|
+
keyword that describes the context that the ambiguous keyword is used in.
|
|
94
|
+
This class stores the keyword, the corresponding <a
|
|
95
|
+
href="TextParser/Pattern.html">TextParser::Pattern</a> and the context that
|
|
96
|
+
the keyword is used in. It also stores information such as the list of
|
|
97
|
+
optional attributes (keywords used in the context of the current keyword)
|
|
98
|
+
and whether the keyword is scenario specific or not.
|
|
99
|
+
</p>
|
|
100
|
+
|
|
101
|
+
</div>
|
|
102
|
+
|
|
103
|
+
</div>
|
|
104
|
+
|
|
105
|
+
|
|
106
|
+
<div id="method-list">
|
|
107
|
+
<h3 class="section-bar">Methods</h3>
|
|
108
|
+
|
|
109
|
+
<div class="name-list">
|
|
110
|
+
|
|
111
|
+
<a href="#M000424">computeInheritance</a>
|
|
112
|
+
|
|
113
|
+
<a href="#M000423">crossReference</a>
|
|
114
|
+
|
|
115
|
+
<a href="#M000427">generateHTML</a>
|
|
116
|
+
|
|
117
|
+
<a href="#M000422">new</a>
|
|
118
|
+
|
|
119
|
+
<a href="#M000425">title</a>
|
|
120
|
+
|
|
121
|
+
<a href="#M000426">to_s</a>
|
|
122
|
+
|
|
123
|
+
</div>
|
|
124
|
+
</div>
|
|
125
|
+
|
|
126
|
+
</div>
|
|
127
|
+
|
|
128
|
+
<!-- if includes -->
|
|
129
|
+
|
|
130
|
+
<div id="section">
|
|
131
|
+
|
|
132
|
+
|
|
133
|
+
|
|
134
|
+
<div id="attribute-list">
|
|
135
|
+
<h3 class="section-bar">Attributes</h3>
|
|
136
|
+
|
|
137
|
+
<div class="name-list">
|
|
138
|
+
<table>
|
|
139
|
+
|
|
140
|
+
<tr class="top-aligned-row context-row">
|
|
141
|
+
<td class="context-item-name">contexts</td>
|
|
142
|
+
|
|
143
|
+
<td class="context-item-value"> [RW] </td>
|
|
144
|
+
|
|
145
|
+
<td class="context-item-desc"></td>
|
|
146
|
+
</tr>
|
|
147
|
+
|
|
148
|
+
<tr class="top-aligned-row context-row">
|
|
149
|
+
<td class="context-item-name">inheritable</td>
|
|
150
|
+
|
|
151
|
+
<td class="context-item-value"> [RW] </td>
|
|
152
|
+
|
|
153
|
+
<td class="context-item-desc"></td>
|
|
154
|
+
</tr>
|
|
155
|
+
|
|
156
|
+
<tr class="top-aligned-row context-row">
|
|
157
|
+
<td class="context-item-name">keyword</td>
|
|
158
|
+
|
|
159
|
+
<td class="context-item-value"> [R] </td>
|
|
160
|
+
|
|
161
|
+
<td class="context-item-desc"></td>
|
|
162
|
+
</tr>
|
|
163
|
+
|
|
164
|
+
<tr class="top-aligned-row context-row">
|
|
165
|
+
<td class="context-item-name">pattern</td>
|
|
166
|
+
|
|
167
|
+
<td class="context-item-value"> [R] </td>
|
|
168
|
+
|
|
169
|
+
<td class="context-item-desc"></td>
|
|
170
|
+
</tr>
|
|
171
|
+
|
|
172
|
+
<tr class="top-aligned-row context-row">
|
|
173
|
+
<td class="context-item-name">predecessor</td>
|
|
174
|
+
|
|
175
|
+
<td class="context-item-value"> [RW] </td>
|
|
176
|
+
|
|
177
|
+
<td class="context-item-desc"></td>
|
|
178
|
+
</tr>
|
|
179
|
+
|
|
180
|
+
<tr class="top-aligned-row context-row">
|
|
181
|
+
<td class="context-item-name">references</td>
|
|
182
|
+
|
|
183
|
+
<td class="context-item-value"> [R] </td>
|
|
184
|
+
|
|
185
|
+
<td class="context-item-desc"></td>
|
|
186
|
+
</tr>
|
|
187
|
+
|
|
188
|
+
<tr class="top-aligned-row context-row">
|
|
189
|
+
<td class="context-item-name">scenarioSpecific</td>
|
|
190
|
+
|
|
191
|
+
<td class="context-item-value"> [RW] </td>
|
|
192
|
+
|
|
193
|
+
<td class="context-item-desc"></td>
|
|
194
|
+
</tr>
|
|
195
|
+
|
|
196
|
+
<tr class="top-aligned-row context-row">
|
|
197
|
+
<td class="context-item-name">successor</td>
|
|
198
|
+
|
|
199
|
+
<td class="context-item-value"> [RW] </td>
|
|
200
|
+
|
|
201
|
+
<td class="context-item-desc"></td>
|
|
202
|
+
</tr>
|
|
203
|
+
|
|
204
|
+
</table>
|
|
205
|
+
</div>
|
|
206
|
+
</div>
|
|
207
|
+
|
|
208
|
+
|
|
209
|
+
<!-- if method_list -->
|
|
210
|
+
|
|
211
|
+
<div id="methods">
|
|
212
|
+
|
|
213
|
+
<h3 class="section-bar">Public Class methods</h3>
|
|
214
|
+
|
|
215
|
+
|
|
216
|
+
<div id="method-M000422" class="method-detail">
|
|
217
|
+
<a name="M000422"></a>
|
|
218
|
+
|
|
219
|
+
<div class="method-heading">
|
|
220
|
+
|
|
221
|
+
<a href="#M000422" class="method-signature">
|
|
222
|
+
|
|
223
|
+
<span class="method-name">new</span><span class="method-args">(rule, pattern, syntax, args, optAttrPatterns, manual)</span>
|
|
224
|
+
|
|
225
|
+
</a>
|
|
226
|
+
|
|
227
|
+
</div>
|
|
228
|
+
|
|
229
|
+
<div class="method-description">
|
|
230
|
+
|
|
231
|
+
<p>
|
|
232
|
+
Construct a new <a
|
|
233
|
+
href="KeywordDocumentation.html">KeywordDocumentation</a> object.
|
|
234
|
+
<em>rule</em> is the <a href="TextParser/Rule.html">TextParser::Rule</a>
|
|
235
|
+
and <em>pattern</em> is the corresponding <a
|
|
236
|
+
href="TextParser/Pattern.html">TextParser::Pattern</a>. <em>syntax</em> is
|
|
237
|
+
an expanded syntax representation of the <em>pattern</em>. <em>args</em> is
|
|
238
|
+
a Array of ParserTokenDoc that describe the arguments of the
|
|
239
|
+
<em>pattern</em>. <em>optAttrPatterns</em> is an Array with references to
|
|
240
|
+
TextParser::Patterns that are optional attributes to this keyword.
|
|
241
|
+
</p>
|
|
242
|
+
|
|
243
|
+
<p><a class="source-toggle" href="#"
|
|
244
|
+
onclick="toggleCode('M000422-source');return false;">[Source]</a></p>
|
|
245
|
+
<div class="method-source-code" id="M000422-source">
|
|
246
|
+
<pre>
|
|
247
|
+
<span class="ruby-comment cmt"># File lib/KeywordDocumentation.rb, line 42</span>
|
|
248
|
+
42: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">initialize</span>(<span class="ruby-identifier">rule</span>, <span class="ruby-identifier">pattern</span>, <span class="ruby-identifier">syntax</span>, <span class="ruby-identifier">args</span>, <span class="ruby-identifier">optAttrPatterns</span>, <span class="ruby-identifier">manual</span>)
|
|
249
|
+
43: <span class="ruby-ivar">@rule</span> = <span class="ruby-identifier">rule</span>
|
|
250
|
+
44: <span class="ruby-ivar">@pattern</span> = <span class="ruby-identifier">pattern</span>
|
|
251
|
+
45: <span class="ruby-ivar">@keyword</span> = <span class="ruby-identifier">pattern</span>.<span class="ruby-identifier">keyword</span>
|
|
252
|
+
46: <span class="ruby-ivar">@syntax</span> = <span class="ruby-identifier">syntax</span>
|
|
253
|
+
47: <span class="ruby-ivar">@args</span> = <span class="ruby-identifier">args</span>
|
|
254
|
+
48: <span class="ruby-comment cmt"># Hash that maps patterns of optional attributes to a boolean value. It</span>
|
|
255
|
+
49: <span class="ruby-comment cmt"># is true if the pattern is a scenario specific attribute.</span>
|
|
256
|
+
50: <span class="ruby-ivar">@optAttrPatterns</span> = <span class="ruby-identifier">optAttrPatterns</span>
|
|
257
|
+
51: <span class="ruby-ivar">@manual</span> = <span class="ruby-identifier">manual</span>
|
|
258
|
+
52: <span class="ruby-comment cmt"># The above hash is later converted into a list that points to the</span>
|
|
259
|
+
53: <span class="ruby-comment cmt"># keyword documentation of the optional attribute.</span>
|
|
260
|
+
54: <span class="ruby-ivar">@optionalAttributes</span> = []
|
|
261
|
+
55: <span class="ruby-ivar">@scenarioSpecific</span> = <span class="ruby-keyword kw">false</span>
|
|
262
|
+
56: <span class="ruby-ivar">@inheritable</span> = <span class="ruby-keyword kw">false</span>
|
|
263
|
+
57: <span class="ruby-ivar">@contexts</span> = []
|
|
264
|
+
58: <span class="ruby-ivar">@seeAlso</span> = []
|
|
265
|
+
59: <span class="ruby-comment cmt"># The following are references to the neighboring keyword in an</span>
|
|
266
|
+
60: <span class="ruby-comment cmt"># alphabetically sorted list.</span>
|
|
267
|
+
61: <span class="ruby-ivar">@predecessor</span> = <span class="ruby-keyword kw">nil</span>
|
|
268
|
+
62: <span class="ruby-ivar">@successor</span> = <span class="ruby-keyword kw">nil</span>
|
|
269
|
+
63: <span class="ruby-comment cmt"># Array to collect all references to other RichText objects.</span>
|
|
270
|
+
64: <span class="ruby-ivar">@references</span> = []
|
|
271
|
+
65: <span class="ruby-keyword kw">end</span>
|
|
272
|
+
</pre>
|
|
273
|
+
</div>
|
|
274
|
+
|
|
275
|
+
</div>
|
|
276
|
+
</div>
|
|
277
|
+
|
|
278
|
+
|
|
279
|
+
<h3 class="section-bar">Public Instance methods</h3>
|
|
280
|
+
|
|
281
|
+
|
|
282
|
+
<div id="method-M000424" class="method-detail">
|
|
283
|
+
<a name="M000424"></a>
|
|
284
|
+
|
|
285
|
+
<div class="method-heading">
|
|
286
|
+
|
|
287
|
+
<a href="#M000424" class="method-signature">
|
|
288
|
+
|
|
289
|
+
<span class="method-name">computeInheritance</span><span class="method-args">(keywords, rules)</span>
|
|
290
|
+
|
|
291
|
+
</a>
|
|
292
|
+
|
|
293
|
+
</div>
|
|
294
|
+
|
|
295
|
+
<div class="method-description">
|
|
296
|
+
|
|
297
|
+
<p><a class="source-toggle" href="#"
|
|
298
|
+
onclick="toggleCode('M000424-source');return false;">[Source]</a></p>
|
|
299
|
+
<div class="method-source-code" id="M000424-source">
|
|
300
|
+
<pre>
|
|
301
|
+
<span class="ruby-comment cmt"># File lib/KeywordDocumentation.rb, line 104</span>
|
|
302
|
+
104: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">computeInheritance</span>(<span class="ruby-identifier">keywords</span>, <span class="ruby-identifier">rules</span>)
|
|
303
|
+
105: <span class="ruby-identifier">property</span> = <span class="ruby-keyword kw">nil</span>
|
|
304
|
+
106: <span class="ruby-ivar">@contexts</span>.<span class="ruby-identifier">each</span> <span class="ruby-keyword kw">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">kwd</span><span class="ruby-operator">|</span>
|
|
305
|
+
107: <span class="ruby-keyword kw">if</span> <span class="ruby-node">%w( task resource account shift scenario)</span>.<span class="ruby-identifier">include?</span>(<span class="ruby-identifier">kwd</span>.<span class="ruby-identifier">keyword</span>)
|
|
306
|
+
108: <span class="ruby-identifier">property</span> = <span class="ruby-identifier">kwd</span>.<span class="ruby-identifier">keyword</span>
|
|
307
|
+
109: <span class="ruby-keyword kw">break</span>
|
|
308
|
+
110: <span class="ruby-keyword kw">end</span>
|
|
309
|
+
111: <span class="ruby-keyword kw">end</span>
|
|
310
|
+
112: <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">property</span>
|
|
311
|
+
113: <span class="ruby-identifier">project</span> = <span class="ruby-constant">Project</span>.<span class="ruby-identifier">new</span>(<span class="ruby-value str">'id'</span>, <span class="ruby-value str">'dummy'</span>, <span class="ruby-value str">'1.0'</span>, <span class="ruby-keyword kw">nil</span>)
|
|
312
|
+
114: <span class="ruby-identifier">propertySet</span> = <span class="ruby-keyword kw">case</span> <span class="ruby-identifier">property</span>
|
|
313
|
+
115: <span class="ruby-keyword kw">when</span> <span class="ruby-value str">'task'</span>
|
|
314
|
+
116: <span class="ruby-identifier">project</span>.<span class="ruby-identifier">tasks</span>
|
|
315
|
+
117: <span class="ruby-keyword kw">when</span> <span class="ruby-value str">'resource'</span>
|
|
316
|
+
118: <span class="ruby-identifier">project</span>.<span class="ruby-identifier">resources</span>
|
|
317
|
+
119: <span class="ruby-keyword kw">when</span> <span class="ruby-value str">'account'</span>
|
|
318
|
+
120: <span class="ruby-identifier">project</span>.<span class="ruby-identifier">accounts</span>
|
|
319
|
+
121: <span class="ruby-keyword kw">when</span> <span class="ruby-value str">'shift'</span>
|
|
320
|
+
122: <span class="ruby-identifier">project</span>.<span class="ruby-identifier">shifts</span>
|
|
321
|
+
123: <span class="ruby-keyword kw">when</span> <span class="ruby-value str">'scenario'</span>
|
|
322
|
+
124: <span class="ruby-identifier">project</span>.<span class="ruby-identifier">scenarios</span>
|
|
323
|
+
125: <span class="ruby-keyword kw">end</span>
|
|
324
|
+
126: <span class="ruby-ivar">@inheritable</span> = <span class="ruby-identifier">propertySet</span>.<span class="ruby-identifier">inheritable?</span>(<span class="ruby-identifier">keyword</span>)
|
|
325
|
+
127: <span class="ruby-keyword kw">end</span>
|
|
326
|
+
128: <span class="ruby-keyword kw">end</span>
|
|
327
|
+
</pre>
|
|
328
|
+
</div>
|
|
329
|
+
|
|
330
|
+
</div>
|
|
331
|
+
</div>
|
|
332
|
+
|
|
333
|
+
|
|
334
|
+
<div id="method-M000423" class="method-detail">
|
|
335
|
+
<a name="M000423"></a>
|
|
336
|
+
|
|
337
|
+
<div class="method-heading">
|
|
338
|
+
|
|
339
|
+
<a href="#M000423" class="method-signature">
|
|
340
|
+
|
|
341
|
+
<span class="method-name">crossReference</span><span class="method-args">(keywords, rules)</span>
|
|
342
|
+
|
|
343
|
+
</a>
|
|
344
|
+
|
|
345
|
+
</div>
|
|
346
|
+
|
|
347
|
+
<div class="method-description">
|
|
348
|
+
|
|
349
|
+
<p>
|
|
350
|
+
Post process the class member to set cross references to other <a
|
|
351
|
+
href="KeywordDocumentation.html">KeywordDocumentation</a> items.
|
|
352
|
+
</p>
|
|
353
|
+
|
|
354
|
+
<p><a class="source-toggle" href="#"
|
|
355
|
+
onclick="toggleCode('M000423-source');return false;">[Source]</a></p>
|
|
356
|
+
<div class="method-source-code" id="M000423-source">
|
|
357
|
+
<pre>
|
|
358
|
+
<span class="ruby-comment cmt"># File lib/KeywordDocumentation.rb, line 69</span>
|
|
359
|
+
69: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">crossReference</span>(<span class="ruby-identifier">keywords</span>, <span class="ruby-identifier">rules</span>)
|
|
360
|
+
70: <span class="ruby-comment cmt"># Some arguments are references to other patterns. The current keyword</span>
|
|
361
|
+
71: <span class="ruby-comment cmt"># is added as context to such patterns.</span>
|
|
362
|
+
72: <span class="ruby-ivar">@args</span>.<span class="ruby-identifier">each</span> <span class="ruby-keyword kw">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">arg</span><span class="ruby-operator">|</span>
|
|
363
|
+
73: <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">arg</span>.<span class="ruby-identifier">pattern</span> <span class="ruby-operator">&&</span> <span class="ruby-identifier">checkReference</span>(<span class="ruby-identifier">arg</span>.<span class="ruby-identifier">pattern</span>)
|
|
364
|
+
74: <span class="ruby-identifier">kwd</span> = <span class="ruby-identifier">keywords</span>[<span class="ruby-identifier">arg</span>.<span class="ruby-identifier">pattern</span>.<span class="ruby-identifier">keyword</span>]
|
|
365
|
+
75: <span class="ruby-identifier">kwd</span>.<span class="ruby-identifier">contexts</span> <span class="ruby-operator"><<</span> <span class="ruby-keyword kw">self</span> <span class="ruby-keyword kw">unless</span> <span class="ruby-identifier">kwd</span>.<span class="ruby-identifier">contexts</span>.<span class="ruby-identifier">include?</span>(<span class="ruby-keyword kw">self</span>)
|
|
366
|
+
76: <span class="ruby-keyword kw">end</span>
|
|
367
|
+
77: <span class="ruby-keyword kw">end</span>
|
|
368
|
+
78:
|
|
369
|
+
79: <span class="ruby-comment cmt"># Optional attributes are treated similarly. In addition we add them to</span>
|
|
370
|
+
80: <span class="ruby-comment cmt"># the @optionalAttributes list of this keyword.</span>
|
|
371
|
+
81: <span class="ruby-ivar">@optAttrPatterns</span>.<span class="ruby-identifier">each</span> <span class="ruby-keyword kw">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">pattern</span>, <span class="ruby-identifier">scenarioSpecific</span><span class="ruby-operator">|</span>
|
|
372
|
+
82: <span class="ruby-keyword kw">next</span> <span class="ruby-keyword kw">unless</span> <span class="ruby-identifier">checkReference</span>(<span class="ruby-identifier">pattern</span>)
|
|
373
|
+
83:
|
|
374
|
+
84: <span class="ruby-keyword kw">if</span> (<span class="ruby-identifier">kwd</span> = <span class="ruby-identifier">keywords</span>[<span class="ruby-identifier">pattern</span>.<span class="ruby-identifier">keyword</span>]).<span class="ruby-identifier">nil?</span>
|
|
375
|
+
85: <span class="ruby-identifier">token</span> = <span class="ruby-identifier">pattern</span>.<span class="ruby-identifier">terminalToken</span>(<span class="ruby-identifier">rules</span>)
|
|
376
|
+
86: <span class="ruby-identifier">$stderr</span>.<span class="ruby-identifier">puts</span> <span class="ruby-node">"Keyword #{keyword} has undocumented optional "</span> <span class="ruby-operator">+</span>
|
|
377
|
+
87: <span class="ruby-node">"attribute #{token[0]}"</span>
|
|
378
|
+
88: <span class="ruby-keyword kw">else</span>
|
|
379
|
+
89: <span class="ruby-ivar">@optionalAttributes</span> <span class="ruby-operator"><<</span> <span class="ruby-identifier">kwd</span>
|
|
380
|
+
90: <span class="ruby-identifier">kwd</span>.<span class="ruby-identifier">contexts</span> <span class="ruby-operator"><<</span> <span class="ruby-keyword kw">self</span> <span class="ruby-keyword kw">unless</span> <span class="ruby-identifier">kwd</span>.<span class="ruby-identifier">contexts</span>.<span class="ruby-identifier">include?</span>(<span class="ruby-keyword kw">self</span>)
|
|
381
|
+
91: <span class="ruby-identifier">kwd</span>.<span class="ruby-identifier">scenarioSpecific</span> = <span class="ruby-keyword kw">true</span> <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">scenarioSpecific</span>
|
|
382
|
+
92: <span class="ruby-keyword kw">end</span>
|
|
383
|
+
93: <span class="ruby-keyword kw">end</span>
|
|
384
|
+
94:
|
|
385
|
+
95: <span class="ruby-comment cmt"># Resolve the seeAlso patterns to keyword references.</span>
|
|
386
|
+
96: <span class="ruby-ivar">@pattern</span>.<span class="ruby-identifier">seeAlso</span>.<span class="ruby-identifier">sort</span>.<span class="ruby-identifier">each</span> <span class="ruby-keyword kw">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">also</span><span class="ruby-operator">|</span>
|
|
387
|
+
97: <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">keywords</span>[<span class="ruby-identifier">also</span>].<span class="ruby-identifier">nil?</span>
|
|
388
|
+
98: <span class="ruby-identifier">raise</span> <span class="ruby-node">"See also reference #{also} of #{@pattern} is unknown"</span>
|
|
389
|
+
99: <span class="ruby-keyword kw">end</span>
|
|
390
|
+
100: <span class="ruby-ivar">@seeAlso</span> <span class="ruby-operator"><<</span> <span class="ruby-identifier">keywords</span>[<span class="ruby-identifier">also</span>]
|
|
391
|
+
101: <span class="ruby-keyword kw">end</span>
|
|
392
|
+
102: <span class="ruby-keyword kw">end</span>
|
|
393
|
+
</pre>
|
|
394
|
+
</div>
|
|
395
|
+
|
|
396
|
+
</div>
|
|
397
|
+
</div>
|
|
398
|
+
|
|
399
|
+
|
|
400
|
+
<div id="method-M000427" class="method-detail">
|
|
401
|
+
<a name="M000427"></a>
|
|
402
|
+
|
|
403
|
+
<div class="method-heading">
|
|
404
|
+
|
|
405
|
+
<a href="#M000427" class="method-signature">
|
|
406
|
+
|
|
407
|
+
<span class="method-name">generateHTML</span><span class="method-args">(directory)</span>
|
|
408
|
+
|
|
409
|
+
</a>
|
|
410
|
+
|
|
411
|
+
</div>
|
|
412
|
+
|
|
413
|
+
<div class="method-description">
|
|
414
|
+
|
|
415
|
+
<p>
|
|
416
|
+
Return a <a href="../String.html">String</a> that represents the keyword
|
|
417
|
+
documentation in an XML formatted form.
|
|
418
|
+
</p>
|
|
419
|
+
|
|
420
|
+
<p><a class="source-toggle" href="#"
|
|
421
|
+
onclick="toggleCode('M000427-source');return false;">[Source]</a></p>
|
|
422
|
+
<div class="method-source-code" id="M000427-source">
|
|
423
|
+
<pre>
|
|
424
|
+
<span class="ruby-comment cmt"># File lib/KeywordDocumentation.rb, line 237</span>
|
|
425
|
+
237: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">generateHTML</span>(<span class="ruby-identifier">directory</span>)
|
|
426
|
+
238: <span class="ruby-identifier">html</span> = <span class="ruby-constant">HTMLDocument</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">:transitional</span>)
|
|
427
|
+
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>))
|
|
428
|
+
240: <span class="ruby-identifier">head</span> <span class="ruby-operator"><<</span> <span class="ruby-constant">XMLNamedText</span>.<span class="ruby-identifier">new</span>(<span class="ruby-node">"#{keyword}"</span>, <span class="ruby-value str">'title'</span>) <span class="ruby-operator"><<</span>
|
|
429
|
+
241: <span class="ruby-ivar">@manual</span>.<span class="ruby-identifier">generateStyleSheet</span>
|
|
430
|
+
242:
|
|
431
|
+
243: <span class="ruby-identifier">html</span> <span class="ruby-operator"><<</span> (<span class="ruby-identifier">body</span> = <span class="ruby-constant">XMLElement</span>.<span class="ruby-identifier">new</span>(<span class="ruby-value str">'body'</span>))
|
|
432
|
+
244: <span class="ruby-identifier">body</span> <span class="ruby-operator"><<</span> <span class="ruby-ivar">@manual</span>.<span class="ruby-identifier">generateHTMLHeader</span> <span class="ruby-operator"><<</span>
|
|
433
|
+
245: <span class="ruby-identifier">generateHTMLNavigationBar</span>
|
|
434
|
+
246:
|
|
435
|
+
247: <span class="ruby-comment cmt"># Box with keyword name.</span>
|
|
436
|
+
248: <span class="ruby-identifier">body</span> <span class="ruby-operator"><<</span> (<span class="ruby-identifier">bbox</span> = <span class="ruby-constant">XMLElement</span>.<span class="ruby-identifier">new</span>(<span class="ruby-value str">'div'</span>,
|
|
437
|
+
249: <span class="ruby-value str">'style'</span> =<span class="ruby-operator">></span> <span class="ruby-value str">'margin-left:5%; margin-right:5%'</span>))
|
|
438
|
+
250: <span class="ruby-identifier">bbox</span> <span class="ruby-operator"><<</span> (<span class="ruby-identifier">p</span> = <span class="ruby-constant">XMLElement</span>.<span class="ruby-identifier">new</span>(<span class="ruby-value str">'p'</span>))
|
|
439
|
+
251: <span class="ruby-identifier">p</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>, <span class="ruby-value str">'align'</span> =<span class="ruby-operator">></span> <span class="ruby-value str">'center'</span>,
|
|
440
|
+
252: <span class="ruby-value str">'class'</span> =<span class="ruby-operator">></span> <span class="ruby-value str">'table'</span>))
|
|
441
|
+
253:
|
|
442
|
+
254: <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>, <span class="ruby-value str">'align'</span> =<span class="ruby-operator">></span> <span class="ruby-value str">'left'</span>))
|
|
443
|
+
255: <span class="ruby-identifier">tr</span> <span class="ruby-operator"><<</span> <span class="ruby-constant">XMLNamedText</span>.<span class="ruby-identifier">new</span>(<span class="ruby-value str">'Keyword'</span>, <span class="ruby-value str">'td'</span>, <span class="ruby-value str">'class'</span> =<span class="ruby-operator">></span> <span class="ruby-value str">'tag'</span>,
|
|
444
|
+
256: <span class="ruby-value str">'style'</span> =<span class="ruby-operator">></span> <span class="ruby-value str">'width:15%'</span>)
|
|
445
|
+
257: <span class="ruby-identifier">tr</span> <span class="ruby-operator"><<</span> <span class="ruby-constant">XMLNamedText</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">title</span>, <span class="ruby-value str">'td'</span>, <span class="ruby-value str">'class'</span> =<span class="ruby-operator">></span> <span class="ruby-value str">'descr'</span>,
|
|
446
|
+
258: <span class="ruby-value str">'style'</span> =<span class="ruby-operator">></span> <span class="ruby-value str">'width:85%; font-weight:bold'</span>)
|
|
447
|
+
259:
|
|
448
|
+
260: <span class="ruby-comment cmt"># Box with purpose, syntax, arguments and context.</span>
|
|
449
|
+
261: <span class="ruby-identifier">bbox</span> <span class="ruby-operator"><<</span> (<span class="ruby-identifier">p</span> = <span class="ruby-constant">XMLElement</span>.<span class="ruby-identifier">new</span>(<span class="ruby-value str">'p'</span>))
|
|
450
|
+
262: <span class="ruby-identifier">p</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>, <span class="ruby-value str">'align'</span> =<span class="ruby-operator">></span> <span class="ruby-value str">'center'</span>,
|
|
451
|
+
263: <span class="ruby-value str">'class'</span> =<span class="ruby-operator">></span> <span class="ruby-value str">'table'</span>))
|
|
452
|
+
264: <span class="ruby-identifier">tab</span> <span class="ruby-operator"><<</span> (<span class="ruby-identifier">colgroup</span> = <span class="ruby-constant">XMLElement</span>.<span class="ruby-identifier">new</span>(<span class="ruby-value str">'colgroup'</span>))
|
|
453
|
+
265: <span class="ruby-identifier">colgroup</span> <span class="ruby-operator"><<</span> <span class="ruby-constant">XMLElement</span>.<span class="ruby-identifier">new</span>(<span class="ruby-value str">'col'</span>, <span class="ruby-value str">'width'</span> =<span class="ruby-operator">></span> <span class="ruby-value str">'15%'</span>)
|
|
454
|
+
266: <span class="ruby-identifier">colgroup</span> <span class="ruby-operator"><<</span> <span class="ruby-constant">XMLElement</span>.<span class="ruby-identifier">new</span>(<span class="ruby-value str">'col'</span>, <span class="ruby-value str">'width'</span> =<span class="ruby-operator">></span> <span class="ruby-value str">'85%'</span>)
|
|
455
|
+
267:
|
|
456
|
+
268: <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>, <span class="ruby-value str">'align'</span> =<span class="ruby-operator">></span> <span class="ruby-value str">'left'</span>))
|
|
457
|
+
269: <span class="ruby-identifier">tr</span> <span class="ruby-operator"><<</span> <span class="ruby-constant">XMLNamedText</span>.<span class="ruby-identifier">new</span>(<span class="ruby-value str">'Purpose'</span>, <span class="ruby-value str">'td'</span>, <span class="ruby-value str">'class'</span> =<span class="ruby-operator">></span> <span class="ruby-value str">'tag'</span>)
|
|
458
|
+
270: <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>, <span class="ruby-value str">'class'</span> =<span class="ruby-operator">></span> <span class="ruby-value str">'descr'</span>))
|
|
459
|
+
271: <span class="ruby-identifier">td</span> <span class="ruby-operator"><<</span> <span class="ruby-identifier">newRichText</span>(<span class="ruby-ivar">@pattern</span>.<span class="ruby-identifier">doc</span>).<span class="ruby-identifier">to_html</span>
|
|
460
|
+
272: <span class="ruby-keyword kw">if</span> <span class="ruby-ivar">@syntax</span> <span class="ruby-operator">!=</span> <span class="ruby-value str">'[{ <attributes> }]'</span>
|
|
461
|
+
273: <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>, <span class="ruby-value str">'align'</span> =<span class="ruby-operator">></span> <span class="ruby-value str">'left'</span>))
|
|
462
|
+
274: <span class="ruby-identifier">tr</span> <span class="ruby-operator"><<</span> <span class="ruby-constant">XMLNamedText</span>.<span class="ruby-identifier">new</span>(<span class="ruby-value str">'Syntax'</span>, <span class="ruby-value str">'td'</span>, <span class="ruby-value str">'class'</span> =<span class="ruby-operator">></span> <span class="ruby-value str">'tag'</span>)
|
|
463
|
+
275: <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>, <span class="ruby-value str">'class'</span> =<span class="ruby-operator">></span> <span class="ruby-value str">'descr'</span>))
|
|
464
|
+
276: <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-node">"#{@syntax}"</span>, <span class="ruby-value str">'code'</span>)
|
|
465
|
+
277:
|
|
466
|
+
278: <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>, <span class="ruby-value str">'align'</span> =<span class="ruby-operator">></span> <span class="ruby-value str">'left'</span>))
|
|
467
|
+
279: <span class="ruby-identifier">tr</span> <span class="ruby-operator"><<</span> <span class="ruby-constant">XMLNamedText</span>.<span class="ruby-identifier">new</span>(<span class="ruby-value str">'Arguments'</span>, <span class="ruby-value str">'td'</span>, <span class="ruby-value str">'class'</span> =<span class="ruby-operator">></span> <span class="ruby-value str">'tag'</span>)
|
|
468
|
+
280: <span class="ruby-keyword kw">if</span> <span class="ruby-ivar">@args</span>.<span class="ruby-identifier">empty?</span>
|
|
469
|
+
281: <span class="ruby-identifier">tr</span> <span class="ruby-operator"><<</span> <span class="ruby-constant">XMLNamedText</span>.<span class="ruby-identifier">new</span>(<span class="ruby-value str">'none'</span>, <span class="ruby-value str">'td'</span>, <span class="ruby-value str">'class'</span> =<span class="ruby-operator">></span> <span class="ruby-value str">'descr'</span>)
|
|
470
|
+
282: <span class="ruby-keyword kw">else</span>
|
|
471
|
+
283: <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>, <span class="ruby-value str">'class'</span> =<span class="ruby-operator">></span> <span class="ruby-value str">'descr'</span>))
|
|
472
|
+
284: <span class="ruby-identifier">td</span> <span class="ruby-operator"><<</span> (<span class="ruby-identifier">tab1</span> = <span class="ruby-constant">XMLElement</span>.<span class="ruby-identifier">new</span>(<span class="ruby-value str">'table'</span>, <span class="ruby-value str">'width'</span> =<span class="ruby-operator">></span> <span class="ruby-value str">'100%'</span>))
|
|
473
|
+
285: <span class="ruby-ivar">@args</span>.<span class="ruby-identifier">each</span> <span class="ruby-keyword kw">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">arg</span><span class="ruby-operator">|</span>
|
|
474
|
+
286: <span class="ruby-identifier">tab1</span> <span class="ruby-operator"><<</span> (<span class="ruby-identifier">tr1</span> = <span class="ruby-constant">XMLElement</span>.<span class="ruby-identifier">new</span>(<span class="ruby-value str">'tr'</span>))
|
|
475
|
+
287: <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">arg</span>.<span class="ruby-identifier">typeSpec</span>.<span class="ruby-identifier">nil?</span> <span class="ruby-operator">||</span> (<span class="ruby-value str">'<'</span> <span class="ruby-operator">+</span> <span class="ruby-identifier">arg</span>.<span class="ruby-identifier">name</span> <span class="ruby-operator">+</span> <span class="ruby-value str">'>'</span>) <span class="ruby-operator">==</span> <span class="ruby-identifier">arg</span>.<span class="ruby-identifier">typeSpec</span>
|
|
476
|
+
288: <span class="ruby-identifier">tr1</span> <span class="ruby-operator"><<</span> <span class="ruby-constant">XMLNamedText</span>.<span class="ruby-identifier">new</span>(<span class="ruby-node">"#{arg.name}"</span>, <span class="ruby-value str">'td'</span>, <span class="ruby-value str">'width'</span> =<span class="ruby-operator">></span> <span class="ruby-value str">'30%'</span>)
|
|
477
|
+
289: <span class="ruby-keyword kw">else</span>
|
|
478
|
+
290: <span class="ruby-identifier">typeSpec</span> = <span class="ruby-identifier">arg</span>.<span class="ruby-identifier">typeSpec</span>
|
|
479
|
+
291: <span class="ruby-identifier">typeSpec</span>[<span class="ruby-value">0</span>] = <span class="ruby-value str">'['</span>
|
|
480
|
+
292: <span class="ruby-identifier">typeSpec</span>[<span class="ruby-value">-1</span>] = <span class="ruby-value str">']'</span>
|
|
481
|
+
293: <span class="ruby-identifier">tr1</span> <span class="ruby-operator"><<</span> <span class="ruby-constant">XMLNamedText</span>.<span class="ruby-identifier">new</span>(<span class="ruby-node">"#{arg.name} #{typeSpec}"</span>, <span class="ruby-value str">'td'</span>,
|
|
482
|
+
294: <span class="ruby-value str">'width'</span> =<span class="ruby-operator">></span> <span class="ruby-value str">'30%'</span>)
|
|
483
|
+
295: <span class="ruby-keyword kw">end</span>
|
|
484
|
+
296: <span class="ruby-identifier">tr1</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>,
|
|
485
|
+
297: <span class="ruby-value str">'style'</span> =<span class="ruby-operator">></span> <span class="ruby-value str">'margin-top:2px; margin-bottom:2px;'</span>))
|
|
486
|
+
298: <span class="ruby-identifier">td</span> <span class="ruby-operator"><<</span> <span class="ruby-identifier">newRichText</span>(<span class="ruby-identifier">arg</span>.<span class="ruby-identifier">text</span> <span class="ruby-operator">||</span>
|
|
487
|
+
299: <span class="ruby-node">"See [[#{arg.name}]] for details."</span>).<span class="ruby-identifier">to_html</span>
|
|
488
|
+
300: <span class="ruby-keyword kw">end</span>
|
|
489
|
+
301: <span class="ruby-keyword kw">end</span>
|
|
490
|
+
302: <span class="ruby-keyword kw">end</span>
|
|
491
|
+
303:
|
|
492
|
+
304: <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>, <span class="ruby-value str">'align'</span> =<span class="ruby-operator">></span> <span class="ruby-value str">'left'</span>))
|
|
493
|
+
305: <span class="ruby-identifier">tr</span> <span class="ruby-operator"><<</span> <span class="ruby-constant">XMLNamedText</span>.<span class="ruby-identifier">new</span>(<span class="ruby-value str">'Context'</span>, <span class="ruby-value str">'td'</span>, <span class="ruby-value str">'class'</span> =<span class="ruby-operator">></span> <span class="ruby-value str">'tag'</span>)
|
|
494
|
+
306: <span class="ruby-keyword kw">if</span> <span class="ruby-ivar">@contexts</span>.<span class="ruby-identifier">empty?</span>
|
|
495
|
+
307: <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>, <span class="ruby-value str">'class'</span> =<span class="ruby-operator">></span> <span class="ruby-value str">'descr'</span>))
|
|
496
|
+
308: <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">'Global scope'</span>, <span class="ruby-value str">'a'</span>,
|
|
497
|
+
309: <span class="ruby-value str">'href'</span> =<span class="ruby-operator">></span> <span class="ruby-value str">'Getting_Started.html#Structure_of_a_TJP_File'</span>)
|
|
498
|
+
310: <span class="ruby-keyword kw">else</span>
|
|
499
|
+
311: <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>, <span class="ruby-value str">'class'</span> =<span class="ruby-operator">></span> <span class="ruby-value str">'descr'</span>))
|
|
500
|
+
312: <span class="ruby-identifier">first</span> = <span class="ruby-keyword kw">true</span>
|
|
501
|
+
313: <span class="ruby-ivar">@contexts</span>.<span class="ruby-identifier">each</span> <span class="ruby-keyword kw">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">context</span><span class="ruby-operator">|</span>
|
|
502
|
+
314: <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">first</span>
|
|
503
|
+
315: <span class="ruby-identifier">first</span> = <span class="ruby-keyword kw">false</span>
|
|
504
|
+
316: <span class="ruby-keyword kw">else</span>
|
|
505
|
+
317: <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>)
|
|
506
|
+
318: <span class="ruby-keyword kw">end</span>
|
|
507
|
+
319: <span class="ruby-identifier">keywordHTMLRef</span>(<span class="ruby-identifier">td</span>, <span class="ruby-identifier">context</span>)
|
|
508
|
+
320: <span class="ruby-keyword kw">end</span>
|
|
509
|
+
321: <span class="ruby-keyword kw">end</span>
|
|
510
|
+
322:
|
|
511
|
+
323: <span class="ruby-keyword kw">unless</span> <span class="ruby-ivar">@seeAlso</span>.<span class="ruby-identifier">empty?</span>
|
|
512
|
+
324: <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>, <span class="ruby-value str">'align'</span> =<span class="ruby-operator">></span> <span class="ruby-value str">'left'</span>))
|
|
513
|
+
325: <span class="ruby-identifier">tr</span> <span class="ruby-operator"><<</span> <span class="ruby-constant">XMLNamedText</span>.<span class="ruby-identifier">new</span>(<span class="ruby-value str">'See also'</span>, <span class="ruby-value str">'td'</span>, <span class="ruby-value str">'class'</span> =<span class="ruby-operator">></span> <span class="ruby-value str">'tag'</span>)
|
|
514
|
+
326: <span class="ruby-identifier">first</span> = <span class="ruby-keyword kw">true</span>
|
|
515
|
+
327: <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>, <span class="ruby-value str">'class'</span> =<span class="ruby-operator">></span> <span class="ruby-value str">'descr'</span>))
|
|
516
|
+
328: <span class="ruby-ivar">@seeAlso</span>.<span class="ruby-identifier">each</span> <span class="ruby-keyword kw">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">also</span><span class="ruby-operator">|</span>
|
|
517
|
+
329: <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">first</span>
|
|
518
|
+
330: <span class="ruby-identifier">first</span> = <span class="ruby-keyword kw">false</span>
|
|
519
|
+
331: <span class="ruby-keyword kw">else</span>
|
|
520
|
+
332: <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>)
|
|
521
|
+
333: <span class="ruby-keyword kw">end</span>
|
|
522
|
+
334: <span class="ruby-identifier">keywordHTMLRef</span>(<span class="ruby-identifier">td</span>, <span class="ruby-identifier">also</span>)
|
|
523
|
+
335: <span class="ruby-keyword kw">end</span>
|
|
524
|
+
336: <span class="ruby-keyword kw">end</span>
|
|
525
|
+
337:
|
|
526
|
+
338: <span class="ruby-comment cmt"># Box with attributes.</span>
|
|
527
|
+
339: <span class="ruby-keyword kw">unless</span> <span class="ruby-ivar">@optionalAttributes</span>.<span class="ruby-identifier">empty?</span>
|
|
528
|
+
340: <span class="ruby-ivar">@optionalAttributes</span>.<span class="ruby-identifier">sort!</span> <span class="ruby-keyword kw">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">a</span>, <span class="ruby-identifier">b</span><span class="ruby-operator">|</span>
|
|
529
|
+
341: <span class="ruby-identifier">a</span>.<span class="ruby-identifier">keyword</span> <span class="ruby-operator"><=></span> <span class="ruby-identifier">b</span>.<span class="ruby-identifier">keyword</span>
|
|
530
|
+
342: <span class="ruby-keyword kw">end</span>
|
|
531
|
+
343: <span class="ruby-identifier">hasScenSpec</span> = <span class="ruby-identifier">hasInheritable</span> = <span class="ruby-keyword kw">false</span>
|
|
532
|
+
344: <span class="ruby-identifier">none</span> = []
|
|
533
|
+
345: <span class="ruby-identifier">scenSpec</span> = []
|
|
534
|
+
346: <span class="ruby-identifier">inheritable</span> = []
|
|
535
|
+
347: <span class="ruby-identifier">scenSpecInheritable</span> = []
|
|
536
|
+
348: <span class="ruby-ivar">@optionalAttributes</span>.<span class="ruby-identifier">each</span> <span class="ruby-keyword kw">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">attr</span><span class="ruby-operator">|</span>
|
|
537
|
+
349: <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">attr</span>.<span class="ruby-identifier">inheritable</span>
|
|
538
|
+
350: <span class="ruby-identifier">hasInheritable</span> = <span class="ruby-keyword kw">true</span>
|
|
539
|
+
351: <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">attr</span>.<span class="ruby-identifier">scenarioSpecific</span>
|
|
540
|
+
352: <span class="ruby-identifier">hasScenSpec</span> = <span class="ruby-keyword kw">true</span>
|
|
541
|
+
353: <span class="ruby-identifier">scenSpecInheritable</span> <span class="ruby-operator"><<</span> <span class="ruby-identifier">attr</span>
|
|
542
|
+
354: <span class="ruby-keyword kw">else</span>
|
|
543
|
+
355: <span class="ruby-identifier">inheritable</span> <span class="ruby-operator"><<</span> <span class="ruby-identifier">attr</span>
|
|
544
|
+
356: <span class="ruby-keyword kw">end</span>
|
|
545
|
+
357: <span class="ruby-keyword kw">else</span>
|
|
546
|
+
358: <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">attr</span>.<span class="ruby-identifier">scenarioSpecific</span>
|
|
547
|
+
359: <span class="ruby-identifier">hasScenSpec</span> = <span class="ruby-keyword kw">true</span>
|
|
548
|
+
360: <span class="ruby-identifier">scenSpec</span> <span class="ruby-operator"><<</span> <span class="ruby-identifier">attr</span>
|
|
549
|
+
361: <span class="ruby-keyword kw">else</span>
|
|
550
|
+
362: <span class="ruby-identifier">none</span> <span class="ruby-operator"><<</span> <span class="ruby-identifier">attr</span>
|
|
551
|
+
363: <span class="ruby-keyword kw">end</span>
|
|
552
|
+
364: <span class="ruby-keyword kw">end</span>
|
|
553
|
+
365: <span class="ruby-keyword kw">end</span>
|
|
554
|
+
366: <span class="ruby-identifier">bbox</span> <span class="ruby-operator"><<</span> (<span class="ruby-identifier">p</span> = <span class="ruby-constant">XMLElement</span>.<span class="ruby-identifier">new</span>(<span class="ruby-value str">'p'</span>))
|
|
555
|
+
367: <span class="ruby-identifier">p</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>, <span class="ruby-value str">'align'</span> =<span class="ruby-operator">></span> <span class="ruby-value str">'center'</span>,
|
|
556
|
+
368: <span class="ruby-value str">'class'</span> =<span class="ruby-operator">></span> <span class="ruby-value str">'table'</span>))
|
|
557
|
+
369: <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>, <span class="ruby-value str">'align'</span> =<span class="ruby-operator">></span> <span class="ruby-value str">'left'</span>))
|
|
558
|
+
370: <span class="ruby-identifier">tr</span> <span class="ruby-operator"><<</span> <span class="ruby-constant">XMLNamedText</span>.<span class="ruby-identifier">new</span>(<span class="ruby-value str">'Attributes'</span>, <span class="ruby-value str">'td'</span>, <span class="ruby-value str">'class'</span> =<span class="ruby-operator">></span> <span class="ruby-value str">'tag'</span>,
|
|
559
|
+
371: <span class="ruby-value str">'style'</span> =<span class="ruby-operator">></span> <span class="ruby-value str">'width:15%'</span>)
|
|
560
|
+
372: <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">hasScenSpec</span> <span class="ruby-operator">||</span> <span class="ruby-identifier">hasInheritable</span>
|
|
561
|
+
373: <span class="ruby-identifier">tr</span> <span class="ruby-operator"><<</span> <span class="ruby-constant">XMLNamedText</span>.<span class="ruby-identifier">new</span>(<span class="ruby-value str">'Scenario specific'</span>, <span class="ruby-value str">'td'</span>, <span class="ruby-value str">'class'</span> =<span class="ruby-operator">></span> <span class="ruby-value str">'tag'</span>,
|
|
562
|
+
374: <span class="ruby-value str">'style'</span> =<span class="ruby-operator">></span> <span class="ruby-value str">'width:42%'</span>)
|
|
563
|
+
375: <span class="ruby-identifier">tr</span> <span class="ruby-operator"><<</span> <span class="ruby-constant">XMLNamedText</span>.<span class="ruby-identifier">new</span>(<span class="ruby-value str">'Not scenario specific'</span>, <span class="ruby-value str">'td'</span>, <span class="ruby-value str">'class'</span> =<span class="ruby-operator">></span> <span class="ruby-value str">'tag'</span>,
|
|
564
|
+
376: <span class="ruby-value str">'style'</span> =<span class="ruby-operator">></span> <span class="ruby-value str">'width:43%'</span>)
|
|
565
|
+
377: <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>, <span class="ruby-value str">'align'</span> =<span class="ruby-operator">></span> <span class="ruby-value str">'left'</span>))
|
|
566
|
+
378: <span class="ruby-identifier">tr</span> <span class="ruby-operator"><<</span> <span class="ruby-constant">XMLNamedText</span>.<span class="ruby-identifier">new</span>(<span class="ruby-value str">'Inheritable'</span>, <span class="ruby-value str">'td'</span>, <span class="ruby-value str">'class'</span> =<span class="ruby-operator">></span> <span class="ruby-value str">'tag'</span>,
|
|
567
|
+
379: <span class="ruby-value str">'style'</span> =<span class="ruby-operator">></span> <span class="ruby-value str">'width:15%'</span>)
|
|
568
|
+
380: <span class="ruby-identifier">tr</span> <span class="ruby-operator"><<</span> <span class="ruby-identifier">listHTMLAttributes</span>(<span class="ruby-identifier">scenSpecInheritable</span>, <span class="ruby-value">42</span>)
|
|
569
|
+
381: <span class="ruby-identifier">tr</span> <span class="ruby-operator"><<</span> <span class="ruby-identifier">listHTMLAttributes</span>(<span class="ruby-identifier">inheritable</span>, <span class="ruby-value">43</span>)
|
|
570
|
+
382: <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>, <span class="ruby-value str">'align'</span> =<span class="ruby-operator">></span> <span class="ruby-value str">'left'</span>))
|
|
571
|
+
383: <span class="ruby-identifier">tr</span> <span class="ruby-operator"><<</span> <span class="ruby-constant">XMLNamedText</span>.<span class="ruby-identifier">new</span>(<span class="ruby-value str">'Not inheritable'</span>, <span class="ruby-value str">'td'</span>, <span class="ruby-value str">'class'</span> =<span class="ruby-operator">></span> <span class="ruby-value str">'tag'</span>,
|
|
572
|
+
384: <span class="ruby-value str">'style'</span> =<span class="ruby-operator">></span> <span class="ruby-value str">'width:15%'</span>)
|
|
573
|
+
385: <span class="ruby-identifier">tr</span> <span class="ruby-operator"><<</span> <span class="ruby-identifier">listHTMLAttributes</span>(<span class="ruby-identifier">scenSpec</span>, <span class="ruby-value">42</span>)
|
|
574
|
+
386: <span class="ruby-identifier">tr</span> <span class="ruby-operator"><<</span> <span class="ruby-identifier">listHTMLAttributes</span>(<span class="ruby-identifier">none</span>, <span class="ruby-value">43</span>)
|
|
575
|
+
387: <span class="ruby-keyword kw">else</span>
|
|
576
|
+
388: <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>, <span class="ruby-value str">'class'</span> =<span class="ruby-operator">></span> <span class="ruby-value str">'descr'</span>))
|
|
577
|
+
389: <span class="ruby-identifier">first</span> = <span class="ruby-keyword kw">true</span>
|
|
578
|
+
390: <span class="ruby-ivar">@optionalAttributes</span>.<span class="ruby-identifier">each</span> <span class="ruby-keyword kw">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">attr</span><span class="ruby-operator">|</span>
|
|
579
|
+
391: <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">first</span>
|
|
580
|
+
392: <span class="ruby-identifier">first</span> = <span class="ruby-keyword kw">false</span>
|
|
581
|
+
393: <span class="ruby-keyword kw">else</span>
|
|
582
|
+
394: <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>)
|
|
583
|
+
395: <span class="ruby-keyword kw">end</span>
|
|
584
|
+
396: <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">'[sc:]'</span>) <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">attr</span>.<span class="ruby-identifier">scenarioSpecific</span>
|
|
585
|
+
397: <span class="ruby-identifier">keywordHTMLRef</span>(<span class="ruby-identifier">td</span>, <span class="ruby-identifier">attr</span>)
|
|
586
|
+
398: <span class="ruby-keyword kw">end</span>
|
|
587
|
+
399: <span class="ruby-keyword kw">end</span>
|
|
588
|
+
400: <span class="ruby-keyword kw">end</span>
|
|
589
|
+
401:
|
|
590
|
+
402: <span class="ruby-keyword kw">if</span> <span class="ruby-ivar">@pattern</span>.<span class="ruby-identifier">exampleFile</span>
|
|
591
|
+
403: <span class="ruby-identifier">exampleDir</span> = <span class="ruby-constant">AppConfig</span>.<span class="ruby-identifier">dataDirs</span>(<span class="ruby-value str">'test'</span>)[<span class="ruby-value">0</span>] <span class="ruby-operator">+</span> <span class="ruby-value str">"TestSuite/Syntax/Correct/"</span>
|
|
592
|
+
404: <span class="ruby-identifier">example</span> = <span class="ruby-constant">TjpExample</span>.<span class="ruby-identifier">new</span>
|
|
593
|
+
405: <span class="ruby-identifier">fileName</span> = <span class="ruby-node">"#{exampleDir}/#{@pattern.exampleFile}.tjp"</span>
|
|
594
|
+
406: <span class="ruby-identifier">example</span>.<span class="ruby-identifier">open</span>(<span class="ruby-identifier">fileName</span>)
|
|
595
|
+
407: <span class="ruby-identifier">bbox</span> <span class="ruby-operator"><<</span> (<span class="ruby-identifier">frame</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">'class'</span> =<span class="ruby-operator">></span> <span class="ruby-value str">'codeframe'</span>))
|
|
596
|
+
408: <span class="ruby-identifier">frame</span> <span class="ruby-operator"><<</span> (<span class="ruby-identifier">pre</span> = <span class="ruby-constant">XMLElement</span>.<span class="ruby-identifier">new</span>(<span class="ruby-value str">'pre'</span>, <span class="ruby-value str">'class'</span> =<span class="ruby-operator">></span> <span class="ruby-value str">'code'</span>))
|
|
597
|
+
409: <span class="ruby-keyword kw">unless</span> (<span class="ruby-identifier">text</span> = <span class="ruby-identifier">example</span>.<span class="ruby-identifier">to_s</span>(<span class="ruby-ivar">@pattern</span>.<span class="ruby-identifier">exampleTag</span>))
|
|
598
|
+
410: <span class="ruby-identifier">raise</span> <span class="ruby-node">"There is no tag '#{@pattern.exampleTag}' in file "</span> <span class="ruby-operator">+</span>
|
|
599
|
+
411: <span class="ruby-node">"#{fileName}."</span>
|
|
600
|
+
412: <span class="ruby-keyword kw">end</span>
|
|
601
|
+
413: <span class="ruby-identifier">pre</span> <span class="ruby-operator"><<</span> <span class="ruby-constant">XMLText</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">text</span>)
|
|
602
|
+
414: <span class="ruby-keyword kw">end</span>
|
|
603
|
+
415:
|
|
604
|
+
416: <span class="ruby-identifier">body</span> <span class="ruby-operator"><<</span> <span class="ruby-identifier">generateHTMLNavigationBar</span>
|
|
605
|
+
417: <span class="ruby-identifier">body</span> <span class="ruby-operator"><<</span> <span class="ruby-ivar">@manual</span>.<span class="ruby-identifier">generateHTMLFooter</span>
|
|
606
|
+
418:
|
|
607
|
+
419: <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">directory</span>
|
|
608
|
+
420: <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-node">"#{keyword}.html"</span>)
|
|
609
|
+
421: <span class="ruby-keyword kw">else</span>
|
|
610
|
+
422: <span class="ruby-identifier">puts</span> <span class="ruby-identifier">html</span>.<span class="ruby-identifier">to_s</span>
|
|
611
|
+
423: <span class="ruby-keyword kw">end</span>
|
|
612
|
+
424: <span class="ruby-keyword kw">end</span>
|
|
613
|
+
</pre>
|
|
614
|
+
</div>
|
|
615
|
+
|
|
616
|
+
</div>
|
|
617
|
+
</div>
|
|
618
|
+
|
|
619
|
+
|
|
620
|
+
<div id="method-M000425" class="method-detail">
|
|
621
|
+
<a name="M000425"></a>
|
|
622
|
+
|
|
623
|
+
<div class="method-heading">
|
|
624
|
+
|
|
625
|
+
<a href="#M000425" class="method-signature">
|
|
626
|
+
|
|
627
|
+
<span class="method-name">title</span><span class="method-args">()</span>
|
|
628
|
+
|
|
629
|
+
</a>
|
|
630
|
+
|
|
631
|
+
</div>
|
|
632
|
+
|
|
633
|
+
<div class="method-description">
|
|
634
|
+
|
|
635
|
+
<p>
|
|
636
|
+
Return the keyword name in a more readable form. E.g. ‘foo.bar’
|
|
637
|
+
is returned as ‘foo (bar)’. ‘foo’ will remain
|
|
638
|
+
‘foo’.
|
|
639
|
+
</p>
|
|
640
|
+
|
|
641
|
+
<p><a class="source-toggle" href="#"
|
|
642
|
+
onclick="toggleCode('M000425-source');return false;">[Source]</a></p>
|
|
643
|
+
<div class="method-source-code" id="M000425-source">
|
|
644
|
+
<pre>
|
|
645
|
+
<span class="ruby-comment cmt"># File lib/KeywordDocumentation.rb, line 132</span>
|
|
646
|
+
132: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">title</span>
|
|
647
|
+
133: <span class="ruby-identifier">kwTokens</span> = <span class="ruby-ivar">@keyword</span>.<span class="ruby-identifier">split</span>(<span class="ruby-value str">'.'</span>)
|
|
648
|
+
134: <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">kwTokens</span>.<span class="ruby-identifier">size</span> <span class="ruby-operator">==</span> <span class="ruby-value">1</span>
|
|
649
|
+
135: <span class="ruby-identifier">title</span> = <span class="ruby-ivar">@keyword</span>
|
|
650
|
+
136: <span class="ruby-keyword kw">else</span>
|
|
651
|
+
137: <span class="ruby-identifier">title</span> = <span class="ruby-node">"#{kwTokens[0]} (#{kwTokens[1]})"</span>
|
|
652
|
+
138: <span class="ruby-keyword kw">end</span>
|
|
653
|
+
139: <span class="ruby-identifier">title</span>
|
|
654
|
+
140: <span class="ruby-keyword kw">end</span>
|
|
655
|
+
</pre>
|
|
656
|
+
</div>
|
|
657
|
+
|
|
658
|
+
</div>
|
|
659
|
+
</div>
|
|
660
|
+
|
|
661
|
+
|
|
662
|
+
<div id="method-M000426" class="method-detail">
|
|
663
|
+
<a name="M000426"></a>
|
|
664
|
+
|
|
665
|
+
<div class="method-heading">
|
|
666
|
+
|
|
667
|
+
<a href="#M000426" class="method-signature">
|
|
668
|
+
|
|
669
|
+
<span class="method-name">to_s</span><span class="method-args">()</span>
|
|
670
|
+
|
|
671
|
+
</a>
|
|
672
|
+
|
|
673
|
+
</div>
|
|
674
|
+
|
|
675
|
+
<div class="method-description">
|
|
676
|
+
|
|
677
|
+
<p>
|
|
678
|
+
Return the complete documentation of this keyword as formatted text string.
|
|
679
|
+
</p>
|
|
680
|
+
|
|
681
|
+
<p><a class="source-toggle" href="#"
|
|
682
|
+
onclick="toggleCode('M000426-source');return false;">[Source]</a></p>
|
|
683
|
+
<div class="method-source-code" id="M000426-source">
|
|
684
|
+
<pre>
|
|
685
|
+
<span class="ruby-comment cmt"># File lib/KeywordDocumentation.rb, line 144</span>
|
|
686
|
+
144: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">to_s</span>
|
|
687
|
+
145: <span class="ruby-identifier">tagW</span> = <span class="ruby-value">13</span>
|
|
688
|
+
146: <span class="ruby-identifier">textW</span> = <span class="ruby-value">79</span> <span class="ruby-operator">-</span> <span class="ruby-identifier">tagW</span>
|
|
689
|
+
147:
|
|
690
|
+
148: <span class="ruby-comment cmt"># Top line with multiple elements</span>
|
|
691
|
+
149: <span class="ruby-identifier">str</span> = <span class="ruby-node">"Keyword: #{@keyword} "</span> <span class="ruby-operator">+</span>
|
|
692
|
+
150: <span class="ruby-node">"Scenario Specific: #{@scenarioSpecific ? 'Yes' : 'No'} "</span> <span class="ruby-operator">+</span>
|
|
693
|
+
151: <span class="ruby-node">"Inheritable: #{@inheritable ? 'Yes' : 'No'}\n\n"</span>
|
|
694
|
+
152:
|
|
695
|
+
153: <span class="ruby-identifier">str</span> <span class="ruby-operator">+=</span> <span class="ruby-node">"Purpose: #{format(tagW, newRichText(@pattern.doc).to_s,
|
|
696
|
+
154: textW)}\n\n"</span>
|
|
697
|
+
155:
|
|
698
|
+
156: <span class="ruby-keyword kw">if</span> <span class="ruby-ivar">@syntax</span> <span class="ruby-operator">!=</span> <span class="ruby-value str">'[{ <attributes> }]'</span>
|
|
699
|
+
157: <span class="ruby-identifier">str</span> <span class="ruby-operator">+=</span> <span class="ruby-node">"Syntax: #{format(tagW, @syntax, textW)}\n\n"</span>
|
|
700
|
+
158:
|
|
701
|
+
159: <span class="ruby-identifier">str</span> <span class="ruby-operator">+=</span> <span class="ruby-value str">"Arguments: "</span>
|
|
702
|
+
160: <span class="ruby-keyword kw">if</span> <span class="ruby-ivar">@args</span>.<span class="ruby-identifier">empty?</span>
|
|
703
|
+
161: <span class="ruby-identifier">str</span> <span class="ruby-operator">+=</span> <span class="ruby-identifier">format</span>(<span class="ruby-identifier">tagW</span>, <span class="ruby-value str">"none\n\n"</span>, <span class="ruby-identifier">textW</span>)
|
|
704
|
+
162: <span class="ruby-keyword kw">else</span>
|
|
705
|
+
163: <span class="ruby-identifier">argStr</span> = <span class="ruby-value str">''</span>
|
|
706
|
+
164: <span class="ruby-ivar">@args</span>.<span class="ruby-identifier">each</span> <span class="ruby-keyword kw">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">arg</span><span class="ruby-operator">|</span>
|
|
707
|
+
165: <span class="ruby-identifier">argText</span> = <span class="ruby-identifier">arg</span>.<span class="ruby-identifier">text</span> <span class="ruby-operator">||</span> <span class="ruby-node">"See #{arg.name} for details."</span>
|
|
708
|
+
166: <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">arg</span>.<span class="ruby-identifier">typeSpec</span>.<span class="ruby-identifier">nil?</span> <span class="ruby-operator">||</span> (<span class="ruby-value str">'<'</span> <span class="ruby-operator">+</span> <span class="ruby-identifier">arg</span>.<span class="ruby-identifier">name</span> <span class="ruby-operator">+</span> <span class="ruby-value str">'>'</span>) <span class="ruby-operator">==</span> <span class="ruby-identifier">arg</span>.<span class="ruby-identifier">typeSpec</span>
|
|
709
|
+
167: <span class="ruby-identifier">indent</span> = <span class="ruby-identifier">arg</span>.<span class="ruby-identifier">name</span>.<span class="ruby-identifier">length</span> <span class="ruby-operator">+</span> <span class="ruby-value">2</span>
|
|
710
|
+
168: <span class="ruby-identifier">argStr</span> <span class="ruby-operator">+=</span> <span class="ruby-node">"#{arg.name}: "</span> <span class="ruby-operator">+</span>
|
|
711
|
+
169: <span class="ruby-node">"#{format(indent, argText, textW - indent)}\n"</span>
|
|
712
|
+
170: <span class="ruby-keyword kw">else</span>
|
|
713
|
+
171: <span class="ruby-identifier">typeSpec</span> = <span class="ruby-identifier">arg</span>.<span class="ruby-identifier">typeSpec</span>
|
|
714
|
+
172: <span class="ruby-identifier">typeSpec</span>[<span class="ruby-value">0</span>] = <span class="ruby-value str">'['</span>
|
|
715
|
+
173: <span class="ruby-identifier">typeSpec</span>[<span class="ruby-value">-1</span>] = <span class="ruby-value str">']'</span>
|
|
716
|
+
174: <span class="ruby-identifier">indent</span> = <span class="ruby-identifier">arg</span>.<span class="ruby-identifier">name</span>.<span class="ruby-identifier">length</span> <span class="ruby-operator">+</span> <span class="ruby-identifier">typeSpec</span>.<span class="ruby-identifier">size</span> <span class="ruby-operator">+</span> <span class="ruby-value">3</span>
|
|
717
|
+
175: <span class="ruby-identifier">argStr</span> <span class="ruby-operator">+=</span> <span class="ruby-node">"#{arg.name} #{typeSpec}: "</span> <span class="ruby-operator">+</span>
|
|
718
|
+
176: <span class="ruby-node">"#{format(indent, argText, textW - indent)}\n"</span>
|
|
719
|
+
177: <span class="ruby-keyword kw">end</span>
|
|
720
|
+
178: <span class="ruby-keyword kw">end</span>
|
|
721
|
+
179: <span class="ruby-identifier">str</span> <span class="ruby-operator">+=</span> <span class="ruby-identifier">format</span>(<span class="ruby-identifier">tagW</span>, <span class="ruby-identifier">argStr</span>, <span class="ruby-identifier">textW</span>)
|
|
722
|
+
180: <span class="ruby-keyword kw">end</span>
|
|
723
|
+
181: <span class="ruby-identifier">str</span> <span class="ruby-operator">+=</span> <span class="ruby-value str">"\n"</span>
|
|
724
|
+
182: <span class="ruby-keyword kw">end</span>
|
|
725
|
+
183:
|
|
726
|
+
184: <span class="ruby-identifier">str</span> <span class="ruby-operator">+=</span> <span class="ruby-value str">'Context: '</span>
|
|
727
|
+
185: <span class="ruby-keyword kw">if</span> <span class="ruby-ivar">@contexts</span>.<span class="ruby-identifier">empty?</span>
|
|
728
|
+
186: <span class="ruby-identifier">str</span> <span class="ruby-operator">+=</span> <span class="ruby-identifier">format</span>(<span class="ruby-identifier">tagW</span>, <span class="ruby-value str">'Global scope'</span>, <span class="ruby-identifier">textW</span>)
|
|
729
|
+
187: <span class="ruby-keyword kw">else</span>
|
|
730
|
+
188: <span class="ruby-identifier">cxtStr</span> = <span class="ruby-value str">''</span>
|
|
731
|
+
189: <span class="ruby-ivar">@contexts</span>.<span class="ruby-identifier">each</span> <span class="ruby-keyword kw">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">context</span><span class="ruby-operator">|</span>
|
|
732
|
+
190: <span class="ruby-keyword kw">unless</span> <span class="ruby-identifier">cxtStr</span>.<span class="ruby-identifier">empty?</span>
|
|
733
|
+
191: <span class="ruby-identifier">cxtStr</span> <span class="ruby-operator">+=</span> <span class="ruby-value str">', '</span>
|
|
734
|
+
192: <span class="ruby-keyword kw">end</span>
|
|
735
|
+
193: <span class="ruby-identifier">cxtStr</span> <span class="ruby-operator">+=</span> <span class="ruby-identifier">context</span>.<span class="ruby-identifier">keyword</span>
|
|
736
|
+
194: <span class="ruby-keyword kw">end</span>
|
|
737
|
+
195: <span class="ruby-identifier">str</span> <span class="ruby-operator">+=</span> <span class="ruby-identifier">format</span>(<span class="ruby-identifier">tagW</span>, <span class="ruby-identifier">cxtStr</span>, <span class="ruby-identifier">textW</span>)
|
|
738
|
+
196: <span class="ruby-keyword kw">end</span>
|
|
739
|
+
197:
|
|
740
|
+
198: <span class="ruby-identifier">str</span> <span class="ruby-operator">+=</span> <span class="ruby-value str">"\n\nAttributes: "</span>
|
|
741
|
+
199: <span class="ruby-keyword kw">if</span> <span class="ruby-ivar">@optionalAttributes</span>.<span class="ruby-identifier">empty?</span>
|
|
742
|
+
200: <span class="ruby-identifier">str</span> <span class="ruby-operator">+=</span> <span class="ruby-value str">"none\n\n"</span>
|
|
743
|
+
201: <span class="ruby-keyword kw">else</span>
|
|
744
|
+
202: <span class="ruby-identifier">attrStr</span> = <span class="ruby-value str">''</span>
|
|
745
|
+
203: <span class="ruby-ivar">@optionalAttributes</span>.<span class="ruby-identifier">sort!</span> <span class="ruby-keyword kw">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">a</span>, <span class="ruby-identifier">b</span><span class="ruby-operator">|</span>
|
|
746
|
+
204: <span class="ruby-identifier">a</span>.<span class="ruby-identifier">keyword</span> <span class="ruby-operator"><=></span> <span class="ruby-identifier">b</span>.<span class="ruby-identifier">keyword</span>
|
|
747
|
+
205: <span class="ruby-keyword kw">end</span>
|
|
748
|
+
206: <span class="ruby-ivar">@optionalAttributes</span>.<span class="ruby-identifier">each</span> <span class="ruby-keyword kw">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">attr</span><span class="ruby-operator">|</span>
|
|
749
|
+
207: <span class="ruby-keyword kw">unless</span> <span class="ruby-identifier">attrStr</span>.<span class="ruby-identifier">empty?</span>
|
|
750
|
+
208: <span class="ruby-identifier">attrStr</span> <span class="ruby-operator">+=</span> <span class="ruby-value str">', '</span>
|
|
751
|
+
209: <span class="ruby-keyword kw">end</span>
|
|
752
|
+
210: <span class="ruby-identifier">attrStr</span> <span class="ruby-operator">+=</span> <span class="ruby-value str">'[sc:]'</span> <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">attr</span>.<span class="ruby-identifier">scenarioSpecific</span>
|
|
753
|
+
211: <span class="ruby-identifier">attrStr</span> <span class="ruby-operator">+=</span> <span class="ruby-identifier">attr</span>.<span class="ruby-identifier">keyword</span>
|
|
754
|
+
212: <span class="ruby-keyword kw">end</span>
|
|
755
|
+
213: <span class="ruby-identifier">str</span> <span class="ruby-operator">+=</span> <span class="ruby-identifier">format</span>(<span class="ruby-identifier">tagW</span>, <span class="ruby-identifier">attrStr</span>, <span class="ruby-identifier">textW</span>)
|
|
756
|
+
214: <span class="ruby-identifier">str</span> <span class="ruby-operator">+=</span> <span class="ruby-value str">"\n"</span>
|
|
757
|
+
215: <span class="ruby-keyword kw">end</span>
|
|
758
|
+
216:
|
|
759
|
+
217: <span class="ruby-keyword kw">unless</span> <span class="ruby-ivar">@seeAlso</span>.<span class="ruby-identifier">empty?</span>
|
|
760
|
+
218: <span class="ruby-identifier">str</span> <span class="ruby-operator">+=</span> <span class="ruby-value str">"See also: "</span>
|
|
761
|
+
219: <span class="ruby-identifier">alsoStr</span> = <span class="ruby-value str">''</span>
|
|
762
|
+
220: <span class="ruby-ivar">@seeAlso</span>.<span class="ruby-identifier">each</span> <span class="ruby-keyword kw">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">also</span><span class="ruby-operator">|</span>
|
|
763
|
+
221: <span class="ruby-keyword kw">unless</span> <span class="ruby-identifier">alsoStr</span>.<span class="ruby-identifier">empty?</span>
|
|
764
|
+
222: <span class="ruby-identifier">alsoStr</span> <span class="ruby-operator">+=</span> <span class="ruby-value str">', '</span>
|
|
765
|
+
223: <span class="ruby-keyword kw">end</span>
|
|
766
|
+
224: <span class="ruby-identifier">alsoStr</span> <span class="ruby-operator">+=</span> <span class="ruby-identifier">also</span>.<span class="ruby-identifier">keyword</span>
|
|
767
|
+
225: <span class="ruby-keyword kw">end</span>
|
|
768
|
+
226: <span class="ruby-identifier">str</span> <span class="ruby-operator">+=</span> <span class="ruby-identifier">format</span>(<span class="ruby-identifier">tagW</span>, <span class="ruby-identifier">alsoStr</span>, <span class="ruby-identifier">textW</span>)
|
|
769
|
+
227: <span class="ruby-identifier">str</span> <span class="ruby-operator">+=</span> <span class="ruby-value str">"\n"</span>
|
|
770
|
+
228: <span class="ruby-keyword kw">end</span>
|
|
771
|
+
229:
|
|
772
|
+
230: <span class="ruby-comment cmt"># str += "Rule: #{@rule.name}\n" if @rule</span>
|
|
773
|
+
231: <span class="ruby-comment cmt"># str += "Pattern: #{@pattern.tokens.join(' ')}\n" if @pattern</span>
|
|
774
|
+
232: <span class="ruby-identifier">str</span>
|
|
775
|
+
233: <span class="ruby-keyword kw">end</span>
|
|
776
|
+
</pre>
|
|
777
|
+
</div>
|
|
778
|
+
|
|
779
|
+
</div>
|
|
780
|
+
</div>
|
|
781
|
+
|
|
782
|
+
|
|
783
|
+
|
|
784
|
+
</div>
|
|
785
|
+
|
|
786
|
+
|
|
787
|
+
|
|
788
|
+
|
|
789
|
+
</div>
|
|
790
|
+
|
|
791
|
+
<div id="validator-badges">
|
|
792
|
+
<p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
|
|
793
|
+
</div>
|
|
794
|
+
|
|
795
|
+
</body>
|
|
796
|
+
</html>
|