NOTICE: The Processors Wiki will End-of-Life on January 15, 2021. It is recommended to download any files or other content you may need that are hosted on processors.wiki.ti.com. The site is now set to read only.

User:DVT/UserDocumentation/DVT Views Context Sensitive Help

From Texas Instruments Wiki
Jump to: navigation, search

Context Sensitive Help[edit]

Overview[edit]

DVT Data Views use "Context-sensitive help from multiple plug-ins" to contribute to Eclipse' help. See Eclipse Context Sensitive Help for more info about eclipse.

DVT framework dynamically assigns a Help context ID for any data views based on View title and following this pattern: com.ti.dvt.ui.<title>_View

Using view title. Anything after ' -' string after view title will be dropped and all leading/trailing spaces will be trimme. Also any spaces in view title will be replced with '_'.

If you want to specify your own Help context ID, that overrides what DVT generates, you may do so by setting Help context ID in view's advanced property.

Steps to contribute to Context Sensitive Help[edit]

Context Sensitive Help
  • Create an eclipse Plugin project or use one that you already have.
  • Modify plugin.xml file to add contribution to help context ids for com.ti.dvt.ui plugin.

<?xml version="1.0" encoding="UTF-8"?> <?eclipse version="3.2"?> <plugin> 

  <extension point="org.eclipse.help.contexts">

<contexts file="dvt_context.xml" plugin="com.ti.dvt.ui" /> 

  </extension>

</plugin>

  • create dvt-context.xml (you could use any name but it should match to the name used in plugin.xml) and assuming your view title is "My Logs" add:

<?xml version="1.0" encoding="UTF-8"?> <?NLS TYPE="org.eclipse.help.contexts"?> <contexts> 

  <context id="My_Logs_View" title="My Logs">

<description>My Logs Table</description> 

       <topic href="html/MyLogs.html" label="My Logs"/>
       <topic href="PLUGINS_ROOT/com.ti.dvt.ui.doc/html/DVT_concepts/tables/table_display_controls.htm" label="Table display controls"/>
       <topic href="PLUGINS_ROOT/com.ti.dvt.ui.doc/html/DVT_concepts/tables/table_view_toolbar.htm" label="Table view toolbar"/>
       <topic href="PLUGINS_ROOT/com.ti.dvt.ui.doc/html/DVT_tasks/workingWithTables/adjusting_table_column_widths.htm" label="Adjusting column widths"/>
       <topic href="PLUGINS_ROOT/com.ti.dvt.ui.doc/html/DVT_tasks/workingWithTables/exporting_data_as_a_csv_file.htm" label="Exporting data as a CSV file"/>
       <topic href="PLUGINS_ROOT/com.ti.dvt.ui.doc/html/DVT_tasks/workingWithTables/searching_for_values_in_logs.htm" label="Find"/>
       <topic href="PLUGINS_ROOT/com.ti.dvt.ui.doc/html/DVT_tasks/workingWithTables/filtering_values_in_logs.htm" label="Filter"/>
    <topic href="PLUGINS_ROOT/com.ti.dvt.ui.doc/html/DVT_tasks/synchronizingTablesGraphs/managing_groups.htm" label="Groups"/>
  </context>

</contexts>

  • add your html content in html/MyLogs.html file.

And as soon as the focus is on your DVT view you should see the related topics if eclipse' help view is open (or hit F1)

Linking to DVT help[edit]

If you just need to simply link to pre-existing DVT help without contributing anything, set the Help context ID property to one of the following values depending the type of graph:

  • Bar Graph: com.ti.dvt.ui.barView
  • Discrete Graph: com.ti.dvt.ui.discreteView
  • Table: com.ti.dvt.ui.tableView
  • Line Graph: com.ti.dvt.ui.lineView
  • State Graph: com.ti.dvt.ui.stateView

But if you'd like to contribute your own content plus link to DVT help content for views under the links for your own help content as shown in the previous section, you may do so by adding topics linked to DVT help content as you like, here are some suggestions for different view types.

Table[edit]

<topic href="PLUGINS_ROOT/com.ti.dvt.ui.doc/html/DVT_concepts/tables/table_display_controls.htm" label="Table display controls"/> <topic href="PLUGINS_ROOT/com.ti.dvt.ui.doc/html/DVT_concepts/tables/table_view_toolbar.htm" label="Table view toolbar"/> <topic href="PLUGINS_ROOT/com.ti.dvt.ui.doc/html/DVT_tasks/workingWithTables/adjusting_table_column_widths.htm" label="Adjusting column widths"/> <topic href="PLUGINS_ROOT/com.ti.dvt.ui.doc/html/DVT_tasks/workingWithTables/exporting_data_as_a_csv_file.htm" label="Exporting data as a CSV file"/> <topic href="PLUGINS_ROOT/com.ti.dvt.ui.doc/html/DVT_tasks/workingWithTables/searching_for_values_in_logs.htm" label="Find"/> <topic href="PLUGINS_ROOT/com.ti.dvt.ui.doc/html/DVT_tasks/workingWithTables/filtering_values_in_logs.htm" label="Filter"/> <topic href="PLUGINS_ROOT/com.ti.dvt.ui.doc/html/DVT_tasks/synchronizingTablesGraphs/managing_groups.htm" label="Groups"/>

