taskjuggler 0.0.4 → 0.0.5
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- data/README +1 -1
- data/bin/tj3client +3 -0
- data/bin/tj3d +3 -0
- data/bin/tj3ts_receiver +3 -0
- data/bin/tj3ts_sender +3 -0
- data/bin/tj3ts_summary +3 -0
- data/data/css/tjmanual.css +14 -0
- data/data/css/tjreport.css +233 -21
- data/data/scripts/wz_tooltip.js +20 -20
- data/doc/AppConfig.html +1389 -0
- data/doc/Arguments.html +678 -0
- data/doc/COPYING.html +837 -0
- data/doc/Object.html +996 -0
- data/doc/README.html +523 -0
- data/doc/RuntimeConfig.html +762 -0
- data/doc/String.html +872 -0
- data/doc/TaskJuggler/Account.html +691 -0
- data/doc/TaskJuggler/AccountAttribute.html +707 -0
- data/doc/TaskJuggler/AccountScenario.html +650 -0
- data/doc/TaskJuggler/Allocation.html +898 -0
- data/doc/TaskJuggler/AllocationAttribute.html +737 -0
- data/doc/TaskJuggler/AttributeBase.html +1193 -0
- data/doc/TaskJuggler/AttributeDefinition.html +753 -0
- data/doc/TaskJuggler/BatchProcessor.html +1112 -0
- data/doc/TaskJuggler/Booking.html +797 -0
- data/doc/TaskJuggler/BookingListAttribute.html +709 -0
- data/doc/TaskJuggler/BooleanAttribute.html +707 -0
- data/doc/TaskJuggler/CSVFile.html +924 -0
- data/doc/TaskJuggler/CellSettingPattern.html +638 -0
- data/doc/TaskJuggler/CellSettingPatternList.html +687 -0
- data/doc/TaskJuggler/Charge.html +715 -0
- data/doc/TaskJuggler/ChargeListAttribute.html +671 -0
- data/doc/TaskJuggler/ChargeSet.html +887 -0
- data/doc/TaskJuggler/ChargeSetListAttribute.html +718 -0
- data/doc/TaskJuggler/ColumnListAttribute.html +673 -0
- data/doc/TaskJuggler/ColumnTable.html +701 -0
- data/doc/TaskJuggler/Daemon.html +728 -0
- data/doc/TaskJuggler/DateAttribute.html +675 -0
- data/doc/TaskJuggler/DefinitionListAttribute.html +593 -0
- data/doc/TaskJuggler/DependencyListAttribute.html +713 -0
- data/doc/TaskJuggler/DurationAttribute.html +707 -0
- data/doc/TaskJuggler/FixnumAttribute.html +629 -0
- data/doc/TaskJuggler/FlagListAttribute.html +709 -0
- data/doc/TaskJuggler/FloatAttribute.html +671 -0
- data/doc/TaskJuggler/FormatListAttribute.html +635 -0
- data/doc/TaskJuggler/GanttChart.html +1473 -0
- data/doc/TaskJuggler/GanttContainer.html +885 -0
- data/doc/TaskJuggler/GanttHeader.html +886 -0
- data/doc/TaskJuggler/GanttHeaderScaleItem.html +700 -0
- data/doc/TaskJuggler/GanttLine.html +1263 -0
- data/doc/TaskJuggler/GanttLoadStack.html +766 -0
- data/doc/TaskJuggler/GanttMilestone.html +865 -0
- data/doc/TaskJuggler/GanttRouter.html +1433 -0
- data/doc/TaskJuggler/GanttTaskBar.html +880 -0
- data/doc/TaskJuggler/HTMLDocument.html +719 -0
- data/doc/TaskJuggler/HTMLGraphics.html +775 -0
- data/doc/TaskJuggler/Interval.html +1016 -0
- data/doc/TaskJuggler/IntervalListAttribute.html +713 -0
- data/doc/TaskJuggler/JobInfo.html +881 -0
- data/doc/TaskJuggler/Journal.html +991 -0
- data/doc/TaskJuggler/JournalEntry.html +779 -0
- data/doc/TaskJuggler/JournalEntryList.html +952 -0
- data/doc/TaskJuggler/KeywordArray.html +628 -0
- data/doc/TaskJuggler/KeywordDocumentation.html +1662 -0
- data/doc/TaskJuggler/Limits/Limit.html +826 -0
- data/doc/TaskJuggler/Limits.html +966 -0
- data/doc/TaskJuggler/LimitsAttribute.html +707 -0
- data/doc/TaskJuggler/ListAttributeBase.html +641 -0
- data/doc/TaskJuggler/Log.html +1103 -0
- data/doc/TaskJuggler/LogFile.html +918 -0
- data/doc/TaskJuggler/LogicalAttribute.html +698 -0
- data/doc/TaskJuggler/LogicalExpression.html +739 -0
- data/doc/TaskJuggler/LogicalExpressionAttribute.html +629 -0
- data/doc/TaskJuggler/LogicalFlag.html +681 -0
- data/doc/TaskJuggler/LogicalFunction.html +1218 -0
- data/doc/TaskJuggler/LogicalOperation.html +1078 -0
- data/doc/TaskJuggler/Macro.html +646 -0
- data/doc/TaskJuggler/MacroParser.html +810 -0
- data/doc/TaskJuggler/MacroTable.html +810 -0
- data/doc/TaskJuggler/ManagerResponsibilities.html +674 -0
- data/doc/TaskJuggler/ManagerStatusRecord.html +678 -0
- data/doc/TaskJuggler/Message.html +757 -0
- data/doc/TaskJuggler/MessageHandler.html +679 -0
- data/doc/TaskJuggler/Navigator.html +867 -0
- data/doc/TaskJuggler/NavigatorElement.html +932 -0
- data/doc/TaskJuggler/NikuProject.html +662 -0
- data/doc/TaskJuggler/NikuReport.html +1316 -0
- data/doc/TaskJuggler/NikuResource.html +632 -0
- data/doc/TaskJuggler/OnShiftCache.html +864 -0
- data/doc/TaskJuggler/ProcessIntercom.html +847 -0
- data/doc/TaskJuggler/ProcessIntercomIface.html +664 -0
- data/doc/TaskJuggler/Project.html +3056 -0
- data/doc/TaskJuggler/ProjectBroker.html +1260 -0
- data/doc/TaskJuggler/ProjectBrokerIface.html +734 -0
- data/doc/TaskJuggler/ProjectFileParser.html +1951 -0
- data/doc/TaskJuggler/ProjectRecord.html +859 -0
- data/doc/TaskJuggler/ProjectServer.html +1092 -0
- data/doc/TaskJuggler/ProjectServerIface.html +768 -0
- data/doc/TaskJuggler/PropertyAttribute.html +629 -0
- data/doc/TaskJuggler/PropertyList.html +1336 -0
- data/doc/TaskJuggler/PropertySet.html +1785 -0
- data/doc/TaskJuggler/PropertyTreeNode.html +2482 -0
- data/doc/TaskJuggler/Query.html +1831 -0
- data/doc/TaskJuggler/RTFNavigator.html +729 -0
- data/doc/TaskJuggler/RTFQuery.html +1038 -0
- data/doc/TaskJuggler/RTFReport.html +740 -0
- data/doc/TaskJuggler/RealFormat.html +743 -0
- data/doc/TaskJuggler/RealFormatAttribute.html +593 -0
- data/doc/TaskJuggler/ReferenceAttribute.html +782 -0
- data/doc/TaskJuggler/Report.html +1255 -0
- data/doc/TaskJuggler/ReportBase.html +1198 -0
- data/doc/TaskJuggler/ReportContext.html +711 -0
- data/doc/TaskJuggler/ReportServer.html +988 -0
- data/doc/TaskJuggler/ReportServerIface.html +838 -0
- data/doc/TaskJuggler/ReportServerRecord.html +716 -0
- data/doc/TaskJuggler/ReportTable.html +1106 -0
- data/doc/TaskJuggler/ReportTableCell.html +1536 -0
- data/doc/TaskJuggler/ReportTableColumn.html +828 -0
- data/doc/TaskJuggler/ReportTableLegend.html +999 -0
- data/doc/TaskJuggler/ReportTableLine.html +1003 -0
- data/doc/TaskJuggler/Resource.html +938 -0
- data/doc/TaskJuggler/ResourceListAttribute.html +752 -0
- data/doc/TaskJuggler/ResourceListRE.html +674 -0
- data/doc/TaskJuggler/ResourceScenario.html +2457 -0
- data/doc/TaskJuggler/RichText.html +791 -0
- data/doc/TaskJuggler/RichTextAttribute.html +743 -0
- data/doc/TaskJuggler/RichTextDocument.html +972 -0
- data/doc/TaskJuggler/RichTextElement.html +1615 -0
- data/doc/TaskJuggler/RichTextException.html +667 -0
- data/doc/TaskJuggler/RichTextFunctionExample.html +737 -0
- data/doc/TaskJuggler/RichTextFunctionHandler.html +689 -0
- data/doc/TaskJuggler/RichTextImage.html +650 -0
- data/doc/TaskJuggler/RichTextIntermediate.html +1161 -0
- data/doc/TaskJuggler/RichTextParser.html +756 -0
- data/doc/TaskJuggler/RichTextScanner.html +2010 -0
- data/doc/TaskJuggler/RichTextSnip.html +942 -0
- data/doc/TaskJuggler/RichTextSyntaxRules.html +1722 -0
- data/doc/TaskJuggler/Scenario.html +594 -0
- data/doc/TaskJuggler/ScenarioData.html +815 -0
- data/doc/TaskJuggler/ScenarioListAttribute.html +671 -0
- data/doc/TaskJuggler/Scoreboard.html +1114 -0
- data/doc/TaskJuggler/SheetHandlerBase.html +1115 -0
- data/doc/TaskJuggler/SheetReceiver.html +1293 -0
- data/doc/TaskJuggler/SheetSender.html +1089 -0
- data/doc/TaskJuggler/Shift.html +689 -0
- data/doc/TaskJuggler/ShiftAssignment.html +950 -0
- data/doc/TaskJuggler/ShiftAssignments.html +1379 -0
- data/doc/TaskJuggler/ShiftAssignmentsAttribute.html +707 -0
- data/doc/TaskJuggler/ShiftScenario.html +720 -0
- data/doc/TaskJuggler/SortListAttribute.html +631 -0
- data/doc/TaskJuggler/SourceFileInfo.html +698 -0
- data/doc/TaskJuggler/StatusSheetReceiver.html +615 -0
- data/doc/TaskJuggler/StatusSheetReport.html +872 -0
- data/doc/TaskJuggler/StatusSheetSender.html +654 -0
- data/doc/TaskJuggler/StringAttribute.html +671 -0
- data/doc/TaskJuggler/SymbolAttribute.html +629 -0
- data/doc/TaskJuggler/SyntaxReference.html +1155 -0
- data/doc/TaskJuggler/TOCEntry.html +723 -0
- data/doc/TaskJuggler/TSResourceRecord.html +670 -0
- data/doc/TaskJuggler/TSTaskRecord.html +682 -0
- data/doc/TaskJuggler/TableColumnDefinition.html +830 -0
- data/doc/TaskJuggler/TableOfContents.html +692 -0
- data/doc/TaskJuggler/TableReport.html +2444 -0
- data/doc/TaskJuggler/Task.html +781 -0
- data/doc/TaskJuggler/TaskDependency.html +730 -0
- data/doc/TaskJuggler/TaskListAttribute.html +713 -0
- data/doc/TaskJuggler/TaskListRE.html +673 -0
- data/doc/TaskJuggler/TaskScenario.html +4380 -0
- data/doc/TaskJuggler/TextFormatter.html +911 -0
- data/doc/TaskJuggler/TextParser/Pattern.html +1482 -0
- data/doc/TaskJuggler/TextParser/Rule.html +1288 -0
- data/doc/TaskJuggler/TextParser/StackElement.html +726 -0
- data/doc/TaskJuggler/TextParser/TextParserResultArray.html +648 -0
- data/doc/TaskJuggler/TextParser/TokenDoc.html +680 -0
- data/doc/TaskJuggler/TextParser.html +1670 -0
- data/doc/TaskJuggler/TextReport.html +856 -0
- data/doc/TaskJuggler/TextScanner/BufferStreamHandle.html +831 -0
- data/doc/TaskJuggler/TextScanner/FileStreamHandle.html +832 -0
- data/doc/TaskJuggler/TextScanner/StreamHandle.html +737 -0
- data/doc/TaskJuggler/TextScanner.html +2430 -0
- data/doc/TaskJuggler/TimeSheet.html +1233 -0
- data/doc/TaskJuggler/TimeSheetReceiver.html +612 -0
- data/doc/TaskJuggler/TimeSheetRecord.html +1352 -0
- data/doc/TaskJuggler/TimeSheetReport.html +948 -0
- data/doc/TaskJuggler/TimeSheetSender.html +637 -0
- data/doc/TaskJuggler/TimeSheetSummary.html +865 -0
- data/doc/TaskJuggler/TimeSheets.html +674 -0
- data/doc/TaskJuggler/Tj3AppBase.html +782 -0
- data/doc/TaskJuggler/Tj3Client.html +1455 -0
- data/doc/TaskJuggler/Tj3Daemon.html +767 -0
- data/doc/TaskJuggler/Tj3SheetAppBase.html +696 -0
- data/doc/TaskJuggler/Tj3SsReceiver.html +682 -0
- data/doc/TaskJuggler/Tj3SsSender.html +708 -0
- data/doc/TaskJuggler/Tj3TsReceiver.html +681 -0
- data/doc/TaskJuggler/Tj3TsSender.html +702 -0
- data/doc/TaskJuggler/Tj3TsSummary.html +710 -0
- data/doc/TaskJuggler/TjException.html +630 -0
- data/doc/TaskJuggler/TjTime.html +2590 -0
- data/doc/TaskJuggler/TjpExample.html +835 -0
- data/doc/TaskJuggler/TjpExportRE.html +1581 -0
- data/doc/TaskJuggler/TjpSyntaxRules.html +13004 -0
- data/doc/TaskJuggler/UserManual.html +1145 -0
- data/doc/TaskJuggler/WorkingHours.html +1101 -0
- data/doc/TaskJuggler/WorkingHoursAttribute.html +694 -0
- data/doc/TaskJuggler/XMLBlob.html +645 -0
- data/doc/TaskJuggler/XMLComment.html +640 -0
- data/doc/TaskJuggler/XMLDocument.html +732 -0
- data/doc/TaskJuggler/XMLElement.html +900 -0
- data/doc/TaskJuggler/XMLNamedText.html +601 -0
- data/doc/TaskJuggler/XMLText.html +655 -0
- data/doc/TaskJuggler.html +2243 -0
- data/doc/index.html +3778 -17
- data/doc/lib/AccountScenario_rb.html +67 -0
- data/doc/lib/Account_rb.html +69 -0
- data/doc/lib/Allocation_rb.html +69 -0
- data/doc/lib/AppConfig_rb.html +69 -0
- data/doc/lib/AttributeBase_rb.html +67 -0
- data/doc/lib/AttributeDefinition_rb.html +65 -0
- data/doc/lib/Attributes_rb.html +81 -0
- data/doc/lib/BatchProcessor_rb.html +69 -0
- data/doc/lib/Booking_rb.html +65 -0
- data/doc/lib/ChargeSet_rb.html +67 -0
- data/doc/lib/Charge_rb.html +67 -0
- data/doc/lib/HTMLDocument_rb.html +67 -0
- data/doc/lib/Interval_rb.html +67 -0
- data/doc/lib/Journal_rb.html +65 -0
- data/doc/lib/KeywordArray_rb.html +65 -0
- data/doc/lib/KeywordDocumentation_rb.html +75 -0
- data/doc/lib/Limits_rb.html +67 -0
- data/doc/lib/LogFile_rb.html +67 -0
- data/doc/lib/Log_rb.html +69 -0
- data/doc/lib/LogicalExpression_rb.html +71 -0
- data/doc/lib/LogicalFunction_rb.html +67 -0
- data/doc/lib/LogicalOperation_rb.html +67 -0
- data/doc/lib/MacroParser_rb.html +69 -0
- data/doc/lib/MacroTable_rb.html +73 -0
- data/doc/lib/MessageHandler_rb.html +65 -0
- data/doc/lib/Message_rb.html +67 -0
- data/doc/lib/ProjectFileParser_rb.html +79 -0
- data/doc/lib/Project_rb.html +109 -0
- data/doc/lib/PropertyList_rb.html +65 -0
- data/doc/lib/PropertySet_rb.html +69 -0
- data/doc/lib/PropertyTreeNode_rb.html +65 -0
- data/doc/lib/Query_rb.html +67 -0
- data/doc/lib/RTFNavigator_rb.html +71 -0
- data/doc/lib/RTFQuery_rb.html +71 -0
- data/doc/lib/RTFReport_rb.html +69 -0
- data/doc/lib/RealFormat_rb.html +65 -0
- data/doc/lib/ResourceScenario_rb.html +67 -0
- data/doc/lib/Resource_rb.html +69 -0
- data/doc/lib/RichTextDocument_rb.html +71 -0
- data/doc/lib/RichTextElement_rb.html +73 -0
- data/doc/lib/RichTextFunctionExample_rb.html +71 -0
- data/doc/lib/RichTextFunctionHandler_rb.html +65 -0
- data/doc/lib/RichTextParser_rb.html +71 -0
- data/doc/lib/RichTextScanner_rb.html +67 -0
- data/doc/lib/RichTextSnip_rb.html +69 -0
- data/doc/lib/RichTextSyntaxRules_rb.html +65 -0
- data/doc/lib/RichText_rb.html +69 -0
- data/doc/lib/RuntimeConfig_rb.html +67 -0
- data/doc/lib/ScenarioData_rb.html +69 -0
- data/doc/lib/Scenario_rb.html +67 -0
- data/doc/lib/Scoreboard_rb.html +65 -0
- data/doc/lib/SheetHandlerBase_rb.html +69 -0
- data/doc/lib/SheetReceiver_rb.html +75 -0
- data/doc/lib/SheetSender_rb.html +73 -0
- data/doc/lib/ShiftAssignments_rb.html +67 -0
- data/doc/lib/ShiftScenario_rb.html +67 -0
- data/doc/lib/Shift_rb.html +69 -0
- data/doc/lib/SourceFileInfo_rb.html +65 -0
- data/doc/lib/StatusSheetReceiver_rb.html +67 -0
- data/doc/lib/StatusSheetSender_rb.html +67 -0
- data/doc/lib/SyntaxReference_rb.html +73 -0
- data/doc/lib/TOCEntry_rb.html +69 -0
- data/doc/lib/TableColumnDefinition_rb.html +65 -0
- data/doc/lib/TableOfContents_rb.html +69 -0
- data/doc/lib/TaskDependency_rb.html +65 -0
- data/doc/lib/TaskJuggler_rb.html +73 -0
- data/doc/lib/TaskScenario_rb.html +67 -0
- data/doc/lib/Task_rb.html +69 -0
- data/doc/lib/TextFormatter_rb.html +67 -0
- data/doc/lib/TextParser/Pattern_rb.html +67 -0
- data/doc/lib/TextParser/Rule_rb.html +65 -0
- data/doc/lib/TextParser/StackElement_rb.html +65 -0
- data/doc/lib/TextParser/TokenDoc_rb.html +65 -0
- data/doc/lib/TextParser_rb.html +75 -0
- data/doc/lib/TextScanner_rb.html +79 -0
- data/doc/lib/TimeSheetReceiver_rb.html +67 -0
- data/doc/lib/TimeSheetSender_rb.html +67 -0
- data/doc/lib/TimeSheetSummary_rb.html +67 -0
- data/doc/lib/TimeSheets_rb.html +65 -0
- data/doc/lib/Tj3AppBase_rb.html +77 -0
- data/doc/lib/Tj3Config_rb.html +69 -0
- data/doc/lib/Tj3SheetAppBase_rb.html +67 -0
- data/doc/lib/TjException_rb.html +65 -0
- data/doc/lib/TjTime_rb.html +69 -0
- data/doc/lib/TjpExample_rb.html +67 -0
- data/doc/lib/TjpSyntaxRules_rb.html +65 -0
- data/doc/lib/UTF8String_rb.html +65 -0
- data/doc/lib/UserManual_rb.html +77 -0
- data/doc/lib/WorkingHours_rb.html +67 -0
- data/doc/lib/XMLDocument_rb.html +67 -0
- data/doc/lib/XMLElement_rb.html +67 -0
- data/doc/lib/daemon/Daemon_rb.html +67 -0
- data/doc/lib/daemon/ProcessIntercom_rb.html +67 -0
- data/doc/lib/daemon/ProjectBroker_rb.html +79 -0
- data/doc/lib/daemon/ProjectServer_rb.html +83 -0
- data/doc/lib/daemon/ReportServer_rb.html +73 -0
- data/doc/lib/deep_copy_rb.html +65 -0
- data/doc/lib/reports/CSVFile_rb.html +67 -0
- data/doc/lib/reports/ColumnTable_rb.html +67 -0
- data/doc/lib/reports/GanttChart_rb.html +73 -0
- data/doc/lib/reports/GanttContainer_rb.html +67 -0
- data/doc/lib/reports/GanttHeaderScaleItem_rb.html +65 -0
- data/doc/lib/reports/GanttHeader_rb.html +67 -0
- data/doc/lib/reports/GanttLine_rb.html +77 -0
- data/doc/lib/reports/GanttLoadStack_rb.html +67 -0
- data/doc/lib/reports/GanttMilestone_rb.html +67 -0
- data/doc/lib/reports/GanttRouter_rb.html +65 -0
- data/doc/lib/reports/GanttTaskBar_rb.html +67 -0
- data/doc/lib/reports/HTMLGraphics_rb.html +65 -0
- data/doc/lib/reports/Navigator_rb.html +67 -0
- data/doc/lib/reports/NikuReport_rb.html +69 -0
- data/doc/lib/reports/ReportBase_rb.html +65 -0
- data/doc/lib/reports/ReportContext_rb.html +65 -0
- data/doc/lib/reports/ReportTableCell_rb.html +65 -0
- data/doc/lib/reports/ReportTableColumn_rb.html +65 -0
- data/doc/lib/reports/ReportTableLegend_rb.html +65 -0
- data/doc/lib/reports/ReportTableLine_rb.html +67 -0
- data/doc/lib/reports/ReportTable_rb.html +69 -0
- data/doc/lib/reports/Report_rb.html +91 -0
- data/doc/lib/reports/ResourceListRE_rb.html +73 -0
- data/doc/lib/reports/StatusSheetReport_rb.html +67 -0
- data/doc/lib/reports/TableReport_rb.html +75 -0
- data/doc/lib/reports/TaskListRE_rb.html +73 -0
- data/doc/lib/reports/TextReport_rb.html +67 -0
- data/doc/lib/reports/TimeSheetReport_rb.html +67 -0
- data/doc/lib/reports/TjpExportRE_rb.html +67 -0
- data/doc/lib/ruby-signal-bug_rb.html +54 -0
- data/doc/lib/taskjuggler3_rb.html +73 -0
- data/doc/lib/tj3client_rb.html +73 -0
- data/doc/lib/tj3d_rb.html +73 -0
- data/doc/lib/tj3man_rb.html +73 -0
- data/doc/lib/tj3ss_receiver_rb.html +69 -0
- data/doc/lib/tj3ss_sender_rb.html +69 -0
- data/doc/lib/tj3ts_receiver_rb.html +69 -0
- data/doc/lib/tj3ts_sender_rb.html +69 -0
- data/doc/lib/tj3ts_summary_rb.html +69 -0
- data/doc/rdoc.css +701 -0
- data/examples/tutorial.tjp +25 -6
- data/lib/Attributes.rb +6 -2
- data/lib/HTMLDocument.rb +18 -2
- data/lib/Journal.rb +47 -4
- data/lib/KeywordArray.rb +1 -1
- data/lib/KeywordDocumentation.rb +17 -77
- data/lib/Log.rb +3 -1
- data/lib/LogFile.rb +72 -0
- data/lib/LogicalExpression.rb +5 -10
- data/lib/LogicalFunction.rb +34 -18
- data/lib/LogicalOperation.rb +32 -18
- data/lib/Project.rb +85 -13
- data/lib/ProjectFileParser.rb +19 -6
- data/lib/PropertyList.rb +12 -2
- data/lib/PropertyTreeNode.rb +23 -9
- data/lib/Query.rb +51 -13
- data/lib/RTFReport.rb +2 -2
- data/lib/Resource.rb +157 -0
- data/lib/ResourceScenario.rb +215 -68
- data/lib/RichText.rb +15 -3
- data/lib/RichTextDocument.rb +2 -4
- data/lib/RichTextElement.rb +87 -25
- data/lib/RichTextScanner.rb +32 -5
- data/lib/RichTextSnip.rb +6 -4
- data/lib/RichTextSyntaxRules.rb +44 -8
- data/lib/RuntimeConfig.rb +93 -0
- data/lib/Scoreboard.rb +6 -6
- data/lib/SheetHandlerBase.rb +215 -0
- data/lib/SheetReceiver.rb +355 -0
- data/lib/SheetSender.rb +264 -0
- data/lib/ShiftAssignments.rb +35 -27
- data/lib/StatusSheetReceiver.rb +45 -0
- data/lib/StatusSheetSender.rb +54 -0
- data/lib/SyntaxReference.rb +2 -7
- data/lib/Task.rb +70 -0
- data/lib/TaskJuggler.rb +114 -12
- data/lib/TaskScenario.rb +131 -22
- data/lib/TextFormatter.rb +177 -0
- data/lib/TextParser.rb +10 -1
- data/lib/TextScanner.rb +63 -33
- data/lib/TimeSheetReceiver.rb +42 -0
- data/lib/TimeSheetSender.rb +55 -0
- data/lib/TimeSheetSummary.rb +149 -0
- data/lib/TimeSheets.rb +406 -0
- data/lib/Tj3AppBase.rb +114 -0
- data/lib/Tj3Config.rb +1 -1
- data/lib/Tj3SheetAppBase.rb +59 -0
- data/lib/TjTime.rb +14 -1
- data/lib/TjpSyntaxRules.rb +573 -211
- data/lib/UTF8String.rb +4 -0
- data/lib/UserManual.rb +8 -7
- data/lib/XMLElement.rb +27 -19
- data/lib/daemon/Daemon.rb +70 -0
- data/lib/daemon/ProcessIntercom.rb +117 -0
- data/lib/daemon/ProjectBroker.rb +450 -0
- data/lib/daemon/ProjectServer.rb +348 -0
- data/lib/daemon/ReportServer.rb +194 -0
- data/lib/reports/ColumnTable.rb +2 -0
- data/lib/reports/GanttChart.rb +5 -7
- data/lib/reports/GanttContainer.rb +5 -8
- data/lib/reports/GanttHeader.rb +1 -1
- data/lib/reports/GanttLine.rb +89 -53
- data/lib/reports/GanttMilestone.rb +7 -4
- data/lib/reports/GanttTaskBar.rb +7 -3
- data/lib/reports/HTMLGraphics.rb +24 -9
- data/lib/reports/NikuReport.rb +414 -0
- data/lib/reports/Report.rb +54 -20
- data/lib/reports/ReportBase.rb +21 -0
- data/lib/reports/ReportTable.rb +29 -11
- data/lib/reports/ReportTableCell.rb +154 -86
- data/lib/reports/ReportTableLegend.rb +77 -80
- data/lib/reports/ResourceListRE.rb +2 -3
- data/lib/reports/StatusSheetReport.rb +231 -0
- data/lib/reports/TableReport.rb +74 -65
- data/lib/reports/TaskListRE.rb +2 -4
- data/lib/reports/TextReport.rb +18 -12
- data/lib/reports/TimeSheetReport.rb +145 -80
- data/lib/reports/TjpExportRE.rb +4 -4
- data/lib/ruby-signal-bug.rb +43 -0
- data/lib/taskjuggler3.rb +27 -10
- data/lib/tj3client.rb +411 -77
- data/lib/tj3d.rb +110 -0
- data/lib/tj3ss_receiver.rb +56 -0
- data/lib/tj3ss_sender.rb +84 -0
- data/lib/tj3ts_receiver.rb +59 -0
- data/lib/tj3ts_sender.rb +78 -0
- data/lib/tj3ts_summary.rb +87 -0
- data/manual/Day_To_Day_Juggling +761 -32
- data/manual/Getting_Started +12 -12
- data/manual/Rich_Text_Attributes +13 -1
- data/manual/TaskJuggler_2x_Migration +41 -3
- data/manual/TaskJuggler_Internals +87 -0
- data/manual/The_TaskJuggler_Syntax +1 -2
- data/manual/Tutorial +10 -10
- data/test/TestSuite/CSV-Reports/celltext.tjp +1 -1
- data/test/TestSuite/HTML-Reports/TimeSheet.html +79 -0
- data/test/TestSuite/HTML-Reports/icons/trend-down.png +0 -0
- data/test/TestSuite/HTML-Reports/icons/trend-flat.png +0 -0
- data/test/TestSuite/HTML-Reports/icons/trend-up.png +0 -0
- data/test/TestSuite/HTML-Reports/reference.html +51 -0
- data/test/TestSuite/Scheduler/Correct/Booking2.html +603 -0
- data/test/TestSuite/Scheduler/Correct/Booking2.tjp +57 -0
- data/test/TestSuite/Scheduler/Correct/Duration.tjp +32 -18
- data/test/TestSuite/Scheduler/Correct/Manager.tjp +9 -0
- data/test/TestSuite/Scheduler/Correct/Shift.html +429 -0
- data/test/TestSuite/Scheduler/Correct/Shift2.html +162 -0
- data/test/TestSuite/Scheduler/Correct/Shift2.tjp +67 -0
- data/test/TestSuite/{Syntax/Correct/TimeSheet.tjp → Scheduler/Correct/TimeSheet2.tjp} +21 -8
- data/test/TestSuite/Scheduler/Correct/css/tjmanual.css +52 -0
- data/test/TestSuite/Scheduler/Correct/css/tjreport.css +195 -0
- data/test/TestSuite/{Syntax → Scheduler}/Correct/icons/details.png +0 -0
- data/test/TestSuite/Scheduler/Correct/icons/flag-green.png +0 -0
- data/test/TestSuite/Scheduler/Correct/icons/flag-red.png +0 -0
- data/test/TestSuite/Scheduler/Correct/icons/flag-yellow.png +0 -0
- data/test/TestSuite/{Syntax → Scheduler}/Correct/icons/resource.png +0 -0
- data/test/TestSuite/{Syntax → Scheduler}/Correct/icons/resourcegroup.png +0 -0
- data/test/TestSuite/{Syntax → Scheduler}/Correct/icons/task.png +0 -0
- data/test/TestSuite/{Syntax → Scheduler}/Correct/icons/taskgroup.png +0 -0
- data/test/TestSuite/Scheduler/Correct/icons/trend-down.png +0 -0
- data/test/TestSuite/Scheduler/Correct/icons/trend-flat.png +0 -0
- data/test/TestSuite/Scheduler/Correct/icons/trend-up.png +0 -0
- data/test/TestSuite/{HTML-Reports/scripts → Scheduler/Correct}/scripts/wz_tooltip.js +0 -0
- data/test/TestSuite/Scheduler/Errors/manager_is_group.tjp +15 -0
- data/test/TestSuite/Scheduler/Errors/manager_is_self.tjp +11 -0
- data/test/TestSuite/Scheduler/Errors/resource_fail_check.tjp +12 -0
- data/test/TestSuite/Scheduler/Errors/resource_warn_check.tjp +12 -0
- data/test/TestSuite/Scheduler/Errors/task_fail_check.tjp +8 -0
- data/test/TestSuite/Scheduler/Errors/task_warn_check.tjp +8 -0
- data/test/TestSuite/Scheduler/Errors/ts_alert1_more_details.tjp +20 -0
- data/test/TestSuite/Scheduler/Errors/ts_alert2_more_details.tjp +21 -0
- data/test/TestSuite/Scheduler/Errors/ts_no_expected_end.tjp +26 -0
- data/test/TestSuite/Scheduler/Errors/ts_no_headline1.tjp +27 -0
- data/test/TestSuite/Scheduler/Errors/ts_no_rem_or_end.tjp +26 -0
- data/test/TestSuite/Scheduler/Errors/ts_no_remaining.tjp +26 -0
- data/test/TestSuite/Scheduler/Errors/ts_no_status_work.tjp +18 -0
- data/test/TestSuite/Scheduler/Errors/ts_no_work.tjp +26 -0
- data/test/TestSuite/Scheduler/Errors/ts_res_new_task.tjp +20 -0
- data/test/TestSuite/Scheduler/Errors/ts_work_too_high.tjp +27 -0
- data/test/TestSuite/Scheduler/Errors/ts_work_too_low.tjp +27 -0
- data/test/TestSuite/StatusSheets/boss.tji +45 -0
- data/test/TestSuite/StatusSheets/boss_mail +51 -0
- data/test/TestSuite/StatusSheets/dev2_mail +37 -0
- data/test/TestSuite/StatusSheets/project.tjp +275 -0
- data/test/TestSuite/StatusSheets/run +50 -0
- data/test/TestSuite/Syntax/Correct/Include.tjp +4 -0
- data/test/TestSuite/Syntax/Correct/Limits-1.tjp +10 -1
- data/test/TestSuite/Syntax/Correct/Manager.tjp +30 -0
- data/test/TestSuite/Syntax/Correct/Niku.tjp +66 -0
- data/test/TestSuite/Syntax/Correct/TimeSheet1.tjp +83 -0
- data/test/TestSuite/Syntax/Correct/include/dir1/file2.tji +1 -0
- data/test/TestSuite/Syntax/Correct/include/dir2/file3.tji +2 -0
- data/test/TestSuite/Syntax/Correct/include/file1.tji +3 -0
- data/test/TestSuite/Syntax/Correct/tutorial.tjp +29 -8
- data/test/TestSuite/Syntax/Errors/ts_bad_priority.tjp +19 -0
- data/test/TestSuite/Syntax/Errors/ts_default_details.tjp +22 -0
- data/test/TestSuite/Syntax/Errors/ts_default_summary.tjp +22 -0
- data/test/TestSuite/Syntax/Errors/ts_duplicate_task.tjp +23 -0
- data/test/TestSuite/Syntax/Errors/ts_end_too_early.tjp +18 -0
- data/test/TestSuite/Syntax/Errors/ts_headline_too_long.tjp +19 -0
- data/test/TestSuite/Syntax/Errors/ts_no_headline2.tjp +27 -0
- data/test/TestSuite/Syntax/Errors/ts_summary_too_long.tjp +29 -0
- data/test/TestSuite/TimeSheets/TimeSheetTemplates/2002-03-01/boss_2002-03-01.tji +36 -0
- data/test/TestSuite/TimeSheets/TimeSheetTemplates/2002-03-01/dev1_2002-03-01.tji +48 -0
- data/test/TestSuite/TimeSheets/TimeSheetTemplates/2002-03-01/dev2_2002-03-01.tji +67 -0
- data/test/TestSuite/TimeSheets/TimeSheetTemplates/2002-03-01/dev3_2002-03-01.tji +67 -0
- data/test/TestSuite/TimeSheets/TimeSheetTemplates/2002-03-01/doc_2002-03-01.tji +48 -0
- data/test/TestSuite/TimeSheets/TimeSheetTemplates/2002-03-01/resources.yml +31 -0
- data/test/TestSuite/TimeSheets/TimeSheetTemplates/2002-03-01/test_2002-03-01.tji +36 -0
- data/test/TestSuite/TimeSheets/TimeSheetTemplates/acceptable_intervals +1 -0
- data/test/TestSuite/TimeSheets/TimeSheets/2002-03-01/all.tji +1 -0
- data/test/TestSuite/TimeSheets/TimeSheets/2002-03-01/dev2_2002-03-01.tji +54 -0
- data/test/TestSuite/TimeSheets/TimeSheets/all.tji +2 -0
- data/test/TestSuite/TimeSheets/dev2_mail1 +84 -0
- data/test/TestSuite/TimeSheets/dev2_mail2 +87 -0
- data/test/TestSuite/TimeSheets/project.tjp +271 -0
- data/test/TestSuite/TimeSheets/receiver.log +102 -0
- data/test/TestSuite/TimeSheets/run +75 -0
- data/test/TestSuite/TimeSheets/sender.log +794 -0
- data/test/TestSuite/TimeSheets/summary.log +884 -0
- data/test/TestSuite/TimeSheets/timesheets.log +45 -0
- data/test/TestSuite/TimeSheets/tj3d.log +292 -0
- data/test/test_CSV-Reports.rb +5 -3
- data/test/test_RichText.rb +264 -56
- data/test/test_Scheduler.rb +1 -0
- data/test/test_TextFormatter.rb +142 -0
- data/test/test_TjTime.rb +15 -0
- metadata +816 -644
- data/benchmarks/UTF-8-Strings.rb +0 -58
- data/doc/classes/AppConfig.html +0 -880
- data/doc/classes/Arguments.html +0 -230
- data/doc/classes/Object.html +0 -229
- data/doc/classes/String.html +0 -399
- data/doc/classes/TaskJuggler/Account.html +0 -257
- data/doc/classes/TaskJuggler/AccountAttribute.html +0 -261
- data/doc/classes/TaskJuggler/AccountScenario.html +0 -218
- data/doc/classes/TaskJuggler/Allocation.html +0 -423
- data/doc/classes/TaskJuggler/AllocationAttribute.html +0 -291
- data/doc/classes/TaskJuggler/AttributeBase.html +0 -704
- data/doc/classes/TaskJuggler/AttributeDefinition.html +0 -276
- data/doc/classes/TaskJuggler/BatchProcessor.html +0 -347
- data/doc/classes/TaskJuggler/Booking.html +0 -311
- data/doc/classes/TaskJuggler/BookingListAttribute.html +0 -263
- data/doc/classes/TaskJuggler/BooleanAttribute.html +0 -261
- data/doc/classes/TaskJuggler/CSVFile.html +0 -329
- data/doc/classes/TaskJuggler/CellSettingPattern.html +0 -201
- data/doc/classes/TaskJuggler/CellSettingPatternList.html +0 -253
- data/doc/classes/TaskJuggler/Charge.html +0 -283
- data/doc/classes/TaskJuggler/ChargeListAttribute.html +0 -229
- data/doc/classes/TaskJuggler/ChargeSet.html +0 -444
- data/doc/classes/TaskJuggler/ChargeSetListAttribute.html +0 -276
- data/doc/classes/TaskJuggler/ColumnListAttribute.html +0 -231
- data/doc/classes/TaskJuggler/ColumnTable.html +0 -262
- data/doc/classes/TaskJuggler/DateAttribute.html +0 -233
- data/doc/classes/TaskJuggler/DefinitionListAttribute.html +0 -162
- data/doc/classes/TaskJuggler/DependencyListAttribute.html +0 -267
- data/doc/classes/TaskJuggler/DurationAttribute.html +0 -229
- data/doc/classes/TaskJuggler/FixnumAttribute.html +0 -194
- data/doc/classes/TaskJuggler/FlagListAttribute.html +0 -263
- data/doc/classes/TaskJuggler/FloatAttribute.html +0 -229
- data/doc/classes/TaskJuggler/FormatListAttribute.html +0 -197
- data/doc/classes/TaskJuggler/GanttChart.html +0 -696
- data/doc/classes/TaskJuggler/GanttContainer.html +0 -445
- data/doc/classes/TaskJuggler/GanttHeader.html +0 -284
- data/doc/classes/TaskJuggler/GanttHeaderScaleItem.html +0 -249
- data/doc/classes/TaskJuggler/GanttLine.html +0 -402
- data/doc/classes/TaskJuggler/GanttLoadStack.html +0 -331
- data/doc/classes/TaskJuggler/GanttMilestone.html +0 -419
- data/doc/classes/TaskJuggler/GanttRouter.html +0 -431
- data/doc/classes/TaskJuggler/GanttTaskBar.html +0 -433
- data/doc/classes/TaskJuggler/HTMLDocument.html +0 -240
- data/doc/classes/TaskJuggler/HTMLGraphics.html +0 -231
- data/doc/classes/TaskJuggler/Interval.html +0 -558
- data/doc/classes/TaskJuggler/IntervalListAttribute.html +0 -267
- data/doc/classes/TaskJuggler/JobInfo.html +0 -340
- data/doc/classes/TaskJuggler/Journal.html +0 -443
- data/doc/classes/TaskJuggler/JournalEntry.html +0 -274
- data/doc/classes/TaskJuggler/JournalEntryList.html +0 -454
- data/doc/classes/TaskJuggler/KeywordArray.html +0 -179
- data/doc/classes/TaskJuggler/KeywordDocumentation.html +0 -846
- data/doc/classes/TaskJuggler/Limits/Limit.html +0 -385
- data/doc/classes/TaskJuggler/Limits.html +0 -422
- data/doc/classes/TaskJuggler/LimitsAttribute.html +0 -261
- data/doc/classes/TaskJuggler/ListAttributeBase.html +0 -207
- data/doc/classes/TaskJuggler/Log.html +0 -655
- data/doc/classes/TaskJuggler/LogicalAttribute.html +0 -259
- data/doc/classes/TaskJuggler/LogicalExpression.html +0 -292
- data/doc/classes/TaskJuggler/LogicalExpressionAttribute.html +0 -194
- data/doc/classes/TaskJuggler/LogicalFlag.html +0 -209
- data/doc/classes/TaskJuggler/LogicalFunction.html +0 -339
- data/doc/classes/TaskJuggler/LogicalOperation.html +0 -351
- data/doc/classes/TaskJuggler/Macro.html +0 -198
- data/doc/classes/TaskJuggler/MacroParser.html +0 -360
- data/doc/classes/TaskJuggler/MacroTable.html +0 -370
- data/doc/classes/TaskJuggler/Message.html +0 -285
- data/doc/classes/TaskJuggler/MessageHandler.html +0 -231
- data/doc/classes/TaskJuggler/Navigator.html +0 -313
- data/doc/classes/TaskJuggler/NavigatorElement.html +0 -449
- data/doc/classes/TaskJuggler/OnShiftCache.html +0 -316
- data/doc/classes/TaskJuggler/Project.html +0 -2257
- data/doc/classes/TaskJuggler/ProjectFileParser.html +0 -420
- data/doc/classes/TaskJuggler/PropertyAttribute.html +0 -194
- data/doc/classes/TaskJuggler/PropertyList.html +0 -668
- data/doc/classes/TaskJuggler/PropertySet.html +0 -1286
- data/doc/classes/TaskJuggler/PropertyTreeNode.html +0 -1742
- data/doc/classes/TaskJuggler/Query.html +0 -870
- data/doc/classes/TaskJuggler/RTFNavigator.html +0 -293
- data/doc/classes/TaskJuggler/RTFQuery.html +0 -343
- data/doc/classes/TaskJuggler/RTFReport.html +0 -304
- data/doc/classes/TaskJuggler/RealFormat.html +0 -309
- data/doc/classes/TaskJuggler/RealFormatAttribute.html +0 -162
- data/doc/classes/TaskJuggler/ReferenceAttribute.html +0 -328
- data/doc/classes/TaskJuggler/RemoteServiceManager.html +0 -335
- data/doc/classes/TaskJuggler/Report.html +0 -321
- data/doc/classes/TaskJuggler/ReportBase.html +0 -437
- data/doc/classes/TaskJuggler/ReportContext.html +0 -248
- data/doc/classes/TaskJuggler/ReportServer.html +0 -320
- data/doc/classes/TaskJuggler/ReportTable.html +0 -526
- data/doc/classes/TaskJuggler/ReportTableCell.html +0 -614
- data/doc/classes/TaskJuggler/ReportTableColumn.html +0 -368
- data/doc/classes/TaskJuggler/ReportTableLegend.html +0 -347
- data/doc/classes/TaskJuggler/ReportTableLine.html +0 -481
- data/doc/classes/TaskJuggler/Resource.html +0 -211
- data/doc/classes/TaskJuggler/ResourceListAttribute.html +0 -302
- data/doc/classes/TaskJuggler/ResourceListRE.html +0 -245
- data/doc/classes/TaskJuggler/ResourceScenario.html +0 -1229
- data/doc/classes/TaskJuggler/RichText.html +0 -357
- data/doc/classes/TaskJuggler/RichTextAttribute.html +0 -293
- data/doc/classes/TaskJuggler/RichTextDocument.html +0 -424
- data/doc/classes/TaskJuggler/RichTextElement.html +0 -932
- data/doc/classes/TaskJuggler/RichTextException.html +0 -212
- data/doc/classes/TaskJuggler/RichTextFunctionExample.html +0 -301
- data/doc/classes/TaskJuggler/RichTextFunctionHandler.html +0 -245
- data/doc/classes/TaskJuggler/RichTextIntermediate.html +0 -563
- data/doc/classes/TaskJuggler/RichTextParser.html +0 -321
- data/doc/classes/TaskJuggler/RichTextScanner.html +0 -424
- data/doc/classes/TaskJuggler/RichTextSnip.html +0 -404
- data/doc/classes/TaskJuggler/RichTextSyntaxRules.html +0 -1105
- data/doc/classes/TaskJuggler/Scenario.html +0 -163
- data/doc/classes/TaskJuggler/ScenarioData.html +0 -358
- data/doc/classes/TaskJuggler/ScenarioListAttribute.html +0 -229
- data/doc/classes/TaskJuggler/Scoreboard.html +0 -642
- data/doc/classes/TaskJuggler/Shift.html +0 -255
- data/doc/classes/TaskJuggler/ShiftAssignment.html +0 -492
- data/doc/classes/TaskJuggler/ShiftAssignments.html +0 -719
- data/doc/classes/TaskJuggler/ShiftAssignmentsAttribute.html +0 -261
- data/doc/classes/TaskJuggler/ShiftScenario.html +0 -282
- data/doc/classes/TaskJuggler/SortListAttribute.html +0 -196
- data/doc/classes/TaskJuggler/SourceFileInfo.html +0 -251
- data/doc/classes/TaskJuggler/StringAttribute.html +0 -229
- data/doc/classes/TaskJuggler/SymbolAttribute.html +0 -194
- data/doc/classes/TaskJuggler/SyntaxReference.html +0 -520
- data/doc/classes/TaskJuggler/TOCEntry.html +0 -246
- data/doc/classes/TaskJuggler/TSResourceRecord.html +0 -197
- data/doc/classes/TaskJuggler/TSTaskRecord.html +0 -215
- data/doc/classes/TaskJuggler/TableColumnDefinition.html +0 -309
- data/doc/classes/TaskJuggler/TableOfContents.html +0 -260
- data/doc/classes/TaskJuggler/TableReport.html +0 -1015
- data/doc/classes/TaskJuggler/Task.html +0 -203
- data/doc/classes/TaskJuggler/TaskDependency.html +0 -255
- data/doc/classes/TaskJuggler/TaskListAttribute.html +0 -267
- data/doc/classes/TaskJuggler/TaskListRE.html +0 -245
- data/doc/classes/TaskJuggler/TaskScenario.html +0 -2543
- data/doc/classes/TaskJuggler/TextParser/Pattern.html +0 -927
- data/doc/classes/TaskJuggler/TextParser/Rule.html +0 -783
- data/doc/classes/TaskJuggler/TextParser/StackElement.html +0 -272
- data/doc/classes/TaskJuggler/TextParser/TextParserResultArray.html +0 -212
- data/doc/classes/TaskJuggler/TextParser/TokenDoc.html +0 -225
- data/doc/classes/TaskJuggler/TextParser.html +0 -754
- data/doc/classes/TaskJuggler/TextReport.html +0 -367
- data/doc/classes/TaskJuggler/TextScanner/BufferStreamHandle.html +0 -355
- data/doc/classes/TaskJuggler/TextScanner/FileStreamHandle.html +0 -348
- data/doc/classes/TaskJuggler/TextScanner/StreamHandle.html +0 -264
- data/doc/classes/TaskJuggler/TextScanner.html +0 -815
- data/doc/classes/TaskJuggler/TimeSheetReport.html +0 -406
- data/doc/classes/TaskJuggler/TjException.html +0 -185
- data/doc/classes/TaskJuggler/TjTime.html +0 -1904
- data/doc/classes/TaskJuggler/TjpExample.html +0 -314
- data/doc/classes/TaskJuggler/TjpExportRE.html +0 -306
- data/doc/classes/TaskJuggler/TjpSyntaxRules.html +0 -10812
- data/doc/classes/TaskJuggler/UserManual.html +0 -605
- data/doc/classes/TaskJuggler/WorkingHours.html +0 -586
- data/doc/classes/TaskJuggler/WorkingHoursAttribute.html +0 -252
- data/doc/classes/TaskJuggler/XMLBlob.html +0 -207
- data/doc/classes/TaskJuggler/XMLComment.html +0 -206
- data/doc/classes/TaskJuggler/XMLDocument.html +0 -298
- data/doc/classes/TaskJuggler/XMLElement.html +0 -389
- data/doc/classes/TaskJuggler/XMLNamedText.html +0 -174
- data/doc/classes/TaskJuggler/XMLText.html +0 -221
- data/doc/classes/TaskJuggler.html +0 -1573
- data/doc/files/COPYING.html +0 -448
- data/doc/files/README.html +0 -134
- data/doc/files/lib/AccountScenario_rb.html +0 -117
- data/doc/files/lib/Account_rb.html +0 -119
- data/doc/files/lib/Allocation_rb.html +0 -119
- data/doc/files/lib/AppConfig_rb.html +0 -119
- data/doc/files/lib/AttributeBase_rb.html +0 -117
- data/doc/files/lib/AttributeDefinition_rb.html +0 -107
- data/doc/files/lib/Attributes_rb.html +0 -131
- data/doc/files/lib/BatchProcessor_rb.html +0 -119
- data/doc/files/lib/Booking_rb.html +0 -107
- data/doc/files/lib/ChargeSet_rb.html +0 -117
- data/doc/files/lib/Charge_rb.html +0 -117
- data/doc/files/lib/HTMLDocument_rb.html +0 -117
- data/doc/files/lib/Interval_rb.html +0 -117
- data/doc/files/lib/Journal_rb.html +0 -107
- data/doc/files/lib/KeywordArray_rb.html +0 -107
- data/doc/files/lib/KeywordDocumentation_rb.html +0 -123
- data/doc/files/lib/Limits_rb.html +0 -117
- data/doc/files/lib/Log_rb.html +0 -117
- data/doc/files/lib/LogicalExpression_rb.html +0 -121
- data/doc/files/lib/LogicalFunction_rb.html +0 -117
- data/doc/files/lib/LogicalOperation_rb.html +0 -117
- data/doc/files/lib/MacroParser_rb.html +0 -119
- data/doc/files/lib/MacroTable_rb.html +0 -123
- data/doc/files/lib/MessageHandler_rb.html +0 -107
- data/doc/files/lib/Message_rb.html +0 -117
- data/doc/files/lib/ProjectFileParser_rb.html +0 -129
- data/doc/files/lib/Project_rb.html +0 -153
- data/doc/files/lib/PropertyList_rb.html +0 -107
- data/doc/files/lib/PropertySet_rb.html +0 -119
- data/doc/files/lib/PropertyTreeNode_rb.html +0 -107
- data/doc/files/lib/Query_rb.html +0 -117
- data/doc/files/lib/RTFNavigator_rb.html +0 -121
- data/doc/files/lib/RTFQuery_rb.html +0 -121
- data/doc/files/lib/RTFReport_rb.html +0 -119
- data/doc/files/lib/RealFormat_rb.html +0 -107
- data/doc/files/lib/RemoteServiceManager_rb.html +0 -117
- data/doc/files/lib/ReportServer_rb.html +0 -107
- data/doc/files/lib/ResourceScenario_rb.html +0 -117
- data/doc/files/lib/Resource_rb.html +0 -119
- data/doc/files/lib/RichTextDocument_rb.html +0 -121
- data/doc/files/lib/RichTextElement_rb.html +0 -121
- data/doc/files/lib/RichTextFunctionExample_rb.html +0 -121
- data/doc/files/lib/RichTextFunctionHandler_rb.html +0 -107
- data/doc/files/lib/RichTextParser_rb.html +0 -121
- data/doc/files/lib/RichTextScanner_rb.html +0 -117
- data/doc/files/lib/RichTextSnip_rb.html +0 -119
- data/doc/files/lib/RichTextSyntaxRules_rb.html +0 -107
- data/doc/files/lib/RichText_rb.html +0 -119
- data/doc/files/lib/ScenarioData_rb.html +0 -119
- data/doc/files/lib/Scenario_rb.html +0 -117
- data/doc/files/lib/Scoreboard_rb.html +0 -107
- data/doc/files/lib/ShiftAssignments_rb.html +0 -117
- data/doc/files/lib/ShiftScenario_rb.html +0 -117
- data/doc/files/lib/Shift_rb.html +0 -119
- data/doc/files/lib/SourceFileInfo_rb.html +0 -107
- data/doc/files/lib/SyntaxReference_rb.html +0 -123
- data/doc/files/lib/TOCEntry_rb.html +0 -119
- data/doc/files/lib/TableColumnDefinition_rb.html +0 -107
- data/doc/files/lib/TableOfContents_rb.html +0 -119
- data/doc/files/lib/TaskDependency_rb.html +0 -107
- data/doc/files/lib/TaskJuggler_rb.html +0 -125
- data/doc/files/lib/TaskScenario_rb.html +0 -117
- data/doc/files/lib/Task_rb.html +0 -119
- data/doc/files/lib/TextParser/Pattern_rb.html +0 -117
- data/doc/files/lib/TextParser/Rule_rb.html +0 -107
- data/doc/files/lib/TextParser/StackElement_rb.html +0 -107
- data/doc/files/lib/TextParser/TokenDoc_rb.html +0 -107
- data/doc/files/lib/TextParser_rb.html +0 -125
- data/doc/files/lib/TextScanner_rb.html +0 -129
- data/doc/files/lib/Tj3Config_rb.html +0 -119
- data/doc/files/lib/TjException_rb.html +0 -107
- data/doc/files/lib/TjTime_rb.html +0 -119
- data/doc/files/lib/TjpExample_rb.html +0 -117
- data/doc/files/lib/TjpSyntaxRules_rb.html +0 -107
- data/doc/files/lib/UTF8String_rb.html +0 -140
- data/doc/files/lib/UserManual_rb.html +0 -127
- data/doc/files/lib/WorkingHours_rb.html +0 -117
- data/doc/files/lib/XMLDocument_rb.html +0 -117
- data/doc/files/lib/XMLElement_rb.html +0 -117
- data/doc/files/lib/deep_copy_rb.html +0 -107
- data/doc/files/lib/reports/CSVFile_rb.html +0 -117
- data/doc/files/lib/reports/ColumnTable_rb.html +0 -117
- data/doc/files/lib/reports/GanttChart_rb.html +0 -123
- data/doc/files/lib/reports/GanttContainer_rb.html +0 -117
- data/doc/files/lib/reports/GanttHeaderScaleItem_rb.html +0 -107
- data/doc/files/lib/reports/GanttHeader_rb.html +0 -117
- data/doc/files/lib/reports/GanttLine_rb.html +0 -127
- data/doc/files/lib/reports/GanttLoadStack_rb.html +0 -117
- data/doc/files/lib/reports/GanttMilestone_rb.html +0 -117
- data/doc/files/lib/reports/GanttRouter_rb.html +0 -107
- data/doc/files/lib/reports/GanttTaskBar_rb.html +0 -117
- data/doc/files/lib/reports/HTMLGraphics_rb.html +0 -107
- data/doc/files/lib/reports/Navigator_rb.html +0 -117
- data/doc/files/lib/reports/ReportBase_rb.html +0 -107
- data/doc/files/lib/reports/ReportContext_rb.html +0 -107
- data/doc/files/lib/reports/ReportTableCell_rb.html +0 -107
- data/doc/files/lib/reports/ReportTableColumn_rb.html +0 -107
- data/doc/files/lib/reports/ReportTableLegend_rb.html +0 -107
- data/doc/files/lib/reports/ReportTableLine_rb.html +0 -117
- data/doc/files/lib/reports/ReportTable_rb.html +0 -119
- data/doc/files/lib/reports/Report_rb.html +0 -137
- data/doc/files/lib/reports/ResourceListRE_rb.html +0 -123
- data/doc/files/lib/reports/TableReport_rb.html +0 -125
- data/doc/files/lib/reports/TaskListRE_rb.html +0 -123
- data/doc/files/lib/reports/TextReport_rb.html +0 -117
- data/doc/files/lib/reports/TimeSheetReport_rb.html +0 -117
- data/doc/files/lib/reports/TjpExportRE_rb.html +0 -117
- data/doc/files/lib/taskjuggler3_rb.html +0 -298
- data/doc/files/lib/tj3client_rb.html +0 -280
- data/doc/files/lib/tj3man_rb.html +0 -190
- data/doc/fr_class_index.html +0 -345
- data/doc/fr_file_index.html +0 -247
- data/doc/fr_method_index.html +0 -2355
- data/doc/rdoc-style.css +0 -299
- data/lib/RemoteServiceManager.rb +0 -80
- data/lib/ReportServer.rb +0 -66
- data/test/TestSuite/HTML-Reports/Alerts.html +0 -172
- data/test/TestSuite/HTML-Reports/CellText.html +0 -758
- data/test/TestSuite/HTML-Reports/ColumnPeriods.html +0 -156
- data/test/TestSuite/HTML-Reports/IsOngoing.html +0 -172
- data/test/TestSuite/HTML-Reports/LogicalFunctions.html +0 -80
- data/test/TestSuite/HTML-Reports/Query.html +0 -31
- data/test/TestSuite/HTML-Reports/depArrows.html +0 -842
- data/test/TestSuite/Syntax/Correct/RawHTML.tjp +0 -31
- data/test/TestSuite/Syntax/Correct/icons/flag-green.png +0 -0
- data/test/TestSuite/Syntax/Correct/icons/flag-red.png +0 -0
- data/test/TestSuite/Syntax/Correct/icons/flag-yellow.png +0 -0
- data/test/TestSuite/Syntax/Correct/scripts/wz_tooltip.js +0 -1301
- data/test/TestSuite/Syntax/Errors/export_bad_extn.tjp +0 -9
|
@@ -0,0 +1,1662 @@
|
|
|
1
|
+
<?xml version="1.0" encoding="utf-8"?>
|
|
2
|
+
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
|
|
3
|
+
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
|
|
4
|
+
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
|
|
5
|
+
<head>
|
|
6
|
+
<meta content="text/html; charset=utf-8" http-equiv="Content-Type" />
|
|
7
|
+
|
|
8
|
+
<title>Class: TaskJuggler::KeywordDocumentation</title>
|
|
9
|
+
|
|
10
|
+
<link rel="stylesheet" href="../rdoc.css" type="text/css" media="screen" />
|
|
11
|
+
|
|
12
|
+
<script src="../js/jquery.js" type="text/javascript"
|
|
13
|
+
charset="utf-8"></script>
|
|
14
|
+
<script src="../js/thickbox-compressed.js" type="text/javascript"
|
|
15
|
+
charset="utf-8"></script>
|
|
16
|
+
<script src="../js/quicksearch.js" type="text/javascript"
|
|
17
|
+
charset="utf-8"></script>
|
|
18
|
+
<script src="../js/darkfish.js" type="text/javascript"
|
|
19
|
+
charset="utf-8"></script>
|
|
20
|
+
|
|
21
|
+
</head>
|
|
22
|
+
<body class="class">
|
|
23
|
+
|
|
24
|
+
<div id="metadata">
|
|
25
|
+
<div id="home-metadata">
|
|
26
|
+
<div id="home-section" class="section">
|
|
27
|
+
<h3 class="section-header">
|
|
28
|
+
<a href="../index.html">Home</a>
|
|
29
|
+
<a href="../index.html#classes">Classes</a>
|
|
30
|
+
<a href="../index.html#methods">Methods</a>
|
|
31
|
+
</h3>
|
|
32
|
+
</div>
|
|
33
|
+
</div>
|
|
34
|
+
|
|
35
|
+
<div id="file-metadata">
|
|
36
|
+
<div id="file-list-section" class="section">
|
|
37
|
+
<h3 class="section-header">In Files</h3>
|
|
38
|
+
<div class="section-body">
|
|
39
|
+
<ul>
|
|
40
|
+
|
|
41
|
+
<li><a href="../lib/KeywordDocumentation_rb.html?TB_iframe=true&height=550&width=785"
|
|
42
|
+
class="thickbox" title="lib/KeywordDocumentation.rb">lib/KeywordDocumentation.rb</a></li>
|
|
43
|
+
|
|
44
|
+
</ul>
|
|
45
|
+
</div>
|
|
46
|
+
</div>
|
|
47
|
+
|
|
48
|
+
|
|
49
|
+
</div>
|
|
50
|
+
|
|
51
|
+
<div id="class-metadata">
|
|
52
|
+
|
|
53
|
+
<!-- Parent Class -->
|
|
54
|
+
|
|
55
|
+
<div id="parent-class-section" class="section">
|
|
56
|
+
<h3 class="section-header">Parent</h3>
|
|
57
|
+
|
|
58
|
+
<p class="link"><a href="../Object.html">Object</a></p>
|
|
59
|
+
|
|
60
|
+
</div>
|
|
61
|
+
|
|
62
|
+
|
|
63
|
+
<!-- Namespace Contents -->
|
|
64
|
+
|
|
65
|
+
|
|
66
|
+
<!-- Method Quickref -->
|
|
67
|
+
|
|
68
|
+
<div id="method-list-section" class="section">
|
|
69
|
+
<h3 class="section-header">Methods</h3>
|
|
70
|
+
<ul class="link-list">
|
|
71
|
+
|
|
72
|
+
<li><a href="#M000999">::new</a></li>
|
|
73
|
+
|
|
74
|
+
<li><a href="#M001005">#checkReference</a></li>
|
|
75
|
+
|
|
76
|
+
<li><a href="#M001001">#computeInheritance</a></li>
|
|
77
|
+
|
|
78
|
+
<li><a href="#M001000">#crossReference</a></li>
|
|
79
|
+
|
|
80
|
+
<li><a href="#M001011">#format</a></li>
|
|
81
|
+
|
|
82
|
+
<li><a href="#M001004">#generateHTML</a></li>
|
|
83
|
+
|
|
84
|
+
<li><a href="#M001007">#generateHTMLNavigationBar</a></li>
|
|
85
|
+
|
|
86
|
+
<li><a href="#M001006">#indent</a></li>
|
|
87
|
+
|
|
88
|
+
<li><a href="#M001008">#keywordHTMLRef</a></li>
|
|
89
|
+
|
|
90
|
+
<li><a href="#M001010">#listHTMLAttributes</a></li>
|
|
91
|
+
|
|
92
|
+
<li><a href="#M001009">#newRichText</a></li>
|
|
93
|
+
|
|
94
|
+
<li><a href="#M001002">#title</a></li>
|
|
95
|
+
|
|
96
|
+
<li><a href="#M001003">#to_s</a></li>
|
|
97
|
+
|
|
98
|
+
</ul>
|
|
99
|
+
</div>
|
|
100
|
+
|
|
101
|
+
|
|
102
|
+
<!-- Included Modules -->
|
|
103
|
+
|
|
104
|
+
</div>
|
|
105
|
+
|
|
106
|
+
<div id="project-metadata">
|
|
107
|
+
|
|
108
|
+
|
|
109
|
+
<div id="fileindex-section" class="section project-section">
|
|
110
|
+
<h3 class="section-header">Files</h3>
|
|
111
|
+
<ul>
|
|
112
|
+
|
|
113
|
+
<li class="file"><a href="../COPYING.html">COPYING</a></li>
|
|
114
|
+
|
|
115
|
+
<li class="file"><a href="../README.html">README</a></li>
|
|
116
|
+
|
|
117
|
+
</ul>
|
|
118
|
+
</div>
|
|
119
|
+
|
|
120
|
+
|
|
121
|
+
<div id="classindex-section" class="section project-section">
|
|
122
|
+
<h3 class="section-header">Class Index
|
|
123
|
+
<span class="search-toggle"><img src="../images/find.png"
|
|
124
|
+
height="16" width="16" alt="[+]"
|
|
125
|
+
title="show/hide quicksearch" /></span></h3>
|
|
126
|
+
<form action="#" method="get" accept-charset="utf-8" class="initially-hidden">
|
|
127
|
+
<fieldset>
|
|
128
|
+
<legend>Quicksearch</legend>
|
|
129
|
+
<input type="text" name="quicksearch" value=""
|
|
130
|
+
class="quicksearch-field" />
|
|
131
|
+
</fieldset>
|
|
132
|
+
</form>
|
|
133
|
+
|
|
134
|
+
<ul class="link-list">
|
|
135
|
+
|
|
136
|
+
<li><a href="../TaskJuggler.html">TaskJuggler</a></li>
|
|
137
|
+
|
|
138
|
+
<li><a href="../TaskJuggler/Account.html">TaskJuggler::Account</a></li>
|
|
139
|
+
|
|
140
|
+
<li><a href="../TaskJuggler/AccountAttribute.html">TaskJuggler::AccountAttribute</a></li>
|
|
141
|
+
|
|
142
|
+
<li><a href="../TaskJuggler/AccountScenario.html">TaskJuggler::AccountScenario</a></li>
|
|
143
|
+
|
|
144
|
+
<li><a href="../TaskJuggler/Allocation.html">TaskJuggler::Allocation</a></li>
|
|
145
|
+
|
|
146
|
+
<li><a href="../TaskJuggler/AllocationAttribute.html">TaskJuggler::AllocationAttribute</a></li>
|
|
147
|
+
|
|
148
|
+
<li><a href="../TaskJuggler/AttributeBase.html">TaskJuggler::AttributeBase</a></li>
|
|
149
|
+
|
|
150
|
+
<li><a href="../TaskJuggler/AttributeDefinition.html">TaskJuggler::AttributeDefinition</a></li>
|
|
151
|
+
|
|
152
|
+
<li><a href="../TaskJuggler/BatchProcessor.html">TaskJuggler::BatchProcessor</a></li>
|
|
153
|
+
|
|
154
|
+
<li><a href="../TaskJuggler/Booking.html">TaskJuggler::Booking</a></li>
|
|
155
|
+
|
|
156
|
+
<li><a href="../TaskJuggler/BookingListAttribute.html">TaskJuggler::BookingListAttribute</a></li>
|
|
157
|
+
|
|
158
|
+
<li><a href="../TaskJuggler/BooleanAttribute.html">TaskJuggler::BooleanAttribute</a></li>
|
|
159
|
+
|
|
160
|
+
<li><a href="../TaskJuggler/CSVFile.html">TaskJuggler::CSVFile</a></li>
|
|
161
|
+
|
|
162
|
+
<li><a href="../TaskJuggler/CellSettingPattern.html">TaskJuggler::CellSettingPattern</a></li>
|
|
163
|
+
|
|
164
|
+
<li><a href="../TaskJuggler/CellSettingPatternList.html">TaskJuggler::CellSettingPatternList</a></li>
|
|
165
|
+
|
|
166
|
+
<li><a href="../TaskJuggler/Charge.html">TaskJuggler::Charge</a></li>
|
|
167
|
+
|
|
168
|
+
<li><a href="../TaskJuggler/ChargeListAttribute.html">TaskJuggler::ChargeListAttribute</a></li>
|
|
169
|
+
|
|
170
|
+
<li><a href="../TaskJuggler/ChargeSet.html">TaskJuggler::ChargeSet</a></li>
|
|
171
|
+
|
|
172
|
+
<li><a href="../TaskJuggler/ChargeSetListAttribute.html">TaskJuggler::ChargeSetListAttribute</a></li>
|
|
173
|
+
|
|
174
|
+
<li><a href="../TaskJuggler/ColumnListAttribute.html">TaskJuggler::ColumnListAttribute</a></li>
|
|
175
|
+
|
|
176
|
+
<li><a href="../TaskJuggler/ColumnTable.html">TaskJuggler::ColumnTable</a></li>
|
|
177
|
+
|
|
178
|
+
<li><a href="../TaskJuggler/Daemon.html">TaskJuggler::Daemon</a></li>
|
|
179
|
+
|
|
180
|
+
<li><a href="../TaskJuggler/DateAttribute.html">TaskJuggler::DateAttribute</a></li>
|
|
181
|
+
|
|
182
|
+
<li><a href="../TaskJuggler/DefinitionListAttribute.html">TaskJuggler::DefinitionListAttribute</a></li>
|
|
183
|
+
|
|
184
|
+
<li><a href="../TaskJuggler/DependencyListAttribute.html">TaskJuggler::DependencyListAttribute</a></li>
|
|
185
|
+
|
|
186
|
+
<li><a href="../TaskJuggler/DurationAttribute.html">TaskJuggler::DurationAttribute</a></li>
|
|
187
|
+
|
|
188
|
+
<li><a href="../TaskJuggler/FixnumAttribute.html">TaskJuggler::FixnumAttribute</a></li>
|
|
189
|
+
|
|
190
|
+
<li><a href="../TaskJuggler/FlagListAttribute.html">TaskJuggler::FlagListAttribute</a></li>
|
|
191
|
+
|
|
192
|
+
<li><a href="../TaskJuggler/FloatAttribute.html">TaskJuggler::FloatAttribute</a></li>
|
|
193
|
+
|
|
194
|
+
<li><a href="../TaskJuggler/FormatListAttribute.html">TaskJuggler::FormatListAttribute</a></li>
|
|
195
|
+
|
|
196
|
+
<li><a href="../TaskJuggler/GanttChart.html">TaskJuggler::GanttChart</a></li>
|
|
197
|
+
|
|
198
|
+
<li><a href="../TaskJuggler/GanttContainer.html">TaskJuggler::GanttContainer</a></li>
|
|
199
|
+
|
|
200
|
+
<li><a href="../TaskJuggler/GanttHeader.html">TaskJuggler::GanttHeader</a></li>
|
|
201
|
+
|
|
202
|
+
<li><a href="../TaskJuggler/GanttHeaderScaleItem.html">TaskJuggler::GanttHeaderScaleItem</a></li>
|
|
203
|
+
|
|
204
|
+
<li><a href="../TaskJuggler/GanttLine.html">TaskJuggler::GanttLine</a></li>
|
|
205
|
+
|
|
206
|
+
<li><a href="../TaskJuggler/GanttLoadStack.html">TaskJuggler::GanttLoadStack</a></li>
|
|
207
|
+
|
|
208
|
+
<li><a href="../TaskJuggler/GanttMilestone.html">TaskJuggler::GanttMilestone</a></li>
|
|
209
|
+
|
|
210
|
+
<li><a href="../TaskJuggler/GanttRouter.html">TaskJuggler::GanttRouter</a></li>
|
|
211
|
+
|
|
212
|
+
<li><a href="../TaskJuggler/GanttTaskBar.html">TaskJuggler::GanttTaskBar</a></li>
|
|
213
|
+
|
|
214
|
+
<li><a href="../TaskJuggler/HTMLDocument.html">TaskJuggler::HTMLDocument</a></li>
|
|
215
|
+
|
|
216
|
+
<li><a href="../TaskJuggler/HTMLGraphics.html">TaskJuggler::HTMLGraphics</a></li>
|
|
217
|
+
|
|
218
|
+
<li><a href="../TaskJuggler/Interval.html">TaskJuggler::Interval</a></li>
|
|
219
|
+
|
|
220
|
+
<li><a href="../TaskJuggler/IntervalListAttribute.html">TaskJuggler::IntervalListAttribute</a></li>
|
|
221
|
+
|
|
222
|
+
<li><a href="../TaskJuggler/JobInfo.html">TaskJuggler::JobInfo</a></li>
|
|
223
|
+
|
|
224
|
+
<li><a href="../TaskJuggler/Journal.html">TaskJuggler::Journal</a></li>
|
|
225
|
+
|
|
226
|
+
<li><a href="../TaskJuggler/JournalEntry.html">TaskJuggler::JournalEntry</a></li>
|
|
227
|
+
|
|
228
|
+
<li><a href="../TaskJuggler/JournalEntryList.html">TaskJuggler::JournalEntryList</a></li>
|
|
229
|
+
|
|
230
|
+
<li><a href="../TaskJuggler/KeywordArray.html">TaskJuggler::KeywordArray</a></li>
|
|
231
|
+
|
|
232
|
+
<li><a href="../TaskJuggler/KeywordDocumentation.html">TaskJuggler::KeywordDocumentation</a></li>
|
|
233
|
+
|
|
234
|
+
<li><a href="../TaskJuggler/Limits.html">TaskJuggler::Limits</a></li>
|
|
235
|
+
|
|
236
|
+
<li><a href="../TaskJuggler/Limits/Limit.html">TaskJuggler::Limits::Limit</a></li>
|
|
237
|
+
|
|
238
|
+
<li><a href="../TaskJuggler/LimitsAttribute.html">TaskJuggler::LimitsAttribute</a></li>
|
|
239
|
+
|
|
240
|
+
<li><a href="../TaskJuggler/ListAttributeBase.html">TaskJuggler::ListAttributeBase</a></li>
|
|
241
|
+
|
|
242
|
+
<li><a href="../TaskJuggler/Log.html">TaskJuggler::Log</a></li>
|
|
243
|
+
|
|
244
|
+
<li><a href="../TaskJuggler/LogFile.html">TaskJuggler::LogFile</a></li>
|
|
245
|
+
|
|
246
|
+
<li><a href="../TaskJuggler/LogicalAttribute.html">TaskJuggler::LogicalAttribute</a></li>
|
|
247
|
+
|
|
248
|
+
<li><a href="../TaskJuggler/LogicalExpression.html">TaskJuggler::LogicalExpression</a></li>
|
|
249
|
+
|
|
250
|
+
<li><a href="../TaskJuggler/LogicalExpressionAttribute.html">TaskJuggler::LogicalExpressionAttribute</a></li>
|
|
251
|
+
|
|
252
|
+
<li><a href="../TaskJuggler/LogicalFlag.html">TaskJuggler::LogicalFlag</a></li>
|
|
253
|
+
|
|
254
|
+
<li><a href="../TaskJuggler/LogicalFunction.html">TaskJuggler::LogicalFunction</a></li>
|
|
255
|
+
|
|
256
|
+
<li><a href="../TaskJuggler/LogicalOperation.html">TaskJuggler::LogicalOperation</a></li>
|
|
257
|
+
|
|
258
|
+
<li><a href="../TaskJuggler/Macro.html">TaskJuggler::Macro</a></li>
|
|
259
|
+
|
|
260
|
+
<li><a href="../TaskJuggler/MacroParser.html">TaskJuggler::MacroParser</a></li>
|
|
261
|
+
|
|
262
|
+
<li><a href="../TaskJuggler/MacroTable.html">TaskJuggler::MacroTable</a></li>
|
|
263
|
+
|
|
264
|
+
<li><a href="../TaskJuggler/ManagerResponsibilities.html">TaskJuggler::ManagerResponsibilities</a></li>
|
|
265
|
+
|
|
266
|
+
<li><a href="../TaskJuggler/ManagerStatusRecord.html">TaskJuggler::ManagerStatusRecord</a></li>
|
|
267
|
+
|
|
268
|
+
<li><a href="../TaskJuggler/Message.html">TaskJuggler::Message</a></li>
|
|
269
|
+
|
|
270
|
+
<li><a href="../TaskJuggler/MessageHandler.html">TaskJuggler::MessageHandler</a></li>
|
|
271
|
+
|
|
272
|
+
<li><a href="../TaskJuggler/Navigator.html">TaskJuggler::Navigator</a></li>
|
|
273
|
+
|
|
274
|
+
<li><a href="../TaskJuggler/NavigatorElement.html">TaskJuggler::NavigatorElement</a></li>
|
|
275
|
+
|
|
276
|
+
<li><a href="../TaskJuggler/NikuProject.html">TaskJuggler::NikuProject</a></li>
|
|
277
|
+
|
|
278
|
+
<li><a href="../TaskJuggler/NikuReport.html">TaskJuggler::NikuReport</a></li>
|
|
279
|
+
|
|
280
|
+
<li><a href="../TaskJuggler/NikuResource.html">TaskJuggler::NikuResource</a></li>
|
|
281
|
+
|
|
282
|
+
<li><a href="../TaskJuggler/OnShiftCache.html">TaskJuggler::OnShiftCache</a></li>
|
|
283
|
+
|
|
284
|
+
<li><a href="../TaskJuggler/ProcessIntercom.html">TaskJuggler::ProcessIntercom</a></li>
|
|
285
|
+
|
|
286
|
+
<li><a href="../TaskJuggler/ProcessIntercomIface.html">TaskJuggler::ProcessIntercomIface</a></li>
|
|
287
|
+
|
|
288
|
+
<li><a href="../TaskJuggler/Project.html">TaskJuggler::Project</a></li>
|
|
289
|
+
|
|
290
|
+
<li><a href="../TaskJuggler/ProjectBroker.html">TaskJuggler::ProjectBroker</a></li>
|
|
291
|
+
|
|
292
|
+
<li><a href="../TaskJuggler/ProjectBrokerIface.html">TaskJuggler::ProjectBrokerIface</a></li>
|
|
293
|
+
|
|
294
|
+
<li><a href="../TaskJuggler/ProjectFileParser.html">TaskJuggler::ProjectFileParser</a></li>
|
|
295
|
+
|
|
296
|
+
<li><a href="../TaskJuggler/ProjectRecord.html">TaskJuggler::ProjectRecord</a></li>
|
|
297
|
+
|
|
298
|
+
<li><a href="../TaskJuggler/ProjectServer.html">TaskJuggler::ProjectServer</a></li>
|
|
299
|
+
|
|
300
|
+
<li><a href="../TaskJuggler/ProjectServerIface.html">TaskJuggler::ProjectServerIface</a></li>
|
|
301
|
+
|
|
302
|
+
<li><a href="../TaskJuggler/PropertyAttribute.html">TaskJuggler::PropertyAttribute</a></li>
|
|
303
|
+
|
|
304
|
+
<li><a href="../TaskJuggler/PropertyList.html">TaskJuggler::PropertyList</a></li>
|
|
305
|
+
|
|
306
|
+
<li><a href="../TaskJuggler/PropertySet.html">TaskJuggler::PropertySet</a></li>
|
|
307
|
+
|
|
308
|
+
<li><a href="../TaskJuggler/PropertyTreeNode.html">TaskJuggler::PropertyTreeNode</a></li>
|
|
309
|
+
|
|
310
|
+
<li><a href="../TaskJuggler/Query.html">TaskJuggler::Query</a></li>
|
|
311
|
+
|
|
312
|
+
<li><a href="../TaskJuggler/RTFNavigator.html">TaskJuggler::RTFNavigator</a></li>
|
|
313
|
+
|
|
314
|
+
<li><a href="../TaskJuggler/RTFQuery.html">TaskJuggler::RTFQuery</a></li>
|
|
315
|
+
|
|
316
|
+
<li><a href="../TaskJuggler/RTFReport.html">TaskJuggler::RTFReport</a></li>
|
|
317
|
+
|
|
318
|
+
<li><a href="../TaskJuggler/RealFormat.html">TaskJuggler::RealFormat</a></li>
|
|
319
|
+
|
|
320
|
+
<li><a href="../TaskJuggler/RealFormatAttribute.html">TaskJuggler::RealFormatAttribute</a></li>
|
|
321
|
+
|
|
322
|
+
<li><a href="../TaskJuggler/ReferenceAttribute.html">TaskJuggler::ReferenceAttribute</a></li>
|
|
323
|
+
|
|
324
|
+
<li><a href="../TaskJuggler/Report.html">TaskJuggler::Report</a></li>
|
|
325
|
+
|
|
326
|
+
<li><a href="../TaskJuggler/ReportBase.html">TaskJuggler::ReportBase</a></li>
|
|
327
|
+
|
|
328
|
+
<li><a href="../TaskJuggler/ReportContext.html">TaskJuggler::ReportContext</a></li>
|
|
329
|
+
|
|
330
|
+
<li><a href="../TaskJuggler/ReportServer.html">TaskJuggler::ReportServer</a></li>
|
|
331
|
+
|
|
332
|
+
<li><a href="../TaskJuggler/ReportServerIface.html">TaskJuggler::ReportServerIface</a></li>
|
|
333
|
+
|
|
334
|
+
<li><a href="../TaskJuggler/ReportServerRecord.html">TaskJuggler::ReportServerRecord</a></li>
|
|
335
|
+
|
|
336
|
+
<li><a href="../TaskJuggler/ReportTable.html">TaskJuggler::ReportTable</a></li>
|
|
337
|
+
|
|
338
|
+
<li><a href="../TaskJuggler/ReportTableCell.html">TaskJuggler::ReportTableCell</a></li>
|
|
339
|
+
|
|
340
|
+
<li><a href="../TaskJuggler/ReportTableColumn.html">TaskJuggler::ReportTableColumn</a></li>
|
|
341
|
+
|
|
342
|
+
<li><a href="../TaskJuggler/ReportTableLegend.html">TaskJuggler::ReportTableLegend</a></li>
|
|
343
|
+
|
|
344
|
+
<li><a href="../TaskJuggler/ReportTableLine.html">TaskJuggler::ReportTableLine</a></li>
|
|
345
|
+
|
|
346
|
+
<li><a href="../TaskJuggler/Resource.html">TaskJuggler::Resource</a></li>
|
|
347
|
+
|
|
348
|
+
<li><a href="../TaskJuggler/ResourceListAttribute.html">TaskJuggler::ResourceListAttribute</a></li>
|
|
349
|
+
|
|
350
|
+
<li><a href="../TaskJuggler/ResourceListRE.html">TaskJuggler::ResourceListRE</a></li>
|
|
351
|
+
|
|
352
|
+
<li><a href="../TaskJuggler/ResourceScenario.html">TaskJuggler::ResourceScenario</a></li>
|
|
353
|
+
|
|
354
|
+
<li><a href="../TaskJuggler/RichText.html">TaskJuggler::RichText</a></li>
|
|
355
|
+
|
|
356
|
+
<li><a href="../TaskJuggler/RichTextAttribute.html">TaskJuggler::RichTextAttribute</a></li>
|
|
357
|
+
|
|
358
|
+
<li><a href="../TaskJuggler/RichTextDocument.html">TaskJuggler::RichTextDocument</a></li>
|
|
359
|
+
|
|
360
|
+
<li><a href="../TaskJuggler/RichTextElement.html">TaskJuggler::RichTextElement</a></li>
|
|
361
|
+
|
|
362
|
+
<li><a href="../TaskJuggler/RichTextException.html">TaskJuggler::RichTextException</a></li>
|
|
363
|
+
|
|
364
|
+
<li><a href="../TaskJuggler/RichTextFunctionExample.html">TaskJuggler::RichTextFunctionExample</a></li>
|
|
365
|
+
|
|
366
|
+
<li><a href="../TaskJuggler/RichTextFunctionHandler.html">TaskJuggler::RichTextFunctionHandler</a></li>
|
|
367
|
+
|
|
368
|
+
<li><a href="../TaskJuggler/RichTextImage.html">TaskJuggler::RichTextImage</a></li>
|
|
369
|
+
|
|
370
|
+
<li><a href="../TaskJuggler/RichTextIntermediate.html">TaskJuggler::RichTextIntermediate</a></li>
|
|
371
|
+
|
|
372
|
+
<li><a href="../TaskJuggler/RichTextParser.html">TaskJuggler::RichTextParser</a></li>
|
|
373
|
+
|
|
374
|
+
<li><a href="../TaskJuggler/RichTextScanner.html">TaskJuggler::RichTextScanner</a></li>
|
|
375
|
+
|
|
376
|
+
<li><a href="../TaskJuggler/RichTextSnip.html">TaskJuggler::RichTextSnip</a></li>
|
|
377
|
+
|
|
378
|
+
<li><a href="../TaskJuggler/RichTextSyntaxRules.html">TaskJuggler::RichTextSyntaxRules</a></li>
|
|
379
|
+
|
|
380
|
+
<li><a href="../TaskJuggler/Scenario.html">TaskJuggler::Scenario</a></li>
|
|
381
|
+
|
|
382
|
+
<li><a href="../TaskJuggler/ScenarioData.html">TaskJuggler::ScenarioData</a></li>
|
|
383
|
+
|
|
384
|
+
<li><a href="../TaskJuggler/ScenarioListAttribute.html">TaskJuggler::ScenarioListAttribute</a></li>
|
|
385
|
+
|
|
386
|
+
<li><a href="../TaskJuggler/Scoreboard.html">TaskJuggler::Scoreboard</a></li>
|
|
387
|
+
|
|
388
|
+
<li><a href="../TaskJuggler/SheetHandlerBase.html">TaskJuggler::SheetHandlerBase</a></li>
|
|
389
|
+
|
|
390
|
+
<li><a href="../TaskJuggler/SheetReceiver.html">TaskJuggler::SheetReceiver</a></li>
|
|
391
|
+
|
|
392
|
+
<li><a href="../TaskJuggler/SheetSender.html">TaskJuggler::SheetSender</a></li>
|
|
393
|
+
|
|
394
|
+
<li><a href="../TaskJuggler/Shift.html">TaskJuggler::Shift</a></li>
|
|
395
|
+
|
|
396
|
+
<li><a href="../TaskJuggler/ShiftAssignment.html">TaskJuggler::ShiftAssignment</a></li>
|
|
397
|
+
|
|
398
|
+
<li><a href="../TaskJuggler/ShiftAssignments.html">TaskJuggler::ShiftAssignments</a></li>
|
|
399
|
+
|
|
400
|
+
<li><a href="../TaskJuggler/ShiftAssignmentsAttribute.html">TaskJuggler::ShiftAssignmentsAttribute</a></li>
|
|
401
|
+
|
|
402
|
+
<li><a href="../TaskJuggler/ShiftScenario.html">TaskJuggler::ShiftScenario</a></li>
|
|
403
|
+
|
|
404
|
+
<li><a href="../TaskJuggler/SortListAttribute.html">TaskJuggler::SortListAttribute</a></li>
|
|
405
|
+
|
|
406
|
+
<li><a href="../TaskJuggler/SourceFileInfo.html">TaskJuggler::SourceFileInfo</a></li>
|
|
407
|
+
|
|
408
|
+
<li><a href="../TaskJuggler/StatusSheetReceiver.html">TaskJuggler::StatusSheetReceiver</a></li>
|
|
409
|
+
|
|
410
|
+
<li><a href="../TaskJuggler/StatusSheetReport.html">TaskJuggler::StatusSheetReport</a></li>
|
|
411
|
+
|
|
412
|
+
<li><a href="../TaskJuggler/StatusSheetSender.html">TaskJuggler::StatusSheetSender</a></li>
|
|
413
|
+
|
|
414
|
+
<li><a href="../TaskJuggler/StringAttribute.html">TaskJuggler::StringAttribute</a></li>
|
|
415
|
+
|
|
416
|
+
<li><a href="../TaskJuggler/SymbolAttribute.html">TaskJuggler::SymbolAttribute</a></li>
|
|
417
|
+
|
|
418
|
+
<li><a href="../TaskJuggler/SyntaxReference.html">TaskJuggler::SyntaxReference</a></li>
|
|
419
|
+
|
|
420
|
+
<li><a href="../TaskJuggler/TOCEntry.html">TaskJuggler::TOCEntry</a></li>
|
|
421
|
+
|
|
422
|
+
<li><a href="../TaskJuggler/TSResourceRecord.html">TaskJuggler::TSResourceRecord</a></li>
|
|
423
|
+
|
|
424
|
+
<li><a href="../TaskJuggler/TSTaskRecord.html">TaskJuggler::TSTaskRecord</a></li>
|
|
425
|
+
|
|
426
|
+
<li><a href="../TaskJuggler/TableColumnDefinition.html">TaskJuggler::TableColumnDefinition</a></li>
|
|
427
|
+
|
|
428
|
+
<li><a href="../TaskJuggler/TableOfContents.html">TaskJuggler::TableOfContents</a></li>
|
|
429
|
+
|
|
430
|
+
<li><a href="../TaskJuggler/TableReport.html">TaskJuggler::TableReport</a></li>
|
|
431
|
+
|
|
432
|
+
<li><a href="../TaskJuggler/Task.html">TaskJuggler::Task</a></li>
|
|
433
|
+
|
|
434
|
+
<li><a href="../TaskJuggler/TaskDependency.html">TaskJuggler::TaskDependency</a></li>
|
|
435
|
+
|
|
436
|
+
<li><a href="../TaskJuggler/TaskListAttribute.html">TaskJuggler::TaskListAttribute</a></li>
|
|
437
|
+
|
|
438
|
+
<li><a href="../TaskJuggler/TaskListRE.html">TaskJuggler::TaskListRE</a></li>
|
|
439
|
+
|
|
440
|
+
<li><a href="../TaskJuggler/TaskScenario.html">TaskJuggler::TaskScenario</a></li>
|
|
441
|
+
|
|
442
|
+
<li><a href="../TaskJuggler/TextFormatter.html">TaskJuggler::TextFormatter</a></li>
|
|
443
|
+
|
|
444
|
+
<li><a href="../TaskJuggler/TextParser.html">TaskJuggler::TextParser</a></li>
|
|
445
|
+
|
|
446
|
+
<li><a href="../TaskJuggler/TextParser/Pattern.html">TaskJuggler::TextParser::Pattern</a></li>
|
|
447
|
+
|
|
448
|
+
<li><a href="../TaskJuggler/TextParser/Rule.html">TaskJuggler::TextParser::Rule</a></li>
|
|
449
|
+
|
|
450
|
+
<li><a href="../TaskJuggler/TextParser/StackElement.html">TaskJuggler::TextParser::StackElement</a></li>
|
|
451
|
+
|
|
452
|
+
<li><a href="../TaskJuggler/TextParser/TextParserResultArray.html">TaskJuggler::TextParser::TextParserResultArray</a></li>
|
|
453
|
+
|
|
454
|
+
<li><a href="../TaskJuggler/TextParser/TokenDoc.html">TaskJuggler::TextParser::TokenDoc</a></li>
|
|
455
|
+
|
|
456
|
+
<li><a href="../TaskJuggler/TextReport.html">TaskJuggler::TextReport</a></li>
|
|
457
|
+
|
|
458
|
+
<li><a href="../TaskJuggler/TextScanner.html">TaskJuggler::TextScanner</a></li>
|
|
459
|
+
|
|
460
|
+
<li><a href="../TaskJuggler/TextScanner/BufferStreamHandle.html">TaskJuggler::TextScanner::BufferStreamHandle</a></li>
|
|
461
|
+
|
|
462
|
+
<li><a href="../TaskJuggler/TextScanner/FileStreamHandle.html">TaskJuggler::TextScanner::FileStreamHandle</a></li>
|
|
463
|
+
|
|
464
|
+
<li><a href="../TaskJuggler/TextScanner/StreamHandle.html">TaskJuggler::TextScanner::StreamHandle</a></li>
|
|
465
|
+
|
|
466
|
+
<li><a href="../TaskJuggler/TimeSheet.html">TaskJuggler::TimeSheet</a></li>
|
|
467
|
+
|
|
468
|
+
<li><a href="../TaskJuggler/TimeSheetReceiver.html">TaskJuggler::TimeSheetReceiver</a></li>
|
|
469
|
+
|
|
470
|
+
<li><a href="../TaskJuggler/TimeSheetRecord.html">TaskJuggler::TimeSheetRecord</a></li>
|
|
471
|
+
|
|
472
|
+
<li><a href="../TaskJuggler/TimeSheetReport.html">TaskJuggler::TimeSheetReport</a></li>
|
|
473
|
+
|
|
474
|
+
<li><a href="../TaskJuggler/TimeSheetSender.html">TaskJuggler::TimeSheetSender</a></li>
|
|
475
|
+
|
|
476
|
+
<li><a href="../TaskJuggler/TimeSheetSummary.html">TaskJuggler::TimeSheetSummary</a></li>
|
|
477
|
+
|
|
478
|
+
<li><a href="../TaskJuggler/TimeSheets.html">TaskJuggler::TimeSheets</a></li>
|
|
479
|
+
|
|
480
|
+
<li><a href="../TaskJuggler/Tj3AppBase.html">TaskJuggler::Tj3AppBase</a></li>
|
|
481
|
+
|
|
482
|
+
<li><a href="../TaskJuggler/Tj3Client.html">TaskJuggler::Tj3Client</a></li>
|
|
483
|
+
|
|
484
|
+
<li><a href="../TaskJuggler/Tj3Daemon.html">TaskJuggler::Tj3Daemon</a></li>
|
|
485
|
+
|
|
486
|
+
<li><a href="../TaskJuggler/Tj3SheetAppBase.html">TaskJuggler::Tj3SheetAppBase</a></li>
|
|
487
|
+
|
|
488
|
+
<li><a href="../TaskJuggler/Tj3SsReceiver.html">TaskJuggler::Tj3SsReceiver</a></li>
|
|
489
|
+
|
|
490
|
+
<li><a href="../TaskJuggler/Tj3SsSender.html">TaskJuggler::Tj3SsSender</a></li>
|
|
491
|
+
|
|
492
|
+
<li><a href="../TaskJuggler/Tj3TsReceiver.html">TaskJuggler::Tj3TsReceiver</a></li>
|
|
493
|
+
|
|
494
|
+
<li><a href="../TaskJuggler/Tj3TsSender.html">TaskJuggler::Tj3TsSender</a></li>
|
|
495
|
+
|
|
496
|
+
<li><a href="../TaskJuggler/Tj3TsSummary.html">TaskJuggler::Tj3TsSummary</a></li>
|
|
497
|
+
|
|
498
|
+
<li><a href="../TaskJuggler/TjException.html">TaskJuggler::TjException</a></li>
|
|
499
|
+
|
|
500
|
+
<li><a href="../TaskJuggler/TjTime.html">TaskJuggler::TjTime</a></li>
|
|
501
|
+
|
|
502
|
+
<li><a href="../TaskJuggler/TjpExample.html">TaskJuggler::TjpExample</a></li>
|
|
503
|
+
|
|
504
|
+
<li><a href="../TaskJuggler/TjpExportRE.html">TaskJuggler::TjpExportRE</a></li>
|
|
505
|
+
|
|
506
|
+
<li><a href="../TaskJuggler/TjpSyntaxRules.html">TaskJuggler::TjpSyntaxRules</a></li>
|
|
507
|
+
|
|
508
|
+
<li><a href="../TaskJuggler/UserManual.html">TaskJuggler::UserManual</a></li>
|
|
509
|
+
|
|
510
|
+
<li><a href="../TaskJuggler/WorkingHours.html">TaskJuggler::WorkingHours</a></li>
|
|
511
|
+
|
|
512
|
+
<li><a href="../TaskJuggler/WorkingHoursAttribute.html">TaskJuggler::WorkingHoursAttribute</a></li>
|
|
513
|
+
|
|
514
|
+
<li><a href="../TaskJuggler/XMLBlob.html">TaskJuggler::XMLBlob</a></li>
|
|
515
|
+
|
|
516
|
+
<li><a href="../TaskJuggler/XMLComment.html">TaskJuggler::XMLComment</a></li>
|
|
517
|
+
|
|
518
|
+
<li><a href="../TaskJuggler/XMLDocument.html">TaskJuggler::XMLDocument</a></li>
|
|
519
|
+
|
|
520
|
+
<li><a href="../TaskJuggler/XMLElement.html">TaskJuggler::XMLElement</a></li>
|
|
521
|
+
|
|
522
|
+
<li><a href="../TaskJuggler/XMLNamedText.html">TaskJuggler::XMLNamedText</a></li>
|
|
523
|
+
|
|
524
|
+
<li><a href="../TaskJuggler/XMLText.html">TaskJuggler::XMLText</a></li>
|
|
525
|
+
|
|
526
|
+
<li><a href="../AppConfig.html">AppConfig</a></li>
|
|
527
|
+
|
|
528
|
+
<li><a href="../Arguments.html">Arguments</a></li>
|
|
529
|
+
|
|
530
|
+
<li><a href="../Object.html">Object</a></li>
|
|
531
|
+
|
|
532
|
+
<li><a href="../RuntimeConfig.html">RuntimeConfig</a></li>
|
|
533
|
+
|
|
534
|
+
<li><a href="../String.html">String</a></li>
|
|
535
|
+
|
|
536
|
+
</ul>
|
|
537
|
+
<div id="no-class-search-results" style="display: none;">No matching classes.</div>
|
|
538
|
+
</div>
|
|
539
|
+
|
|
540
|
+
|
|
541
|
+
</div>
|
|
542
|
+
</div>
|
|
543
|
+
|
|
544
|
+
<div id="documentation">
|
|
545
|
+
<h1 class="class">TaskJuggler::KeywordDocumentation</h1>
|
|
546
|
+
|
|
547
|
+
<div id="description">
|
|
548
|
+
<p>
|
|
549
|
+
The textual <a href="../TaskJuggler.html">TaskJuggler</a> <a
|
|
550
|
+
href="Project.html">Project</a> description consists of many keywords. The
|
|
551
|
+
parser has built-in support to document the meaning and usage of these
|
|
552
|
+
keywords. Most keywords are unique, but there can be exceptions. To resolve
|
|
553
|
+
ambiguoties the keywords can be prefixed by a scope. The scope is usually a
|
|
554
|
+
keyword that describes the context that the ambiguous keyword is used in.
|
|
555
|
+
This class stores the keyword, the corresponding <a
|
|
556
|
+
href="TextParser/Pattern.html">TextParser::Pattern</a> and the context that
|
|
557
|
+
the keyword is used in. It also stores information such as the list of
|
|
558
|
+
optional attributes (keywords used in the context of the current keyword)
|
|
559
|
+
and whether the keyword is scenario specific or not.
|
|
560
|
+
</p>
|
|
561
|
+
|
|
562
|
+
</div>
|
|
563
|
+
|
|
564
|
+
<!-- Constants -->
|
|
565
|
+
|
|
566
|
+
|
|
567
|
+
<!-- Attributes -->
|
|
568
|
+
|
|
569
|
+
<div id="attribute-method-details" class="method-section section">
|
|
570
|
+
<h3 class="section-header">Attributes</h3>
|
|
571
|
+
|
|
572
|
+
|
|
573
|
+
<div id="keyword-attribute-method" class="method-detail">
|
|
574
|
+
<a name="keyword"></a>
|
|
575
|
+
|
|
576
|
+
<div class="method-heading attribute-method-heading">
|
|
577
|
+
<span class="method-name">keyword</span><span
|
|
578
|
+
class="attribute-access-type">[R]</span>
|
|
579
|
+
</div>
|
|
580
|
+
|
|
581
|
+
<div class="method-description">
|
|
582
|
+
|
|
583
|
+
|
|
584
|
+
|
|
585
|
+
</div>
|
|
586
|
+
</div>
|
|
587
|
+
|
|
588
|
+
<div id="pattern-attribute-method" class="method-detail">
|
|
589
|
+
<a name="pattern"></a>
|
|
590
|
+
|
|
591
|
+
<div class="method-heading attribute-method-heading">
|
|
592
|
+
<span class="method-name">pattern</span><span
|
|
593
|
+
class="attribute-access-type">[R]</span>
|
|
594
|
+
</div>
|
|
595
|
+
|
|
596
|
+
<div class="method-description">
|
|
597
|
+
|
|
598
|
+
|
|
599
|
+
|
|
600
|
+
</div>
|
|
601
|
+
</div>
|
|
602
|
+
|
|
603
|
+
<div id="references-attribute-method" class="method-detail">
|
|
604
|
+
<a name="references"></a>
|
|
605
|
+
|
|
606
|
+
<div class="method-heading attribute-method-heading">
|
|
607
|
+
<span class="method-name">references</span><span
|
|
608
|
+
class="attribute-access-type">[R]</span>
|
|
609
|
+
</div>
|
|
610
|
+
|
|
611
|
+
<div class="method-description">
|
|
612
|
+
|
|
613
|
+
|
|
614
|
+
|
|
615
|
+
</div>
|
|
616
|
+
</div>
|
|
617
|
+
|
|
618
|
+
<div id="contexts-attribute-method" class="method-detail">
|
|
619
|
+
<a name="contexts"></a>
|
|
620
|
+
|
|
621
|
+
<a name="contexts="></a>
|
|
622
|
+
|
|
623
|
+
<div class="method-heading attribute-method-heading">
|
|
624
|
+
<span class="method-name">contexts</span><span
|
|
625
|
+
class="attribute-access-type">[RW]</span>
|
|
626
|
+
</div>
|
|
627
|
+
|
|
628
|
+
<div class="method-description">
|
|
629
|
+
|
|
630
|
+
|
|
631
|
+
|
|
632
|
+
</div>
|
|
633
|
+
</div>
|
|
634
|
+
|
|
635
|
+
<div id="scenario-pecific-attribute-method" class="method-detail">
|
|
636
|
+
<a name="scenarioSpecific"></a>
|
|
637
|
+
|
|
638
|
+
<a name="scenarioSpecific="></a>
|
|
639
|
+
|
|
640
|
+
<div class="method-heading attribute-method-heading">
|
|
641
|
+
<span class="method-name">scenarioSpecific</span><span
|
|
642
|
+
class="attribute-access-type">[RW]</span>
|
|
643
|
+
</div>
|
|
644
|
+
|
|
645
|
+
<div class="method-description">
|
|
646
|
+
|
|
647
|
+
|
|
648
|
+
|
|
649
|
+
</div>
|
|
650
|
+
</div>
|
|
651
|
+
|
|
652
|
+
<div id="inherited-rom-roject-attribute-method" class="method-detail">
|
|
653
|
+
<a name="inheritedFromProject"></a>
|
|
654
|
+
|
|
655
|
+
<a name="inheritedFromProject="></a>
|
|
656
|
+
|
|
657
|
+
<div class="method-heading attribute-method-heading">
|
|
658
|
+
<span class="method-name">inheritedFromProject</span><span
|
|
659
|
+
class="attribute-access-type">[RW]</span>
|
|
660
|
+
</div>
|
|
661
|
+
|
|
662
|
+
<div class="method-description">
|
|
663
|
+
|
|
664
|
+
|
|
665
|
+
|
|
666
|
+
</div>
|
|
667
|
+
</div>
|
|
668
|
+
|
|
669
|
+
<div id="inherited-rom-arent-attribute-method" class="method-detail">
|
|
670
|
+
<a name="inheritedFromParent"></a>
|
|
671
|
+
|
|
672
|
+
<a name="inheritedFromParent="></a>
|
|
673
|
+
|
|
674
|
+
<div class="method-heading attribute-method-heading">
|
|
675
|
+
<span class="method-name">inheritedFromParent</span><span
|
|
676
|
+
class="attribute-access-type">[RW]</span>
|
|
677
|
+
</div>
|
|
678
|
+
|
|
679
|
+
<div class="method-description">
|
|
680
|
+
|
|
681
|
+
|
|
682
|
+
|
|
683
|
+
</div>
|
|
684
|
+
</div>
|
|
685
|
+
|
|
686
|
+
<div id="predecessor-attribute-method" class="method-detail">
|
|
687
|
+
<a name="predecessor"></a>
|
|
688
|
+
|
|
689
|
+
<a name="predecessor="></a>
|
|
690
|
+
|
|
691
|
+
<div class="method-heading attribute-method-heading">
|
|
692
|
+
<span class="method-name">predecessor</span><span
|
|
693
|
+
class="attribute-access-type">[RW]</span>
|
|
694
|
+
</div>
|
|
695
|
+
|
|
696
|
+
<div class="method-description">
|
|
697
|
+
|
|
698
|
+
|
|
699
|
+
|
|
700
|
+
</div>
|
|
701
|
+
</div>
|
|
702
|
+
|
|
703
|
+
<div id="successor-attribute-method" class="method-detail">
|
|
704
|
+
<a name="successor"></a>
|
|
705
|
+
|
|
706
|
+
<a name="successor="></a>
|
|
707
|
+
|
|
708
|
+
<div class="method-heading attribute-method-heading">
|
|
709
|
+
<span class="method-name">successor</span><span
|
|
710
|
+
class="attribute-access-type">[RW]</span>
|
|
711
|
+
</div>
|
|
712
|
+
|
|
713
|
+
<div class="method-description">
|
|
714
|
+
|
|
715
|
+
|
|
716
|
+
|
|
717
|
+
</div>
|
|
718
|
+
</div>
|
|
719
|
+
|
|
720
|
+
</div>
|
|
721
|
+
|
|
722
|
+
|
|
723
|
+
<!-- Methods -->
|
|
724
|
+
|
|
725
|
+
<div id="public-class-method-details" class="method-section section">
|
|
726
|
+
<h3 class="section-header">Public Class Methods</h3>
|
|
727
|
+
|
|
728
|
+
|
|
729
|
+
<div id="new-method" class="method-detail ">
|
|
730
|
+
<a name="M000999"></a>
|
|
731
|
+
|
|
732
|
+
<div class="method-heading">
|
|
733
|
+
|
|
734
|
+
<span class="method-name">new</span><span
|
|
735
|
+
class="method-args">(rule, pattern, syntax, args, optAttrPatterns, manual)</span>
|
|
736
|
+
<span class="method-click-advice">click to toggle source</span>
|
|
737
|
+
|
|
738
|
+
</div>
|
|
739
|
+
|
|
740
|
+
<div class="method-description">
|
|
741
|
+
|
|
742
|
+
<p>
|
|
743
|
+
Construct a new <a
|
|
744
|
+
href="KeywordDocumentation.html">KeywordDocumentation</a> object.
|
|
745
|
+
<em>rule</em> is the <a href="TextParser/Rule.html">TextParser::Rule</a>
|
|
746
|
+
and <em>pattern</em> is the corresponding <a
|
|
747
|
+
href="TextParser/Pattern.html">TextParser::Pattern</a>. <em>syntax</em> is
|
|
748
|
+
an expanded syntax representation of the <em>pattern</em>. <em>args</em> is
|
|
749
|
+
a Array of ParserTokenDoc that describe the arguments of the
|
|
750
|
+
<em>pattern</em>. <em>optAttrPatterns</em> is an Array with references to
|
|
751
|
+
TextParser::Patterns that are optional attributes to this keyword.
|
|
752
|
+
</p>
|
|
753
|
+
|
|
754
|
+
|
|
755
|
+
|
|
756
|
+
<div class="method-source-code"
|
|
757
|
+
id="new-source">
|
|
758
|
+
<pre>
|
|
759
|
+
<span class="ruby-comment cmt"># File lib/KeywordDocumentation.rb, line 43</span>
|
|
760
|
+
43: <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>)
|
|
761
|
+
44: <span class="ruby-ivar">@rule</span> = <span class="ruby-identifier">rule</span>
|
|
762
|
+
45: <span class="ruby-ivar">@pattern</span> = <span class="ruby-identifier">pattern</span>
|
|
763
|
+
46: <span class="ruby-ivar">@keyword</span> = <span class="ruby-identifier">pattern</span>.<span class="ruby-identifier">keyword</span>
|
|
764
|
+
47: <span class="ruby-ivar">@syntax</span> = <span class="ruby-identifier">syntax</span>
|
|
765
|
+
48: <span class="ruby-ivar">@args</span> = <span class="ruby-identifier">args</span>
|
|
766
|
+
49: <span class="ruby-comment cmt"># Hash that maps patterns of optional attributes to a boolean value. It</span>
|
|
767
|
+
50: <span class="ruby-comment cmt"># is true if the pattern is a scenario specific attribute.</span>
|
|
768
|
+
51: <span class="ruby-ivar">@optAttrPatterns</span> = <span class="ruby-identifier">optAttrPatterns</span>
|
|
769
|
+
52: <span class="ruby-ivar">@manual</span> = <span class="ruby-identifier">manual</span>
|
|
770
|
+
53: <span class="ruby-comment cmt"># The above hash is later converted into a list that points to the</span>
|
|
771
|
+
54: <span class="ruby-comment cmt"># keyword documentation of the optional attribute.</span>
|
|
772
|
+
55: <span class="ruby-ivar">@optionalAttributes</span> = []
|
|
773
|
+
56: <span class="ruby-ivar">@scenarioSpecific</span> = <span class="ruby-keyword kw">false</span>
|
|
774
|
+
57: <span class="ruby-ivar">@inheritedFromProject</span>= <span class="ruby-keyword kw">false</span>
|
|
775
|
+
58: <span class="ruby-ivar">@inheritedFromParent</span> = <span class="ruby-keyword kw">false</span>
|
|
776
|
+
59: <span class="ruby-ivar">@contexts</span> = []
|
|
777
|
+
60: <span class="ruby-ivar">@seeAlso</span> = []
|
|
778
|
+
61: <span class="ruby-comment cmt"># The following are references to the neighboring keyword in an</span>
|
|
779
|
+
62: <span class="ruby-comment cmt"># alphabetically sorted list.</span>
|
|
780
|
+
63: <span class="ruby-ivar">@predecessor</span> = <span class="ruby-keyword kw">nil</span>
|
|
781
|
+
64: <span class="ruby-ivar">@successor</span> = <span class="ruby-keyword kw">nil</span>
|
|
782
|
+
65: <span class="ruby-comment cmt"># Array to collect all references to other RichText objects.</span>
|
|
783
|
+
66: <span class="ruby-ivar">@references</span> = []
|
|
784
|
+
67: <span class="ruby-keyword kw">end</span></pre>
|
|
785
|
+
</div>
|
|
786
|
+
|
|
787
|
+
</div>
|
|
788
|
+
|
|
789
|
+
|
|
790
|
+
|
|
791
|
+
|
|
792
|
+
</div>
|
|
793
|
+
|
|
794
|
+
|
|
795
|
+
</div>
|
|
796
|
+
|
|
797
|
+
<div id="public-instance-method-details" class="method-section section">
|
|
798
|
+
<h3 class="section-header">Public Instance Methods</h3>
|
|
799
|
+
|
|
800
|
+
|
|
801
|
+
<div id="compute-nheritance-method" class="method-detail ">
|
|
802
|
+
<a name="M001001"></a>
|
|
803
|
+
|
|
804
|
+
<div class="method-heading">
|
|
805
|
+
|
|
806
|
+
<span class="method-name">computeInheritance</span><span
|
|
807
|
+
class="method-args">(keywords, rules)</span>
|
|
808
|
+
<span class="method-click-advice">click to toggle source</span>
|
|
809
|
+
|
|
810
|
+
</div>
|
|
811
|
+
|
|
812
|
+
<div class="method-description">
|
|
813
|
+
|
|
814
|
+
|
|
815
|
+
|
|
816
|
+
|
|
817
|
+
|
|
818
|
+
<div class="method-source-code"
|
|
819
|
+
id="compute-nheritance-source">
|
|
820
|
+
<pre>
|
|
821
|
+
<span class="ruby-comment cmt"># File lib/KeywordDocumentation.rb, line 106</span>
|
|
822
|
+
106: <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>)
|
|
823
|
+
107: <span class="ruby-identifier">property</span> = <span class="ruby-keyword kw">nil</span>
|
|
824
|
+
108: <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>
|
|
825
|
+
109: <span class="ruby-keyword kw">if</span> <span class="ruby-node">%( task resource account report shift scenario)</span>.<span class="ruby-identifier">include?</span>(<span class="ruby-identifier">kwd</span>.<span class="ruby-identifier">keyword</span>)
|
|
826
|
+
110: <span class="ruby-identifier">property</span> = <span class="ruby-identifier">kwd</span>.<span class="ruby-identifier">keyword</span>
|
|
827
|
+
111: <span class="ruby-keyword kw">break</span>
|
|
828
|
+
112: <span class="ruby-keyword kw">end</span>
|
|
829
|
+
113: <span class="ruby-keyword kw">end</span>
|
|
830
|
+
114: <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">property</span>
|
|
831
|
+
115: <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>)
|
|
832
|
+
116: <span class="ruby-identifier">propertySet</span> = <span class="ruby-keyword kw">case</span> <span class="ruby-identifier">property</span>
|
|
833
|
+
117: <span class="ruby-keyword kw">when</span> <span class="ruby-value str">'task'</span>
|
|
834
|
+
118: <span class="ruby-identifier">project</span>.<span class="ruby-identifier">tasks</span>
|
|
835
|
+
119: <span class="ruby-keyword kw">when</span> <span class="ruby-value str">'resource'</span>
|
|
836
|
+
120: <span class="ruby-identifier">project</span>.<span class="ruby-identifier">resources</span>
|
|
837
|
+
121: <span class="ruby-keyword kw">when</span> <span class="ruby-value str">'account'</span>
|
|
838
|
+
122: <span class="ruby-identifier">project</span>.<span class="ruby-identifier">accounts</span>
|
|
839
|
+
123: <span class="ruby-keyword kw">when</span> <span class="ruby-value str">'report'</span>
|
|
840
|
+
124: <span class="ruby-identifier">project</span>.<span class="ruby-identifier">reports</span>
|
|
841
|
+
125: <span class="ruby-keyword kw">when</span> <span class="ruby-value str">'shift'</span>
|
|
842
|
+
126: <span class="ruby-identifier">project</span>.<span class="ruby-identifier">shifts</span>
|
|
843
|
+
127: <span class="ruby-keyword kw">when</span> <span class="ruby-value str">'scenario'</span>
|
|
844
|
+
128: <span class="ruby-identifier">project</span>.<span class="ruby-identifier">scenarios</span>
|
|
845
|
+
129: <span class="ruby-keyword kw">end</span>
|
|
846
|
+
130: <span class="ruby-identifier">keyword</span> = <span class="ruby-ivar">@keyword</span>
|
|
847
|
+
131: <span class="ruby-identifier">keyword</span> = <span class="ruby-identifier">keyword</span>.<span class="ruby-identifier">split</span>(<span class="ruby-value str">'.'</span>)[<span class="ruby-value">0</span>] <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">keyword</span>.<span class="ruby-identifier">include?</span>(<span class="ruby-value str">'.'</span>)
|
|
848
|
+
132: <span class="ruby-ivar">@inheritedFromProject</span> = <span class="ruby-identifier">propertySet</span>.<span class="ruby-identifier">inheritedFromProject?</span>(<span class="ruby-identifier">keyword</span>)
|
|
849
|
+
133: <span class="ruby-ivar">@inheritedFromParent</span> = <span class="ruby-identifier">propertySet</span>.<span class="ruby-identifier">inheritedFromParent?</span>(<span class="ruby-identifier">keyword</span>)
|
|
850
|
+
134: <span class="ruby-keyword kw">end</span>
|
|
851
|
+
135: <span class="ruby-keyword kw">end</span></pre>
|
|
852
|
+
</div>
|
|
853
|
+
|
|
854
|
+
</div>
|
|
855
|
+
|
|
856
|
+
|
|
857
|
+
|
|
858
|
+
|
|
859
|
+
</div>
|
|
860
|
+
|
|
861
|
+
|
|
862
|
+
<div id="cross-eference-method" class="method-detail ">
|
|
863
|
+
<a name="M001000"></a>
|
|
864
|
+
|
|
865
|
+
<div class="method-heading">
|
|
866
|
+
|
|
867
|
+
<span class="method-name">crossReference</span><span
|
|
868
|
+
class="method-args">(keywords, rules)</span>
|
|
869
|
+
<span class="method-click-advice">click to toggle source</span>
|
|
870
|
+
|
|
871
|
+
</div>
|
|
872
|
+
|
|
873
|
+
<div class="method-description">
|
|
874
|
+
|
|
875
|
+
<p>
|
|
876
|
+
Post process the class member to set cross references to other <a
|
|
877
|
+
href="KeywordDocumentation.html">KeywordDocumentation</a> items.
|
|
878
|
+
</p>
|
|
879
|
+
|
|
880
|
+
|
|
881
|
+
|
|
882
|
+
<div class="method-source-code"
|
|
883
|
+
id="cross-eference-source">
|
|
884
|
+
<pre>
|
|
885
|
+
<span class="ruby-comment cmt"># File lib/KeywordDocumentation.rb, line 71</span>
|
|
886
|
+
71: <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>)
|
|
887
|
+
72: <span class="ruby-comment cmt"># Some arguments are references to other patterns. The current keyword</span>
|
|
888
|
+
73: <span class="ruby-comment cmt"># is added as context to such patterns.</span>
|
|
889
|
+
74: <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>
|
|
890
|
+
75: <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>)
|
|
891
|
+
76: <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>]
|
|
892
|
+
77: <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>)
|
|
893
|
+
78: <span class="ruby-keyword kw">end</span>
|
|
894
|
+
79: <span class="ruby-keyword kw">end</span>
|
|
895
|
+
80:
|
|
896
|
+
81: <span class="ruby-comment cmt"># Optional attributes are treated similarly. In addition we add them to</span>
|
|
897
|
+
82: <span class="ruby-comment cmt"># the @optionalAttributes list of this keyword.</span>
|
|
898
|
+
83: <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>
|
|
899
|
+
84: <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>)
|
|
900
|
+
85:
|
|
901
|
+
86: <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>
|
|
902
|
+
87: <span class="ruby-identifier">token</span> = <span class="ruby-identifier">pattern</span>.<span class="ruby-identifier">terminalToken</span>(<span class="ruby-identifier">rules</span>)
|
|
903
|
+
88: <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>
|
|
904
|
+
89: <span class="ruby-node">"attribute #{token[0]}"</span>
|
|
905
|
+
90: <span class="ruby-keyword kw">else</span>
|
|
906
|
+
91: <span class="ruby-ivar">@optionalAttributes</span> <span class="ruby-operator"><<</span> <span class="ruby-identifier">kwd</span>
|
|
907
|
+
92: <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>)
|
|
908
|
+
93: <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>
|
|
909
|
+
94: <span class="ruby-keyword kw">end</span>
|
|
910
|
+
95: <span class="ruby-keyword kw">end</span>
|
|
911
|
+
96:
|
|
912
|
+
97: <span class="ruby-comment cmt"># Resolve the seeAlso patterns to keyword references.</span>
|
|
913
|
+
98: <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>
|
|
914
|
+
99: <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>
|
|
915
|
+
100: <span class="ruby-identifier">raise</span> <span class="ruby-node">"See also reference #{also} of #{@pattern} is unknown"</span>
|
|
916
|
+
101: <span class="ruby-keyword kw">end</span>
|
|
917
|
+
102: <span class="ruby-ivar">@seeAlso</span> <span class="ruby-operator"><<</span> <span class="ruby-identifier">keywords</span>[<span class="ruby-identifier">also</span>]
|
|
918
|
+
103: <span class="ruby-keyword kw">end</span>
|
|
919
|
+
104: <span class="ruby-keyword kw">end</span></pre>
|
|
920
|
+
</div>
|
|
921
|
+
|
|
922
|
+
</div>
|
|
923
|
+
|
|
924
|
+
|
|
925
|
+
|
|
926
|
+
|
|
927
|
+
</div>
|
|
928
|
+
|
|
929
|
+
|
|
930
|
+
<div id="generate--method" class="method-detail ">
|
|
931
|
+
<a name="M001004"></a>
|
|
932
|
+
|
|
933
|
+
<div class="method-heading">
|
|
934
|
+
|
|
935
|
+
<span class="method-name">generateHTML</span><span
|
|
936
|
+
class="method-args">(directory)</span>
|
|
937
|
+
<span class="method-click-advice">click to toggle source</span>
|
|
938
|
+
|
|
939
|
+
</div>
|
|
940
|
+
|
|
941
|
+
<div class="method-description">
|
|
942
|
+
|
|
943
|
+
<p>
|
|
944
|
+
Return a <a href="../String.html">String</a> that represents the keyword
|
|
945
|
+
documentation in an XML formatted form.
|
|
946
|
+
</p>
|
|
947
|
+
|
|
948
|
+
|
|
949
|
+
|
|
950
|
+
<div class="method-source-code"
|
|
951
|
+
id="generate--source">
|
|
952
|
+
<pre>
|
|
953
|
+
<span class="ruby-comment cmt"># File lib/KeywordDocumentation.rb, line 269</span>
|
|
954
|
+
269: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">generateHTML</span>(<span class="ruby-identifier">directory</span>)
|
|
955
|
+
270: <span class="ruby-identifier">html</span> = <span class="ruby-constant">HTMLDocument</span>.<span class="ruby-identifier">new</span>(<span class="ruby-value">:strict</span>)
|
|
956
|
+
271: <span class="ruby-identifier">head</span> = <span class="ruby-identifier">html</span>.<span class="ruby-identifier">generateHead</span>(<span class="ruby-identifier">keyword</span>,
|
|
957
|
+
272: { <span class="ruby-value str">'description'</span> =<span class="ruby-operator">></span> <span class="ruby-value str">'The TaskJuggler Manual'</span>,
|
|
958
|
+
273: <span class="ruby-value str">'keywords'</span> =<span class="ruby-operator">></span>
|
|
959
|
+
274: <span class="ruby-value str">'taskjuggler, project, management'</span> })
|
|
960
|
+
275: <span class="ruby-identifier">head</span> <span class="ruby-operator"><<</span> <span class="ruby-ivar">@manual</span>.<span class="ruby-identifier">generateStyleSheet</span>
|
|
961
|
+
276:
|
|
962
|
+
277: <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>))
|
|
963
|
+
278: <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>
|
|
964
|
+
279: <span class="ruby-identifier">generateHTMLNavigationBar</span>
|
|
965
|
+
280:
|
|
966
|
+
281: <span class="ruby-comment cmt"># Box with keyword name.</span>
|
|
967
|
+
282: <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>,
|
|
968
|
+
283: <span class="ruby-value str">'style'</span> =<span class="ruby-operator">></span> <span class="ruby-value str">'margin-left:5%; margin-right:5%'</span>))
|
|
969
|
+
284: <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>))
|
|
970
|
+
285: <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>,
|
|
971
|
+
286: <span class="ruby-value str">'class'</span> =<span class="ruby-operator">></span> <span class="ruby-value str">'table'</span>))
|
|
972
|
+
287:
|
|
973
|
+
288: <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>))
|
|
974
|
+
289: <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>,
|
|
975
|
+
290: <span class="ruby-value str">'style'</span> =<span class="ruby-operator">></span> <span class="ruby-value str">'width:15%'</span>)
|
|
976
|
+
291: <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>,
|
|
977
|
+
292: <span class="ruby-value str">'style'</span> =<span class="ruby-operator">></span> <span class="ruby-value str">'width:85%; font-weight:bold'</span>)
|
|
978
|
+
293:
|
|
979
|
+
294: <span class="ruby-comment cmt"># Box with purpose, syntax, arguments and context.</span>
|
|
980
|
+
295: <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>))
|
|
981
|
+
296: <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>,
|
|
982
|
+
297: <span class="ruby-value str">'class'</span> =<span class="ruby-operator">></span> <span class="ruby-value str">'table'</span>))
|
|
983
|
+
298: <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>))
|
|
984
|
+
299: <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>)
|
|
985
|
+
300: <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>)
|
|
986
|
+
301:
|
|
987
|
+
302: <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>))
|
|
988
|
+
303: <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>)
|
|
989
|
+
304: <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>))
|
|
990
|
+
305: <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>
|
|
991
|
+
306: <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>
|
|
992
|
+
307: <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>))
|
|
993
|
+
308: <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>)
|
|
994
|
+
309: <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>))
|
|
995
|
+
310: <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>)
|
|
996
|
+
311:
|
|
997
|
+
312: <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>))
|
|
998
|
+
313: <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>)
|
|
999
|
+
314: <span class="ruby-keyword kw">if</span> <span class="ruby-ivar">@args</span>.<span class="ruby-identifier">empty?</span>
|
|
1000
|
+
315: <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>)
|
|
1001
|
+
316: <span class="ruby-keyword kw">else</span>
|
|
1002
|
+
317: <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>))
|
|
1003
|
+
318: <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>))
|
|
1004
|
+
319: <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>
|
|
1005
|
+
320: <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>))
|
|
1006
|
+
321: <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>
|
|
1007
|
+
322: <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>)
|
|
1008
|
+
323: <span class="ruby-keyword kw">else</span>
|
|
1009
|
+
324: <span class="ruby-identifier">typeSpec</span> = <span class="ruby-identifier">arg</span>.<span class="ruby-identifier">typeSpec</span>
|
|
1010
|
+
325: <span class="ruby-identifier">typeName</span> = <span class="ruby-identifier">typeSpec</span>[<span class="ruby-value">1</span><span class="ruby-operator">..</span><span class="ruby-value">2</span>]
|
|
1011
|
+
326: <span class="ruby-identifier">typeSpec</span>[<span class="ruby-value">0</span>] = <span class="ruby-value str">'['</span>
|
|
1012
|
+
327: <span class="ruby-identifier">typeSpec</span>[<span class="ruby-value">1</span>] = <span class="ruby-value str">']'</span>
|
|
1013
|
+
328: <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>, <span class="ruby-value str">'width'</span> =<span class="ruby-operator">></span> <span class="ruby-value str">'30%'</span>))
|
|
1014
|
+
329: <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-node">"#{arg.name} ["</span>)
|
|
1015
|
+
330: <span class="ruby-identifier">td</span> <span class="ruby-operator"><<</span> <span class="ruby-constant">XMLNamedText</span>.<span class="ruby-identifier">new</span>(
|
|
1016
|
+
331: <span class="ruby-identifier">typeName</span>, <span class="ruby-value str">'a'</span>, <span class="ruby-value str">'href'</span> =<span class="ruby-operator">></span>
|
|
1017
|
+
332: <span class="ruby-node">"The_TaskJuggler_Syntax.html\##{typeName}"</span>)
|
|
1018
|
+
333: <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>)
|
|
1019
|
+
334: <span class="ruby-keyword kw">end</span>
|
|
1020
|
+
335: <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>,
|
|
1021
|
+
336: <span class="ruby-value str">'style'</span> =<span class="ruby-operator">></span> <span class="ruby-value str">'margin-top:2px; margin-bottom:2px;'</span>))
|
|
1022
|
+
337: <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>
|
|
1023
|
+
338: <span class="ruby-node">"See [[#{arg.name}]] for details."</span>).<span class="ruby-identifier">to_html</span>
|
|
1024
|
+
339: <span class="ruby-keyword kw">end</span>
|
|
1025
|
+
340: <span class="ruby-keyword kw">end</span>
|
|
1026
|
+
341: <span class="ruby-keyword kw">end</span>
|
|
1027
|
+
342:
|
|
1028
|
+
343: <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>))
|
|
1029
|
+
344: <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>)
|
|
1030
|
+
345: <span class="ruby-keyword kw">if</span> <span class="ruby-ivar">@contexts</span>.<span class="ruby-identifier">empty?</span>
|
|
1031
|
+
346: <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>))
|
|
1032
|
+
347: <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>,
|
|
1033
|
+
348: <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>)
|
|
1034
|
+
349: <span class="ruby-keyword kw">else</span>
|
|
1035
|
+
350: <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>))
|
|
1036
|
+
351: <span class="ruby-identifier">first</span> = <span class="ruby-keyword kw">true</span>
|
|
1037
|
+
352: <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>
|
|
1038
|
+
353: <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">first</span>
|
|
1039
|
+
354: <span class="ruby-identifier">first</span> = <span class="ruby-keyword kw">false</span>
|
|
1040
|
+
355: <span class="ruby-keyword kw">else</span>
|
|
1041
|
+
356: <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>)
|
|
1042
|
+
357: <span class="ruby-keyword kw">end</span>
|
|
1043
|
+
358: <span class="ruby-identifier">keywordHTMLRef</span>(<span class="ruby-identifier">td</span>, <span class="ruby-identifier">context</span>)
|
|
1044
|
+
359: <span class="ruby-keyword kw">end</span>
|
|
1045
|
+
360: <span class="ruby-keyword kw">end</span>
|
|
1046
|
+
361:
|
|
1047
|
+
362: <span class="ruby-keyword kw">unless</span> <span class="ruby-ivar">@seeAlso</span>.<span class="ruby-identifier">empty?</span>
|
|
1048
|
+
363: <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>))
|
|
1049
|
+
364: <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>)
|
|
1050
|
+
365: <span class="ruby-identifier">first</span> = <span class="ruby-keyword kw">true</span>
|
|
1051
|
+
366: <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>))
|
|
1052
|
+
367: <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>
|
|
1053
|
+
368: <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">first</span>
|
|
1054
|
+
369: <span class="ruby-identifier">first</span> = <span class="ruby-keyword kw">false</span>
|
|
1055
|
+
370: <span class="ruby-keyword kw">else</span>
|
|
1056
|
+
371: <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>)
|
|
1057
|
+
372: <span class="ruby-keyword kw">end</span>
|
|
1058
|
+
373: <span class="ruby-identifier">keywordHTMLRef</span>(<span class="ruby-identifier">td</span>, <span class="ruby-identifier">also</span>)
|
|
1059
|
+
374: <span class="ruby-keyword kw">end</span>
|
|
1060
|
+
375: <span class="ruby-keyword kw">end</span>
|
|
1061
|
+
376:
|
|
1062
|
+
377: <span class="ruby-comment cmt"># Box with attributes.</span>
|
|
1063
|
+
378: <span class="ruby-keyword kw">unless</span> <span class="ruby-ivar">@optionalAttributes</span>.<span class="ruby-identifier">empty?</span>
|
|
1064
|
+
379: <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>
|
|
1065
|
+
380: <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>
|
|
1066
|
+
381: <span class="ruby-keyword kw">end</span>
|
|
1067
|
+
382:
|
|
1068
|
+
383: <span class="ruby-identifier">showDetails</span> = <span class="ruby-keyword kw">false</span>
|
|
1069
|
+
384: <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>
|
|
1070
|
+
385: <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">attr</span>.<span class="ruby-identifier">scenarioSpecific</span> <span class="ruby-operator">||</span> <span class="ruby-identifier">attr</span>.<span class="ruby-identifier">inheritedFromProject</span> <span class="ruby-operator">||</span>
|
|
1071
|
+
386: <span class="ruby-identifier">attr</span>.<span class="ruby-identifier">inheritedFromParent</span>
|
|
1072
|
+
387: <span class="ruby-identifier">showDetails</span> = <span class="ruby-keyword kw">true</span>
|
|
1073
|
+
388: <span class="ruby-keyword kw">break</span>
|
|
1074
|
+
389: <span class="ruby-keyword kw">end</span>
|
|
1075
|
+
390: <span class="ruby-keyword kw">end</span>
|
|
1076
|
+
391:
|
|
1077
|
+
392: <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>))
|
|
1078
|
+
393: <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>,
|
|
1079
|
+
394: <span class="ruby-value str">'class'</span> =<span class="ruby-operator">></span> <span class="ruby-value str">'table'</span>))
|
|
1080
|
+
395: <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>))
|
|
1081
|
+
396: <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">showDetails</span>
|
|
1082
|
+
397: <span class="ruby-comment cmt"># Table of all attributes with checkmarks for being scenario</span>
|
|
1083
|
+
398: <span class="ruby-comment cmt"># specific, inherited from parent and inherited from global scope.</span>
|
|
1084
|
+
399: <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>,
|
|
1085
|
+
400: <span class="ruby-value str">'rowspan'</span> =<span class="ruby-operator">></span>
|
|
1086
|
+
401: <span class="ruby-node">"#{@optionalAttributes.length + 1}"</span>,
|
|
1087
|
+
402: <span class="ruby-value str">'style'</span> =<span class="ruby-operator">></span> <span class="ruby-value str">'width:15%'</span>)
|
|
1088
|
+
403: <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">'Name'</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>,
|
|
1089
|
+
404: <span class="ruby-value str">'style'</span> =<span class="ruby-operator">></span> <span class="ruby-value str">'width:40%'</span>)
|
|
1090
|
+
405: <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">'Scen. spec.'</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>,
|
|
1091
|
+
406: <span class="ruby-value str">'style'</span> =<span class="ruby-operator">></span> <span class="ruby-value str">'width:15%'</span>)
|
|
1092
|
+
407: <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">'Inh. fm. Global'</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>,
|
|
1093
|
+
408: <span class="ruby-value str">'style'</span> =<span class="ruby-operator">></span> <span class="ruby-value str">'width:15%'</span>)
|
|
1094
|
+
409: <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">'Inh. fm. Parent'</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>,
|
|
1095
|
+
410: <span class="ruby-value str">'style'</span> =<span class="ruby-operator">></span> <span class="ruby-value str">'width:15%'</span>)
|
|
1096
|
+
411: <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>
|
|
1097
|
+
412: <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>))
|
|
1098
|
+
413: <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>))
|
|
1099
|
+
414: <span class="ruby-identifier">keywordHTMLRef</span>(<span class="ruby-identifier">td</span>, <span class="ruby-identifier">attr</span>)
|
|
1100
|
+
415: <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">'align'</span> =<span class="ruby-operator">></span> <span class="ruby-value str">'center'</span>,
|
|
1101
|
+
416: <span class="ruby-value str">'class'</span> =<span class="ruby-operator">></span> <span class="ruby-value str">'descr'</span>))
|
|
1102
|
+
417: <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">'x'</span>) <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">attr</span>.<span class="ruby-identifier">scenarioSpecific</span>
|
|
1103
|
+
418: <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">'align'</span> =<span class="ruby-operator">></span> <span class="ruby-value str">'center'</span>,
|
|
1104
|
+
419: <span class="ruby-value str">'class'</span> =<span class="ruby-operator">></span> <span class="ruby-value str">'descr'</span>))
|
|
1105
|
+
420: <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">'x'</span>) <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">attr</span>.<span class="ruby-identifier">inheritedFromProject</span>
|
|
1106
|
+
421: <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">'align'</span> =<span class="ruby-operator">></span> <span class="ruby-value str">'center'</span>,
|
|
1107
|
+
422: <span class="ruby-value str">'class'</span> =<span class="ruby-operator">></span> <span class="ruby-value str">'descr'</span>))
|
|
1108
|
+
423: <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">'x'</span>) <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">attr</span>.<span class="ruby-identifier">inheritedFromParent</span>
|
|
1109
|
+
424: <span class="ruby-keyword kw">end</span>
|
|
1110
|
+
425: <span class="ruby-keyword kw">else</span>
|
|
1111
|
+
426: <span class="ruby-comment cmt"># Comma separated list of all attributes.</span>
|
|
1112
|
+
427: <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>,
|
|
1113
|
+
428: <span class="ruby-value str">'style'</span> =<span class="ruby-operator">></span> <span class="ruby-value str">'width:15%'</span>)
|
|
1114
|
+
429: <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>,
|
|
1115
|
+
430: <span class="ruby-value str">'style'</span> =<span class="ruby-operator">></span> <span class="ruby-value str">'width:85%'</span>))
|
|
1116
|
+
431: <span class="ruby-identifier">first</span> = <span class="ruby-keyword kw">true</span>
|
|
1117
|
+
432: <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>
|
|
1118
|
+
433: <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">first</span>
|
|
1119
|
+
434: <span class="ruby-identifier">first</span> = <span class="ruby-keyword kw">false</span>
|
|
1120
|
+
435: <span class="ruby-keyword kw">else</span>
|
|
1121
|
+
436: <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>)
|
|
1122
|
+
437: <span class="ruby-keyword kw">end</span>
|
|
1123
|
+
438: <span class="ruby-identifier">keywordHTMLRef</span>(<span class="ruby-identifier">td</span>, <span class="ruby-identifier">attr</span>)
|
|
1124
|
+
439: <span class="ruby-keyword kw">end</span>
|
|
1125
|
+
440: <span class="ruby-keyword kw">end</span>
|
|
1126
|
+
441: <span class="ruby-keyword kw">end</span>
|
|
1127
|
+
442:
|
|
1128
|
+
443: <span class="ruby-keyword kw">if</span> <span class="ruby-ivar">@pattern</span>.<span class="ruby-identifier">exampleFile</span>
|
|
1129
|
+
444: <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>
|
|
1130
|
+
445: <span class="ruby-identifier">example</span> = <span class="ruby-constant">TjpExample</span>.<span class="ruby-identifier">new</span>
|
|
1131
|
+
446: <span class="ruby-identifier">fileName</span> = <span class="ruby-node">"#{exampleDir}/#{@pattern.exampleFile}.tjp"</span>
|
|
1132
|
+
447: <span class="ruby-identifier">example</span>.<span class="ruby-identifier">open</span>(<span class="ruby-identifier">fileName</span>)
|
|
1133
|
+
448: <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>))
|
|
1134
|
+
449: <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>))
|
|
1135
|
+
450: <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>))
|
|
1136
|
+
451: <span class="ruby-identifier">raise</span> <span class="ruby-node">"There is no tag '#{@pattern.exampleTag}' in file "</span> <span class="ruby-operator">+</span>
|
|
1137
|
+
452: <span class="ruby-node">"#{fileName}."</span>
|
|
1138
|
+
453: <span class="ruby-keyword kw">end</span>
|
|
1139
|
+
454: <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>)
|
|
1140
|
+
455: <span class="ruby-keyword kw">end</span>
|
|
1141
|
+
456:
|
|
1142
|
+
457: <span class="ruby-identifier">body</span> <span class="ruby-operator"><<</span> <span class="ruby-identifier">generateHTMLNavigationBar</span>
|
|
1143
|
+
458: <span class="ruby-identifier">body</span> <span class="ruby-operator"><<</span> <span class="ruby-ivar">@manual</span>.<span class="ruby-identifier">generateHTMLFooter</span>
|
|
1144
|
+
459:
|
|
1145
|
+
460: <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">directory</span>
|
|
1146
|
+
461: <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>)
|
|
1147
|
+
462: <span class="ruby-keyword kw">else</span>
|
|
1148
|
+
463: <span class="ruby-identifier">puts</span> <span class="ruby-identifier">html</span>.<span class="ruby-identifier">to_s</span>
|
|
1149
|
+
464: <span class="ruby-keyword kw">end</span>
|
|
1150
|
+
465: <span class="ruby-keyword kw">end</span></pre>
|
|
1151
|
+
</div>
|
|
1152
|
+
|
|
1153
|
+
</div>
|
|
1154
|
+
|
|
1155
|
+
|
|
1156
|
+
|
|
1157
|
+
|
|
1158
|
+
</div>
|
|
1159
|
+
|
|
1160
|
+
|
|
1161
|
+
<div id="title-method" class="method-detail ">
|
|
1162
|
+
<a name="M001002"></a>
|
|
1163
|
+
|
|
1164
|
+
<div class="method-heading">
|
|
1165
|
+
|
|
1166
|
+
<span class="method-name">title</span><span
|
|
1167
|
+
class="method-args">()</span>
|
|
1168
|
+
<span class="method-click-advice">click to toggle source</span>
|
|
1169
|
+
|
|
1170
|
+
</div>
|
|
1171
|
+
|
|
1172
|
+
<div class="method-description">
|
|
1173
|
+
|
|
1174
|
+
<p>
|
|
1175
|
+
Return the keyword name in a more readable form. E.g. ‘foo.bar’
|
|
1176
|
+
is returned as ‘foo (bar)’. ‘foo’ will remain
|
|
1177
|
+
‘foo’.
|
|
1178
|
+
</p>
|
|
1179
|
+
|
|
1180
|
+
|
|
1181
|
+
|
|
1182
|
+
<div class="method-source-code"
|
|
1183
|
+
id="title-source">
|
|
1184
|
+
<pre>
|
|
1185
|
+
<span class="ruby-comment cmt"># File lib/KeywordDocumentation.rb, line 139</span>
|
|
1186
|
+
139: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">title</span>
|
|
1187
|
+
140: <span class="ruby-identifier">kwTokens</span> = <span class="ruby-ivar">@keyword</span>.<span class="ruby-identifier">split</span>(<span class="ruby-value str">'.'</span>)
|
|
1188
|
+
141: <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>
|
|
1189
|
+
142: <span class="ruby-identifier">title</span> = <span class="ruby-ivar">@keyword</span>
|
|
1190
|
+
143: <span class="ruby-keyword kw">else</span>
|
|
1191
|
+
144: <span class="ruby-identifier">title</span> = <span class="ruby-node">"#{kwTokens[0]} (#{kwTokens[1]})"</span>
|
|
1192
|
+
145: <span class="ruby-keyword kw">end</span>
|
|
1193
|
+
146: <span class="ruby-identifier">title</span>
|
|
1194
|
+
147: <span class="ruby-keyword kw">end</span></pre>
|
|
1195
|
+
</div>
|
|
1196
|
+
|
|
1197
|
+
</div>
|
|
1198
|
+
|
|
1199
|
+
|
|
1200
|
+
|
|
1201
|
+
|
|
1202
|
+
</div>
|
|
1203
|
+
|
|
1204
|
+
|
|
1205
|
+
<div id="to-s-method" class="method-detail ">
|
|
1206
|
+
<a name="M001003"></a>
|
|
1207
|
+
|
|
1208
|
+
<div class="method-heading">
|
|
1209
|
+
|
|
1210
|
+
<span class="method-name">to_s</span><span
|
|
1211
|
+
class="method-args">()</span>
|
|
1212
|
+
<span class="method-click-advice">click to toggle source</span>
|
|
1213
|
+
|
|
1214
|
+
</div>
|
|
1215
|
+
|
|
1216
|
+
<div class="method-description">
|
|
1217
|
+
|
|
1218
|
+
<p>
|
|
1219
|
+
Return the complete documentation of this keyword as formatted text string.
|
|
1220
|
+
</p>
|
|
1221
|
+
|
|
1222
|
+
|
|
1223
|
+
|
|
1224
|
+
<div class="method-source-code"
|
|
1225
|
+
id="to-s-source">
|
|
1226
|
+
<pre>
|
|
1227
|
+
<span class="ruby-comment cmt"># File lib/KeywordDocumentation.rb, line 151</span>
|
|
1228
|
+
151: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">to_s</span>
|
|
1229
|
+
152: <span class="ruby-identifier">tagW</span> = <span class="ruby-value">13</span>
|
|
1230
|
+
153: <span class="ruby-identifier">textW</span> = <span class="ruby-value">79</span>
|
|
1231
|
+
154:
|
|
1232
|
+
155: <span class="ruby-comment cmt"># Top line with multiple elements</span>
|
|
1233
|
+
156: <span class="ruby-identifier">str</span> = <span class="ruby-node">"Keyword: #{@keyword} "</span> <span class="ruby-operator">+</span>
|
|
1234
|
+
157: <span class="ruby-node">"Scenario Specific: #{@scenarioSpecific ? 'Yes' : 'No'} "</span> <span class="ruby-operator">+</span>
|
|
1235
|
+
158: <span class="ruby-node">"Inherited: #{@inheritedFromParent ? 'Yes' : 'No'}\n\n"</span>
|
|
1236
|
+
159:
|
|
1237
|
+
160: <span class="ruby-identifier">str</span> <span class="ruby-operator">+=</span> <span class="ruby-node">"Purpose: #{format(tagW, newRichText(@pattern.doc).to_s,
|
|
1238
|
+
161: textW)}\n\n"</span>
|
|
1239
|
+
162:
|
|
1240
|
+
163: <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>
|
|
1241
|
+
164: <span class="ruby-identifier">str</span> <span class="ruby-operator">+=</span> <span class="ruby-node">"Syntax: #{format(tagW, @syntax, textW)}\n\n"</span>
|
|
1242
|
+
165:
|
|
1243
|
+
166: <span class="ruby-identifier">str</span> <span class="ruby-operator">+=</span> <span class="ruby-value str">"Arguments: "</span>
|
|
1244
|
+
167: <span class="ruby-keyword kw">if</span> <span class="ruby-ivar">@args</span>.<span class="ruby-identifier">empty?</span>
|
|
1245
|
+
168: <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>)
|
|
1246
|
+
169: <span class="ruby-keyword kw">else</span>
|
|
1247
|
+
170: <span class="ruby-identifier">argStr</span> = <span class="ruby-value str">''</span>
|
|
1248
|
+
171: <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>
|
|
1249
|
+
172: <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>
|
|
1250
|
+
173: <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>
|
|
1251
|
+
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-value">2</span>
|
|
1252
|
+
175: <span class="ruby-identifier">argStr</span> <span class="ruby-operator">+=</span> <span class="ruby-node">"#{arg.name}: "</span> <span class="ruby-operator">+</span>
|
|
1253
|
+
176: <span class="ruby-node">"#{format(indent, argText, textW - tagW)}\n"</span>
|
|
1254
|
+
177: <span class="ruby-keyword kw">else</span>
|
|
1255
|
+
178: <span class="ruby-identifier">typeSpec</span> = <span class="ruby-identifier">arg</span>.<span class="ruby-identifier">typeSpec</span>
|
|
1256
|
+
179: <span class="ruby-identifier">typeSpec</span>[<span class="ruby-value">0</span>] = <span class="ruby-value str">'['</span>
|
|
1257
|
+
180: <span class="ruby-identifier">typeSpec</span>[<span class="ruby-value">1</span>] = <span class="ruby-value str">']'</span>
|
|
1258
|
+
181: <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>
|
|
1259
|
+
182: <span class="ruby-identifier">argStr</span> <span class="ruby-operator">+=</span> <span class="ruby-node">"#{arg.name} #{typeSpec}: "</span> <span class="ruby-operator">+</span>
|
|
1260
|
+
183: <span class="ruby-node">"#{format(indent, argText, textW - tagW)}\n"</span>
|
|
1261
|
+
184: <span class="ruby-keyword kw">end</span>
|
|
1262
|
+
185: <span class="ruby-keyword kw">end</span>
|
|
1263
|
+
186: <span class="ruby-identifier">str</span> <span class="ruby-operator">+=</span> <span class="ruby-identifier">indent</span>(<span class="ruby-identifier">tagW</span>, <span class="ruby-identifier">argStr</span>)
|
|
1264
|
+
187: <span class="ruby-keyword kw">end</span>
|
|
1265
|
+
188: <span class="ruby-identifier">str</span> <span class="ruby-operator">+=</span> <span class="ruby-value str">"\n"</span>
|
|
1266
|
+
189: <span class="ruby-keyword kw">end</span>
|
|
1267
|
+
190:
|
|
1268
|
+
191: <span class="ruby-identifier">str</span> <span class="ruby-operator">+=</span> <span class="ruby-value str">'Context: '</span>
|
|
1269
|
+
192: <span class="ruby-keyword kw">if</span> <span class="ruby-ivar">@contexts</span>.<span class="ruby-identifier">empty?</span>
|
|
1270
|
+
193: <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>)
|
|
1271
|
+
194: <span class="ruby-keyword kw">else</span>
|
|
1272
|
+
195: <span class="ruby-identifier">cxtStr</span> = <span class="ruby-value str">''</span>
|
|
1273
|
+
196: <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>
|
|
1274
|
+
197: <span class="ruby-keyword kw">unless</span> <span class="ruby-identifier">cxtStr</span>.<span class="ruby-identifier">empty?</span>
|
|
1275
|
+
198: <span class="ruby-identifier">cxtStr</span> <span class="ruby-operator">+=</span> <span class="ruby-value str">', '</span>
|
|
1276
|
+
199: <span class="ruby-keyword kw">end</span>
|
|
1277
|
+
200: <span class="ruby-identifier">cxtStr</span> <span class="ruby-operator">+=</span> <span class="ruby-identifier">context</span>.<span class="ruby-identifier">keyword</span>
|
|
1278
|
+
201: <span class="ruby-keyword kw">end</span>
|
|
1279
|
+
202: <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>)
|
|
1280
|
+
203: <span class="ruby-keyword kw">end</span>
|
|
1281
|
+
204:
|
|
1282
|
+
205: <span class="ruby-identifier">str</span> <span class="ruby-operator">+=</span> <span class="ruby-value str">"\n\nAttributes: "</span>
|
|
1283
|
+
206: <span class="ruby-keyword kw">if</span> <span class="ruby-ivar">@optionalAttributes</span>.<span class="ruby-identifier">empty?</span>
|
|
1284
|
+
207: <span class="ruby-identifier">str</span> <span class="ruby-operator">+=</span> <span class="ruby-value str">"none\n\n"</span>
|
|
1285
|
+
208: <span class="ruby-keyword kw">else</span>
|
|
1286
|
+
209: <span class="ruby-identifier">attrStr</span> = <span class="ruby-value str">''</span>
|
|
1287
|
+
210: <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>
|
|
1288
|
+
211: <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>
|
|
1289
|
+
212: <span class="ruby-keyword kw">end</span>
|
|
1290
|
+
213: <span class="ruby-identifier">showLegend</span> = <span class="ruby-keyword kw">false</span>
|
|
1291
|
+
214: <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>
|
|
1292
|
+
215: <span class="ruby-keyword kw">unless</span> <span class="ruby-identifier">attrStr</span>.<span class="ruby-identifier">empty?</span>
|
|
1293
|
+
216: <span class="ruby-identifier">attrStr</span> <span class="ruby-operator">+=</span> <span class="ruby-value str">', '</span>
|
|
1294
|
+
217: <span class="ruby-keyword kw">end</span>
|
|
1295
|
+
218: <span class="ruby-identifier">attrStr</span> <span class="ruby-operator">+=</span> <span class="ruby-identifier">attr</span>.<span class="ruby-identifier">keyword</span>
|
|
1296
|
+
219: <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">attr</span>.<span class="ruby-identifier">scenarioSpecific</span> <span class="ruby-operator">||</span> <span class="ruby-identifier">attr</span>.<span class="ruby-identifier">inheritedFromProject</span> <span class="ruby-operator">||</span>
|
|
1297
|
+
220: <span class="ruby-identifier">attr</span>.<span class="ruby-identifier">inheritedFromParent</span>
|
|
1298
|
+
221: <span class="ruby-identifier">first</span> = <span class="ruby-keyword kw">true</span>
|
|
1299
|
+
222: <span class="ruby-identifier">showLegend</span> = <span class="ruby-keyword kw">true</span>
|
|
1300
|
+
223: <span class="ruby-identifier">attrStr</span> <span class="ruby-operator">+=</span> <span class="ruby-value str">'['</span>
|
|
1301
|
+
224: <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">attr</span>.<span class="ruby-identifier">scenarioSpecific</span>
|
|
1302
|
+
225: <span class="ruby-identifier">attrStr</span> <span class="ruby-operator">+=</span> <span class="ruby-value str">'sc'</span>
|
|
1303
|
+
226: <span class="ruby-identifier">first</span> = <span class="ruby-keyword kw">false</span>
|
|
1304
|
+
227: <span class="ruby-keyword kw">end</span>
|
|
1305
|
+
228: <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">attr</span>.<span class="ruby-identifier">inheritedFromProject</span>
|
|
1306
|
+
229: <span class="ruby-identifier">attrStr</span> <span class="ruby-operator">+=</span> <span class="ruby-value str">':'</span> <span class="ruby-keyword kw">unless</span> <span class="ruby-identifier">first</span>
|
|
1307
|
+
230: <span class="ruby-identifier">attrStr</span> <span class="ruby-operator">+=</span> <span class="ruby-value str">'ig'</span>
|
|
1308
|
+
231: <span class="ruby-identifier">first</span> = <span class="ruby-keyword kw">false</span>
|
|
1309
|
+
232: <span class="ruby-keyword kw">end</span>
|
|
1310
|
+
233: <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">attr</span>.<span class="ruby-identifier">inheritedFromParent</span>
|
|
1311
|
+
234: <span class="ruby-identifier">attrStr</span> <span class="ruby-operator">+=</span> <span class="ruby-value str">':'</span> <span class="ruby-keyword kw">unless</span> <span class="ruby-identifier">first</span>
|
|
1312
|
+
235: <span class="ruby-identifier">attrStr</span> <span class="ruby-operator">+=</span> <span class="ruby-value str">'ip'</span>
|
|
1313
|
+
236: <span class="ruby-keyword kw">end</span>
|
|
1314
|
+
237: <span class="ruby-identifier">attrStr</span> <span class="ruby-operator">+=</span> <span class="ruby-value str">']'</span>
|
|
1315
|
+
238: <span class="ruby-keyword kw">end</span>
|
|
1316
|
+
239: <span class="ruby-keyword kw">end</span>
|
|
1317
|
+
240: <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">showLegend</span>
|
|
1318
|
+
241: <span class="ruby-identifier">attrStr</span> <span class="ruby-operator">+=</span> <span class="ruby-value str">"\n\n[sc] : Attribute is scenario specific"</span> <span class="ruby-operator">+</span>
|
|
1319
|
+
242: <span class="ruby-value str">"\n[ig] : Attribute is inherited from global attribute"</span> <span class="ruby-operator">+</span>
|
|
1320
|
+
243: <span class="ruby-value str">"\n[ip] : Attribute is inherited from parent property"</span>
|
|
1321
|
+
244: <span class="ruby-keyword kw">end</span>
|
|
1322
|
+
245: <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>)
|
|
1323
|
+
246: <span class="ruby-identifier">str</span> <span class="ruby-operator">+=</span> <span class="ruby-value str">"\n"</span>
|
|
1324
|
+
247: <span class="ruby-keyword kw">end</span>
|
|
1325
|
+
248:
|
|
1326
|
+
249: <span class="ruby-keyword kw">unless</span> <span class="ruby-ivar">@seeAlso</span>.<span class="ruby-identifier">empty?</span>
|
|
1327
|
+
250: <span class="ruby-identifier">str</span> <span class="ruby-operator">+=</span> <span class="ruby-value str">"See also: "</span>
|
|
1328
|
+
251: <span class="ruby-identifier">alsoStr</span> = <span class="ruby-value str">''</span>
|
|
1329
|
+
252: <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>
|
|
1330
|
+
253: <span class="ruby-keyword kw">unless</span> <span class="ruby-identifier">alsoStr</span>.<span class="ruby-identifier">empty?</span>
|
|
1331
|
+
254: <span class="ruby-identifier">alsoStr</span> <span class="ruby-operator">+=</span> <span class="ruby-value str">', '</span>
|
|
1332
|
+
255: <span class="ruby-keyword kw">end</span>
|
|
1333
|
+
256: <span class="ruby-identifier">alsoStr</span> <span class="ruby-operator">+=</span> <span class="ruby-identifier">also</span>.<span class="ruby-identifier">keyword</span>
|
|
1334
|
+
257: <span class="ruby-keyword kw">end</span>
|
|
1335
|
+
258: <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>)
|
|
1336
|
+
259: <span class="ruby-identifier">str</span> <span class="ruby-operator">+=</span> <span class="ruby-value str">"\n"</span>
|
|
1337
|
+
260: <span class="ruby-keyword kw">end</span>
|
|
1338
|
+
261:
|
|
1339
|
+
262: <span class="ruby-comment cmt"># str += "Rule: #{@rule.name}\n" if @rule</span>
|
|
1340
|
+
263: <span class="ruby-comment cmt"># str += "Pattern: #{@pattern.tokens.join(' ')}\n" if @pattern</span>
|
|
1341
|
+
264: <span class="ruby-identifier">str</span>
|
|
1342
|
+
265: <span class="ruby-keyword kw">end</span></pre>
|
|
1343
|
+
</div>
|
|
1344
|
+
|
|
1345
|
+
</div>
|
|
1346
|
+
|
|
1347
|
+
|
|
1348
|
+
|
|
1349
|
+
|
|
1350
|
+
</div>
|
|
1351
|
+
|
|
1352
|
+
|
|
1353
|
+
</div>
|
|
1354
|
+
|
|
1355
|
+
<div id="private-instance-method-details" class="method-section section">
|
|
1356
|
+
<h3 class="section-header">Private Instance Methods</h3>
|
|
1357
|
+
|
|
1358
|
+
|
|
1359
|
+
<div id="check-eference-method" class="method-detail ">
|
|
1360
|
+
<a name="M001005"></a>
|
|
1361
|
+
|
|
1362
|
+
<div class="method-heading">
|
|
1363
|
+
|
|
1364
|
+
<span class="method-name">checkReference</span><span
|
|
1365
|
+
class="method-args">(pattern)</span>
|
|
1366
|
+
<span class="method-click-advice">click to toggle source</span>
|
|
1367
|
+
|
|
1368
|
+
</div>
|
|
1369
|
+
|
|
1370
|
+
<div class="method-description">
|
|
1371
|
+
|
|
1372
|
+
|
|
1373
|
+
|
|
1374
|
+
|
|
1375
|
+
|
|
1376
|
+
<div class="method-source-code"
|
|
1377
|
+
id="check-eference-source">
|
|
1378
|
+
<pre>
|
|
1379
|
+
<span class="ruby-comment cmt"># File lib/KeywordDocumentation.rb, line 469</span>
|
|
1380
|
+
469: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">checkReference</span>(<span class="ruby-identifier">pattern</span>)
|
|
1381
|
+
470: <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">pattern</span>.<span class="ruby-identifier">keyword</span>.<span class="ruby-identifier">nil?</span>
|
|
1382
|
+
471: <span class="ruby-identifier">$stderr</span>.<span class="ruby-identifier">puts</span> <span class="ruby-node">"Pattern #{pattern} is undocumented but referenced by "</span> <span class="ruby-operator">+</span>
|
|
1383
|
+
472: <span class="ruby-node">"#{@keyword}."</span>
|
|
1384
|
+
473: <span class="ruby-keyword kw">false</span>
|
|
1385
|
+
474: <span class="ruby-keyword kw">end</span>
|
|
1386
|
+
475: <span class="ruby-keyword kw">true</span>
|
|
1387
|
+
476: <span class="ruby-keyword kw">end</span></pre>
|
|
1388
|
+
</div>
|
|
1389
|
+
|
|
1390
|
+
</div>
|
|
1391
|
+
|
|
1392
|
+
|
|
1393
|
+
|
|
1394
|
+
|
|
1395
|
+
</div>
|
|
1396
|
+
|
|
1397
|
+
|
|
1398
|
+
<div id="format-method" class="method-detail ">
|
|
1399
|
+
<a name="M001011"></a>
|
|
1400
|
+
|
|
1401
|
+
<div class="method-heading">
|
|
1402
|
+
|
|
1403
|
+
<span class="method-name">format</span><span
|
|
1404
|
+
class="method-args">(indent, str, width)</span>
|
|
1405
|
+
<span class="method-click-advice">click to toggle source</span>
|
|
1406
|
+
|
|
1407
|
+
</div>
|
|
1408
|
+
|
|
1409
|
+
<div class="method-description">
|
|
1410
|
+
|
|
1411
|
+
|
|
1412
|
+
|
|
1413
|
+
|
|
1414
|
+
|
|
1415
|
+
<div class="method-source-code"
|
|
1416
|
+
id="format-source">
|
|
1417
|
+
<pre>
|
|
1418
|
+
<span class="ruby-comment cmt"># File lib/KeywordDocumentation.rb, line 532</span>
|
|
1419
|
+
532: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">format</span>(<span class="ruby-identifier">indent</span>, <span class="ruby-identifier">str</span>, <span class="ruby-identifier">width</span>)
|
|
1420
|
+
533: <span class="ruby-constant">TextFormatter</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">width</span>, <span class="ruby-identifier">indent</span>).<span class="ruby-identifier">format</span>(<span class="ruby-identifier">str</span>)[<span class="ruby-identifier">indent</span><span class="ruby-operator">..</span><span class="ruby-value">1</span>]
|
|
1421
|
+
534: <span class="ruby-keyword kw">end</span></pre>
|
|
1422
|
+
</div>
|
|
1423
|
+
|
|
1424
|
+
</div>
|
|
1425
|
+
|
|
1426
|
+
|
|
1427
|
+
|
|
1428
|
+
|
|
1429
|
+
</div>
|
|
1430
|
+
|
|
1431
|
+
|
|
1432
|
+
<div id="generate-avigation-ar-method" class="method-detail ">
|
|
1433
|
+
<a name="M001007"></a>
|
|
1434
|
+
|
|
1435
|
+
<div class="method-heading">
|
|
1436
|
+
|
|
1437
|
+
<span class="method-name">generateHTMLNavigationBar</span><span
|
|
1438
|
+
class="method-args">()</span>
|
|
1439
|
+
<span class="method-click-advice">click to toggle source</span>
|
|
1440
|
+
|
|
1441
|
+
</div>
|
|
1442
|
+
|
|
1443
|
+
<div class="method-description">
|
|
1444
|
+
|
|
1445
|
+
<p>
|
|
1446
|
+
Generate the navigation bar.
|
|
1447
|
+
</p>
|
|
1448
|
+
|
|
1449
|
+
|
|
1450
|
+
|
|
1451
|
+
<div class="method-source-code"
|
|
1452
|
+
id="generate-avigation-ar-source">
|
|
1453
|
+
<pre>
|
|
1454
|
+
<span class="ruby-comment cmt"># File lib/KeywordDocumentation.rb, line 483</span>
|
|
1455
|
+
483: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">generateHTMLNavigationBar</span>
|
|
1456
|
+
484: <span class="ruby-ivar">@manual</span>.<span class="ruby-identifier">generateHTMLNavigationBar</span>(
|
|
1457
|
+
485: <span class="ruby-ivar">@predecessor</span> <span class="ruby-operator">?</span> <span class="ruby-ivar">@predecessor</span>.<span class="ruby-identifier">title</span> <span class="ruby-operator">:</span> <span class="ruby-keyword kw">nil</span>,
|
|
1458
|
+
486: <span class="ruby-ivar">@predecessor</span> <span class="ruby-operator">?</span> <span class="ruby-node">"#{@predecessor.keyword}.html"</span> <span class="ruby-operator">:</span> <span class="ruby-keyword kw">nil</span>,
|
|
1459
|
+
487: <span class="ruby-ivar">@successor</span> <span class="ruby-operator">?</span> <span class="ruby-ivar">@successor</span>.<span class="ruby-identifier">title</span> <span class="ruby-operator">:</span> <span class="ruby-keyword kw">nil</span>,
|
|
1460
|
+
488: <span class="ruby-ivar">@successor</span> <span class="ruby-operator">?</span> <span class="ruby-node">"#{@successor.keyword}.html"</span> <span class="ruby-operator">:</span> <span class="ruby-keyword kw">nil</span>)
|
|
1461
|
+
489: <span class="ruby-keyword kw">end</span></pre>
|
|
1462
|
+
</div>
|
|
1463
|
+
|
|
1464
|
+
</div>
|
|
1465
|
+
|
|
1466
|
+
|
|
1467
|
+
|
|
1468
|
+
|
|
1469
|
+
</div>
|
|
1470
|
+
|
|
1471
|
+
|
|
1472
|
+
<div id="indent-method" class="method-detail ">
|
|
1473
|
+
<a name="M001006"></a>
|
|
1474
|
+
|
|
1475
|
+
<div class="method-heading">
|
|
1476
|
+
|
|
1477
|
+
<span class="method-name">indent</span><span
|
|
1478
|
+
class="method-args">(width, str)</span>
|
|
1479
|
+
<span class="method-click-advice">click to toggle source</span>
|
|
1480
|
+
|
|
1481
|
+
</div>
|
|
1482
|
+
|
|
1483
|
+
<div class="method-description">
|
|
1484
|
+
|
|
1485
|
+
|
|
1486
|
+
|
|
1487
|
+
|
|
1488
|
+
|
|
1489
|
+
<div class="method-source-code"
|
|
1490
|
+
id="indent-source">
|
|
1491
|
+
<pre>
|
|
1492
|
+
<span class="ruby-comment cmt"># File lib/KeywordDocumentation.rb, line 478</span>
|
|
1493
|
+
478: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">indent</span>(<span class="ruby-identifier">width</span>, <span class="ruby-identifier">str</span>)
|
|
1494
|
+
479: <span class="ruby-constant">TextFormatter</span>.<span class="ruby-identifier">new</span>(<span class="ruby-value">0</span>, <span class="ruby-identifier">width</span>).<span class="ruby-identifier">indent</span>(<span class="ruby-identifier">str</span>)[<span class="ruby-identifier">width</span><span class="ruby-operator">..</span><span class="ruby-value">1</span>]
|
|
1495
|
+
480: <span class="ruby-keyword kw">end</span></pre>
|
|
1496
|
+
</div>
|
|
1497
|
+
|
|
1498
|
+
</div>
|
|
1499
|
+
|
|
1500
|
+
|
|
1501
|
+
|
|
1502
|
+
|
|
1503
|
+
</div>
|
|
1504
|
+
|
|
1505
|
+
|
|
1506
|
+
<div id="keyword-ef-method" class="method-detail ">
|
|
1507
|
+
<a name="M001008"></a>
|
|
1508
|
+
|
|
1509
|
+
<div class="method-heading">
|
|
1510
|
+
|
|
1511
|
+
<span class="method-name">keywordHTMLRef</span><span
|
|
1512
|
+
class="method-args">(parent, keyword)</span>
|
|
1513
|
+
<span class="method-click-advice">click to toggle source</span>
|
|
1514
|
+
|
|
1515
|
+
</div>
|
|
1516
|
+
|
|
1517
|
+
<div class="method-description">
|
|
1518
|
+
|
|
1519
|
+
<p>
|
|
1520
|
+
Return a HTML object with a link to the manual page for the keyword.
|
|
1521
|
+
</p>
|
|
1522
|
+
|
|
1523
|
+
|
|
1524
|
+
|
|
1525
|
+
<div class="method-source-code"
|
|
1526
|
+
id="keyword-ef-source">
|
|
1527
|
+
<pre>
|
|
1528
|
+
<span class="ruby-comment cmt"># File lib/KeywordDocumentation.rb, line 492</span>
|
|
1529
|
+
492: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">keywordHTMLRef</span>(<span class="ruby-identifier">parent</span>, <span class="ruby-identifier">keyword</span>)
|
|
1530
|
+
493: <span class="ruby-identifier">parent</span> <span class="ruby-operator"><<</span> <span class="ruby-constant">XMLNamedText</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">keyword</span>.<span class="ruby-identifier">title</span>,
|
|
1531
|
+
494: <span class="ruby-value str">'a'</span>, <span class="ruby-value str">'href'</span> =<span class="ruby-operator">></span> <span class="ruby-node">"#{keyword.keyword}.html"</span>)
|
|
1532
|
+
495: <span class="ruby-keyword kw">end</span></pre>
|
|
1533
|
+
</div>
|
|
1534
|
+
|
|
1535
|
+
</div>
|
|
1536
|
+
|
|
1537
|
+
|
|
1538
|
+
|
|
1539
|
+
|
|
1540
|
+
</div>
|
|
1541
|
+
|
|
1542
|
+
|
|
1543
|
+
<div id="list-ttributes-method" class="method-detail ">
|
|
1544
|
+
<a name="M001010"></a>
|
|
1545
|
+
|
|
1546
|
+
<div class="method-heading">
|
|
1547
|
+
|
|
1548
|
+
<span class="method-name">listHTMLAttributes</span><span
|
|
1549
|
+
class="method-args">(list, width)</span>
|
|
1550
|
+
<span class="method-click-advice">click to toggle source</span>
|
|
1551
|
+
|
|
1552
|
+
</div>
|
|
1553
|
+
|
|
1554
|
+
<div class="method-description">
|
|
1555
|
+
|
|
1556
|
+
<p>
|
|
1557
|
+
Utility function to turn a list of keywords into a comma separated list of
|
|
1558
|
+
HTML references to the files of these keywords. All embedded in a table
|
|
1559
|
+
cell element. <em>list</em> is the <a
|
|
1560
|
+
href="KeywordDocumentation.html">KeywordDocumentation</a> list.
|
|
1561
|
+
<em>width</em> is the percentage width of the cell.
|
|
1562
|
+
</p>
|
|
1563
|
+
|
|
1564
|
+
|
|
1565
|
+
|
|
1566
|
+
<div class="method-source-code"
|
|
1567
|
+
id="list-ttributes-source">
|
|
1568
|
+
<pre>
|
|
1569
|
+
<span class="ruby-comment cmt"># File lib/KeywordDocumentation.rb, line 517</span>
|
|
1570
|
+
517: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">listHTMLAttributes</span>(<span class="ruby-identifier">list</span>, <span class="ruby-identifier">width</span>)
|
|
1571
|
+
518: <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>, <span class="ruby-value str">'style'</span> =<span class="ruby-operator">></span> <span class="ruby-node">"width:#{width}%"</span>)
|
|
1572
|
+
519: <span class="ruby-identifier">first</span> = <span class="ruby-keyword kw">true</span>
|
|
1573
|
+
520: <span class="ruby-identifier">list</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>
|
|
1574
|
+
521: <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">first</span>
|
|
1575
|
+
522: <span class="ruby-identifier">first</span> = <span class="ruby-keyword kw">false</span>
|
|
1576
|
+
523: <span class="ruby-keyword kw">else</span>
|
|
1577
|
+
524: <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>)
|
|
1578
|
+
525: <span class="ruby-keyword kw">end</span>
|
|
1579
|
+
526: <span class="ruby-identifier">keywordHTMLRef</span>(<span class="ruby-identifier">td</span>, <span class="ruby-identifier">attr</span>)
|
|
1580
|
+
527: <span class="ruby-keyword kw">end</span>
|
|
1581
|
+
528:
|
|
1582
|
+
529: <span class="ruby-identifier">td</span>
|
|
1583
|
+
530: <span class="ruby-keyword kw">end</span></pre>
|
|
1584
|
+
</div>
|
|
1585
|
+
|
|
1586
|
+
</div>
|
|
1587
|
+
|
|
1588
|
+
|
|
1589
|
+
|
|
1590
|
+
|
|
1591
|
+
</div>
|
|
1592
|
+
|
|
1593
|
+
|
|
1594
|
+
<div id="new-ich-ext-method" class="method-detail ">
|
|
1595
|
+
<a name="M001009"></a>
|
|
1596
|
+
|
|
1597
|
+
<div class="method-heading">
|
|
1598
|
+
|
|
1599
|
+
<span class="method-name">newRichText</span><span
|
|
1600
|
+
class="method-args">(text)</span>
|
|
1601
|
+
<span class="method-click-advice">click to toggle source</span>
|
|
1602
|
+
|
|
1603
|
+
</div>
|
|
1604
|
+
|
|
1605
|
+
<div class="method-description">
|
|
1606
|
+
|
|
1607
|
+
<p>
|
|
1608
|
+
This function is primarily a wrapper around the <a
|
|
1609
|
+
href="RichText.html">RichText</a> constructor. It catches all <a
|
|
1610
|
+
href="RichTextScanner.html">RichTextScanner</a> processing problems and
|
|
1611
|
+
converts the exception data into an error message.
|
|
1612
|
+
</p>
|
|
1613
|
+
|
|
1614
|
+
|
|
1615
|
+
|
|
1616
|
+
<div class="method-source-code"
|
|
1617
|
+
id="new-ich-ext-source">
|
|
1618
|
+
<pre>
|
|
1619
|
+
<span class="ruby-comment cmt"># File lib/KeywordDocumentation.rb, line 500</span>
|
|
1620
|
+
500: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">newRichText</span>(<span class="ruby-identifier">text</span>)
|
|
1621
|
+
501: <span class="ruby-keyword kw">begin</span>
|
|
1622
|
+
502: <span class="ruby-identifier">rText</span> = <span class="ruby-constant">RichText</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">text</span>)
|
|
1623
|
+
503: <span class="ruby-identifier">rti</span> = <span class="ruby-identifier">rText</span>.<span class="ruby-identifier">generateIntermediateFormat</span>
|
|
1624
|
+
504: <span class="ruby-ivar">@references</span> <span class="ruby-operator">+=</span> <span class="ruby-identifier">rti</span>.<span class="ruby-identifier">internalReferences</span>
|
|
1625
|
+
505: <span class="ruby-keyword kw">rescue</span> <span class="ruby-constant">RichTextException</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">msg</span>
|
|
1626
|
+
506: <span class="ruby-identifier">$stderr</span>.<span class="ruby-identifier">puts</span> <span class="ruby-node">"Error in RichText of rule #{@keyword}\n"</span> <span class="ruby-operator">+</span>
|
|
1627
|
+
507: <span class="ruby-node">"Line #{msg.lineNo}: #{msg.text}\n"</span> <span class="ruby-operator">+</span>
|
|
1628
|
+
508: <span class="ruby-node">"#{msg.line}"</span>
|
|
1629
|
+
509: <span class="ruby-keyword kw">end</span>
|
|
1630
|
+
510: <span class="ruby-identifier">rti</span>
|
|
1631
|
+
511: <span class="ruby-keyword kw">end</span></pre>
|
|
1632
|
+
</div>
|
|
1633
|
+
|
|
1634
|
+
</div>
|
|
1635
|
+
|
|
1636
|
+
|
|
1637
|
+
|
|
1638
|
+
|
|
1639
|
+
</div>
|
|
1640
|
+
|
|
1641
|
+
|
|
1642
|
+
</div>
|
|
1643
|
+
|
|
1644
|
+
|
|
1645
|
+
</div>
|
|
1646
|
+
|
|
1647
|
+
|
|
1648
|
+
<div id="rdoc-debugging-section-dump" class="debugging-section">
|
|
1649
|
+
|
|
1650
|
+
<p>Disabled; run with --debug to generate this.</p>
|
|
1651
|
+
|
|
1652
|
+
</div>
|
|
1653
|
+
|
|
1654
|
+
<div id="validator-badges">
|
|
1655
|
+
<p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
|
|
1656
|
+
<p><small>Generated with the <a href="http://deveiate.org/projects/Darkfish-Rdoc/">Darkfish
|
|
1657
|
+
Rdoc Generator</a> 1.1.6</small>.</p>
|
|
1658
|
+
</div>
|
|
1659
|
+
|
|
1660
|
+
</body>
|
|
1661
|
+
</html>
|
|
1662
|
+
|