Line Graph[edit]

<topic href="PLUGINS_ROOT/com.ti.dvt.ui.doc/html/DVT_concepts/graphs/line_graph.htm" label="Line graphs"/>

<topic href="PLUGINS_ROOT/com.ti.dvt.ui.doc/html/DVT_concepts/graphs/graph_view_display_controls.htm" label="Graph view display controls"/> <topic href="PLUGINS_ROOT/com.ti.dvt.ui.doc/html/DVT_concepts/graphs/graph_view_toolbar.htm" label="Graph view toolbar"/> <topic href="PLUGINS_ROOT/com.ti.dvt.ui.doc/html/DVT_concepts/graphs/measurement_markers_feature.htm" label="Measurement marker"/> <topic href="PLUGINS_ROOT/com.ti.dvt.ui.doc/html/DVT_concepts/graphs/common_graph_properties.htm" label="Common graph properties"/> <topic href="PLUGINS_ROOT/com.ti.dvt.ui.doc/html/DVT_concepts/graphs/common_graph_shortcut_commands.htm" label="Graph shortcut commands"/> <topic href="PLUGINS_ROOT/com.ti.dvt.ui.doc/html/DVT_tasks/workingWithTables/searching_for_values_in_logs.htm" label="Find"/> <topic href="PLUGINS_ROOT/com.ti.dvt.ui.doc/html/DVT_tasks/workingWithTables/filtering_values_in_logs.htm" label="Filter"/> <topic href="PLUGINS_ROOT/com.ti.dvt.ui.doc/html/DVT_tasks/synchronizingTablesGraphs/managing_groups.htm" label="Groups"/>

Discrete Graph[edit]

<topic href="PLUGINS_ROOT/com.ti.dvt.ui.doc/html/DVT_concepts/graphs/discrete_graph.htm" label="Discrete graphs"/>

<topic href="PLUGINS_ROOT/com.ti.dvt.ui.doc/html/DVT_concepts/graphs/graph_view_display_controls.htm" label="Graph view display controls"/> <topic href="PLUGINS_ROOT/com.ti.dvt.ui.doc/html/DVT_concepts/graphs/graph_view_toolbar.htm" label="Graph view toolbar"/> <topic href="PLUGINS_ROOT/com.ti.dvt.ui.doc/html/DVT_concepts/graphs/measurement_markers_feature.htm" label="Measurement marker"/> <topic href="PLUGINS_ROOT/com.ti.dvt.ui.doc/html/DVT_concepts/graphs/common_graph_properties.htm" label="Common graph properties"/> <topic href="PLUGINS_ROOT/com.ti.dvt.ui.doc/html/DVT_concepts/graphs/common_graph_shortcut_commands.htm" label="Graph shortcut commands"/> <topic href="PLUGINS_ROOT/com.ti.dvt.ui.doc/html/DVT_tasks/workingWithTables/searching_for_values_in_logs.htm" label="Find"/> <topic href="PLUGINS_ROOT/com.ti.dvt.ui.doc/html/DVT_tasks/workingWithTables/filtering_values_in_logs.htm" label="Filter"/> <topic href="PLUGINS_ROOT/com.ti.dvt.ui.doc/html/DVT_tasks/synchronizingTablesGraphs/managing_groups.htm" label="Groups"/>

State Graph[edit]

<topic href=" PLUGINS_ROOT/com.ti.dvt.ui.doc/html/DVT_concepts/graphs/state_graph.htm" label="State graphs"/>

<topic href="PLUGINS_ROOT/com.ti.dvt.ui.doc/html/DVT_concepts/graphs/graph_view_display_controls.htm" label="Graph view display controls"/> <topic href="PLUGINS_ROOT/com.ti.dvt.ui.doc/html/DVT_concepts/graphs/graph_view_toolbar.htm" label="Graph view toolbar"/> <topic href="PLUGINS_ROOT/com.ti.dvt.ui.doc/html/DVT_concepts/graphs/measurement_markers_feature.htm" label="Measurement marker"/> <topic href="PLUGINS_ROOT/com.ti.dvt.ui.doc/html/DVT_concepts/graphs/common_graph_properties.htm" label="Common graph properties"/> <topic href="PLUGINS_ROOT/com.ti.dvt.ui.doc/html/DVT_concepts/graphs/common_graph_shortcut_commands.htm" label="Graph shortcut commands"/> <topic href="PLUGINS_ROOT/com.ti.dvt.ui.doc/html/DVT_tasks/workingWithTables/searching_for_values_in_logs.htm" label="Find"/> <topic href="PLUGINS_ROOT/com.ti.dvt.ui.doc/html/DVT_tasks/workingWithTables/filtering_values_in_logs.htm" label="Filter"/> <topic href="PLUGINS_ROOT/com.ti.dvt.ui.doc/html/DVT_tasks/synchronizingTablesGraphs/managing_groups.htm" label="Groups"/>

Retrieved from "https://processors.wiki.ti.com/index.php?title=User:DVT/UserDocumentation/DVT_Views_Context_Sensitive_Help&oldid=16022"