plugins/org.eclipse.datatools.doc.isv/projects/dtp/dtp/en/source/c_documentation_team_workflow.html - datatools/org.eclipse.datatools - Gitiles

 <?xml version="1.0" encoding="UTF-8"?>
 <!DOCTYPE html
   PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
 <html lang="en" xml:lang="en">
 <head>
 <meta http-equiv="Content-Type" content="text/html; charset=utf-8"/>
 <meta name="copyright" content="(C) Copyright 2005"/>
 <meta name="DC.rights.owner" content="(C) Copyright 2005"/>
 <meta name="DC.Type" content="concept"/>
 <meta name="DC.Title" content="Documentation Team Workflow"/>
 <meta name="abstract" content="Documentation teams should refer to the product’s architectural specifications to define an appropriate architecture (that is, granularity, content partitioning, plug-in naming, and so on) for online documentation plug-ins. With that information, Documentation teams can begin the process to create context-sensitive help plug-ins."/>
 <meta name="description" content="Documentation teams should refer to the product’s architectural specifications to define an appropriate architecture (that is, granularity, content partitioning, plug-in naming, and so on) for online documentation plug-ins. With that information, Documentation teams can begin the process to create context-sensitive help plug-ins."/>
 <meta name="DC.Relation" scheme="URI" content="../../../../../projects/dtp/dtp/en/source/c_help_context_ids.html"/>
 <meta name="DC.Relation" scheme="URI" content="../../../../../projects/dtp/dtp/en/source/c_help_search_expressions.html"/>
 <meta name="DC.Relation" scheme="URI" content="../../../../../projects/dtp/dtp/en/source/c_csh_plugins_with_dita.html"/>
 <meta name="DC.Creator" content="dresch"/>
 <meta name="DC.Format" content="XHTML"/>
 <meta name="DC.Identifier" content="concept_BB3CED38F0364F5783F6D8D8139CF0DF"/>
 <meta name="DC.Language" content="en"/>
 <link rel="stylesheet" type="text/css" href="../../../../../styles/commonltr.css"/>
 <link rel="stylesheet" type="text/css" href="../../../../../styles/doc.css"/>
 <title>Documentation Team Workflow</title>
 <meta name="provider" content="Sybase, Inc."/></head>
 <body id="concept_BB3CED38F0364F5783F6D8D8139CF0DF"><a name="concept_BB3CED38F0364F5783F6D8D8139CF0DF"><!-- --></a>
 <br/>

     <h1 class="topictitle1">Documentation Team Workflow</h1>


     <div><p>Documentation teams should refer to the product’s architectural specifications
            to define an appropriate architecture (that is, granularity, content partitioning,
            plug-in naming, and so on) for online documentation plug-ins. With that information,
            Documentation teams can begin the process to create context-sensitive help
            plug-ins.
         </p>


         <p>The Documentation team workflow described in this section assumes that
            dedicated context-sensitive help plug-ins will be produced from DITA-XML map
            documents. The workflow can be adjusted for other help content source formats.
         </p>

         <div class="p">The following list summarizes the overall Documentation team workflow to create
            context-sensitive help plug-ins:
             <br/><a name="concept_BB3CED38F0364F5783F6D8D8139CF0DF__ol_296D684F5956402993FFBAA7EC1F4F53"><!-- --></a><ol id="concept_BB3CED38F0364F5783F6D8D8139CF0DF__ol_296D684F5956402993FFBAA7EC1F4F53">
                 <li id="concept_BB3CED38F0364F5783F6D8D8139CF0DF__li_C87FEFC574A24368B51C367EA27B4D95"><a name="concept_BB3CED38F0364F5783F6D8D8139CF0DF__li_C87FEFC574A24368B51C367EA27B4D95"><!-- --></a>Get the helpKey list (provided as a Java source file) from the UI Development
                     team for each UI plug-in.</li>

                 <li id="concept_BB3CED38F0364F5783F6D8D8139CF0DF__li_574E257AF7754B60B45E16A7D5E16237"><a name="concept_BB3CED38F0364F5783F6D8D8139CF0DF__li_574E257AF7754B60B45E16A7D5E16237"><!-- --></a>Analyze the helpKey list and associated UI controls to define the help
                     contexts. (For more information, see Defining Help Context IDs.)
                     <div class="p">The Documentation team must determine whether:
                         <br/><a name="concept_BB3CED38F0364F5783F6D8D8139CF0DF__ul_BEF274E03B494DA38CAA1804B3C6D1AD"><!-- --></a><ul id="concept_BB3CED38F0364F5783F6D8D8139CF0DF__ul_BEF274E03B494DA38CAA1804B3C6D1AD">
                             <li id="concept_BB3CED38F0364F5783F6D8D8139CF0DF__li_6719759B40754096A51C377C996D6354"><a name="concept_BB3CED38F0364F5783F6D8D8139CF0DF__li_6719759B40754096A51C377C996D6354"><!-- --></a>The helpKey constants alone are sufficient to identify actual help contexts,
                                 and thus, helpKey constants could map directly to a concrete help context ID,
                                 with the same string value as the helpKey constant.</li>

                             <li id="concept_BB3CED38F0364F5783F6D8D8139CF0DF__li_3A8243729F224F4699EA76083C335D7E"><a name="concept_BB3CED38F0364F5783F6D8D8139CF0DF__li_3A8243729F224F4699EA76083C335D7E"><!-- --></a>Distinct help context ID strings must be defined to combine groups of helpKey
                                 constants into common help contexts.</li>

                         </ul>

                     </div>


                     <div class="tip"><span class="tiptitle">Tip:</span> It may be preferable to combine help contexts in the helpKey properties
                        file, instead of defining the mapping for multiple help contexts to a single
                        topic in a DITA map. This is a judgment call for the Documentation team lead,
                        and the IAs responsible for maintaining DITA maps.

                     </div>
 </li>

                 <li id="concept_BB3CED38F0364F5783F6D8D8139CF0DF__li_47A884DAA8644EB59A0127937EF11819"><a name="concept_BB3CED38F0364F5783F6D8D8139CF0DF__li_47A884DAA8644EB59A0127937EF11819"><!-- --></a>Analyze the help contexts and existing (or planned) help topics to define
                     context-specific help search expressions.</li>


                 <li id="concept_BB3CED38F0364F5783F6D8D8139CF0DF__li_A892161B33604A8294F109DA788EE0C0"><a name="concept_BB3CED38F0364F5783F6D8D8139CF0DF__li_A892161B33604A8294F109DA788EE0C0"><!-- --></a>Create helpKey properties files, based on the content of each Java source
                     file.
                     <br/><a name="concept_BB3CED38F0364F5783F6D8D8139CF0DF__ul_426692ED26034E199125CB31C9BAF7C9"><!-- --></a><ul id="concept_BB3CED38F0364F5783F6D8D8139CF0DF__ul_426692ED26034E199125CB31C9BAF7C9">
                         <li id="concept_BB3CED38F0364F5783F6D8D8139CF0DF__li_388A29125A004B4698B5B0FF61D5EBA4"><a name="concept_BB3CED38F0364F5783F6D8D8139CF0DF__li_388A29125A004B4698B5B0FF61D5EBA4"><!-- --></a>Define the mapping of helpKey constants to concrete help context IDs and
                             context-specific help search expressions, based on results of the help context
                             analysis and help topic (content) analysis.</li>

                         <li id="concept_BB3CED38F0364F5783F6D8D8139CF0DF__li_0F8009E455A04002BCFF975FC13574F4"><a name="concept_BB3CED38F0364F5783F6D8D8139CF0DF__li_0F8009E455A04002BCFF975FC13574F4"><!-- --></a>Save the helpKey properties files in source control, as appropriate.</li>

                     </ul>


                     <div class="tip"><span class="tiptitle">Tip:</span> The helpKey properties files are flat ASCII text files, so the authors (or
                        IAs) responsible for defining the help context IDs and context-specific help
                        search expressions should use a suitable ASCII text editor to create and edit
                        those files.

                     </div>
 </li>

                 <li id="concept_BB3CED38F0364F5783F6D8D8139CF0DF__li_84D458A3EFC74BBB914374320D6D86C5"><a name="concept_BB3CED38F0364F5783F6D8D8139CF0DF__li_84D458A3EFC74BBB914374320D6D86C5"><!-- --></a>Modify existing DITA maps (if used to produce online documentation plug-ins)
                     to add the markup for context-sensitive help.</li>


                 <li>Test the deployable context-sensitive help plug-ins, with UI components
                     provided by Development teams.</li>


             </ol>

         </div>

     </div>

 <div>
 <ul class="ullinks">
 <li class="ulchildlink"><strong><a href="../../../../../projects/dtp/dtp/en/source/c_help_context_ids.html">Help Context IDs</a></strong><br/>
 Because helpKey constants are abstract entities in the Java code, and independent of the actual help context IDs, Documentation teams are responsible for defining the help contexts, which the Eclipse help system uses to locate context-specific help content, and associating each helpKey constant with an actual help context ID.</li>
 <li class="ulchildlink"><strong><a href="../../../../../projects/dtp/dtp/en/source/c_help_search_expressions.html">Help Search Expressions</a></strong><br/>
 Each help context should be associated with a context-specific help search expression, which the Eclipse help system will use to provide Dynamic Help search results in the Help view.</li>
 <li class="ulchildlink"><strong><a href="../../../../../projects/dtp/dtp/en/source/c_csh_plugins_with_dita.html">Context-Sensitive Help Plug-ins with DITA</a></strong><br/>
 Any DITA map document that defines an online documentation (doc) plug-in can be modified to also define a corresponding context-sensitive help plug-in by inserting the appropriate context-related markup.</li>
 </ul>
 </div>
 <div/>
 </body>
 </html>
	<?xml version="1.0" encoding="UTF-8"?>
	<!DOCTYPE html
	PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
	<html lang="en" xml:lang="en">
	<head>
	<meta http-equiv="Content-Type" content="text/html; charset=utf-8"/>
	<meta name="copyright" content="(C) Copyright 2005"/>
	<meta name="DC.rights.owner" content="(C) Copyright 2005"/>
	<meta name="DC.Type" content="concept"/>
	<meta name="DC.Title" content="Documentation Team Workflow"/>
	<meta name="abstract" content="Documentation teams should refer to the product’s architectural specifications to define an appropriate architecture (that is, granularity, content partitioning, plug-in naming, and so on) for online documentation plug-ins. With that information, Documentation teams can begin the process to create context-sensitive help plug-ins."/>
	<meta name="description" content="Documentation teams should refer to the product’s architectural specifications to define an appropriate architecture (that is, granularity, content partitioning, plug-in naming, and so on) for online documentation plug-ins. With that information, Documentation teams can begin the process to create context-sensitive help plug-ins."/>
	<meta name="DC.Relation" scheme="URI" content="../../../../../projects/dtp/dtp/en/source/c_help_context_ids.html"/>
	<meta name="DC.Relation" scheme="URI" content="../../../../../projects/dtp/dtp/en/source/c_help_search_expressions.html"/>
	<meta name="DC.Relation" scheme="URI" content="../../../../../projects/dtp/dtp/en/source/c_csh_plugins_with_dita.html"/>
	<meta name="DC.Creator" content="dresch"/>
	<meta name="DC.Format" content="XHTML"/>
	<meta name="DC.Identifier" content="concept_BB3CED38F0364F5783F6D8D8139CF0DF"/>
	<meta name="DC.Language" content="en"/>
	<link rel="stylesheet" type="text/css" href="../../../../../styles/commonltr.css"/>
	<link rel="stylesheet" type="text/css" href="../../../../../styles/doc.css"/>
	<title>Documentation Team Workflow</title>
	<meta name="provider" content="Sybase, Inc."/></head>
	<body id="concept_BB3CED38F0364F5783F6D8D8139CF0DF"><a name="concept_BB3CED38F0364F5783F6D8D8139CF0DF"><!-- --></a>
	<br/>

	<h1 class="topictitle1">Documentation Team Workflow</h1>


	<div><p>Documentation teams should refer to the product’s architectural specifications
	to define an appropriate architecture (that is, granularity, content partitioning,
	plug-in naming, and so on) for online documentation plug-ins. With that information,
	Documentation teams can begin the process to create context-sensitive help
	plug-ins.
	</p>



	<p>The Documentation team workflow described in this section assumes that
	dedicated context-sensitive help plug-ins will be produced from DITA-XML map
	documents. The workflow can be adjusted for other help content source formats.
	</p>

	<div class="p">The following list summarizes the overall Documentation team workflow to create
	context-sensitive help plug-ins:
	<br/><a name="concept_BB3CED38F0364F5783F6D8D8139CF0DF__ol_296D684F5956402993FFBAA7EC1F4F53"><!-- --></a><ol id="concept_BB3CED38F0364F5783F6D8D8139CF0DF__ol_296D684F5956402993FFBAA7EC1F4F53">
	<li id="concept_BB3CED38F0364F5783F6D8D8139CF0DF__li_C87FEFC574A24368B51C367EA27B4D95"><a name="concept_BB3CED38F0364F5783F6D8D8139CF0DF__li_C87FEFC574A24368B51C367EA27B4D95"><!-- --></a>Get the helpKey list (provided as a Java source file) from the UI Development
	team for each UI plug-in.</li>

	<li id="concept_BB3CED38F0364F5783F6D8D8139CF0DF__li_574E257AF7754B60B45E16A7D5E16237"><a name="concept_BB3CED38F0364F5783F6D8D8139CF0DF__li_574E257AF7754B60B45E16A7D5E16237"><!-- --></a>Analyze the helpKey list and associated UI controls to define the help
	contexts. (For more information, see Defining Help Context IDs.)
	<div class="p">The Documentation team must determine whether:
	<br/><a name="concept_BB3CED38F0364F5783F6D8D8139CF0DF__ul_BEF274E03B494DA38CAA1804B3C6D1AD"><!-- --></a><ul id="concept_BB3CED38F0364F5783F6D8D8139CF0DF__ul_BEF274E03B494DA38CAA1804B3C6D1AD">
	<li id="concept_BB3CED38F0364F5783F6D8D8139CF0DF__li_6719759B40754096A51C377C996D6354"><a name="concept_BB3CED38F0364F5783F6D8D8139CF0DF__li_6719759B40754096A51C377C996D6354"><!-- --></a>The helpKey constants alone are sufficient to identify actual help contexts,
	and thus, helpKey constants could map directly to a concrete help context ID,
	with the same string value as the helpKey constant.</li>

	<li id="concept_BB3CED38F0364F5783F6D8D8139CF0DF__li_3A8243729F224F4699EA76083C335D7E"><a name="concept_BB3CED38F0364F5783F6D8D8139CF0DF__li_3A8243729F224F4699EA76083C335D7E"><!-- --></a>Distinct help context ID strings must be defined to combine groups of helpKey
	constants into common help contexts.</li>

	</ul>

	</div>


	<div class="tip"><span class="tiptitle">Tip:</span> It may be preferable to combine help contexts in the helpKey properties
	file, instead of defining the mapping for multiple help contexts to a single
	topic in a DITA map. This is a judgment call for the Documentation team lead,
	and the IAs responsible for maintaining DITA maps.

	</div>
	</li>

	<li id="concept_BB3CED38F0364F5783F6D8D8139CF0DF__li_47A884DAA8644EB59A0127937EF11819"><a name="concept_BB3CED38F0364F5783F6D8D8139CF0DF__li_47A884DAA8644EB59A0127937EF11819"><!-- --></a>Analyze the help contexts and existing (or planned) help topics to define
	context-specific help search expressions.</li>


	<li id="concept_BB3CED38F0364F5783F6D8D8139CF0DF__li_A892161B33604A8294F109DA788EE0C0"><a name="concept_BB3CED38F0364F5783F6D8D8139CF0DF__li_A892161B33604A8294F109DA788EE0C0"><!-- --></a>Create helpKey properties files, based on the content of each Java source
	file.
	<br/><a name="concept_BB3CED38F0364F5783F6D8D8139CF0DF__ul_426692ED26034E199125CB31C9BAF7C9"><!-- --></a><ul id="concept_BB3CED38F0364F5783F6D8D8139CF0DF__ul_426692ED26034E199125CB31C9BAF7C9">
	<li id="concept_BB3CED38F0364F5783F6D8D8139CF0DF__li_388A29125A004B4698B5B0FF61D5EBA4"><a name="concept_BB3CED38F0364F5783F6D8D8139CF0DF__li_388A29125A004B4698B5B0FF61D5EBA4"><!-- --></a>Define the mapping of helpKey constants to concrete help context IDs and
	context-specific help search expressions, based on results of the help context
	analysis and help topic (content) analysis.</li>

	<li id="concept_BB3CED38F0364F5783F6D8D8139CF0DF__li_0F8009E455A04002BCFF975FC13574F4"><a name="concept_BB3CED38F0364F5783F6D8D8139CF0DF__li_0F8009E455A04002BCFF975FC13574F4"><!-- --></a>Save the helpKey properties files in source control, as appropriate.</li>

	</ul>


	<div class="tip"><span class="tiptitle">Tip:</span> The helpKey properties files are flat ASCII text files, so the authors (or
	IAs) responsible for defining the help context IDs and context-specific help
	search expressions should use a suitable ASCII text editor to create and edit
	those files.

	</div>
	</li>

	<li id="concept_BB3CED38F0364F5783F6D8D8139CF0DF__li_84D458A3EFC74BBB914374320D6D86C5"><a name="concept_BB3CED38F0364F5783F6D8D8139CF0DF__li_84D458A3EFC74BBB914374320D6D86C5"><!-- --></a>Modify existing DITA maps (if used to produce online documentation plug-ins)
	to add the markup for context-sensitive help.</li>




	<li>Test the deployable context-sensitive help plug-ins, with UI components
	provided by Development teams.</li>



	</ol>

	</div>

	</div>

	<div>
	<ul class="ullinks">
	<li class="ulchildlink"><strong><a href="../../../../../projects/dtp/dtp/en/source/c_help_context_ids.html">Help Context IDs</a></strong><br/>
	Because helpKey constants are abstract entities in the Java code, and independent of the actual help context IDs, Documentation teams are responsible for defining the help contexts, which the Eclipse help system uses to locate context-specific help content, and associating each helpKey constant with an actual help context ID.</li>
	<li class="ulchildlink"><strong><a href="../../../../../projects/dtp/dtp/en/source/c_help_search_expressions.html">Help Search Expressions</a></strong><br/>
	Each help context should be associated with a context-specific help search expression, which the Eclipse help system will use to provide Dynamic Help search results in the Help view.</li>
	<li class="ulchildlink"><strong><a href="../../../../../projects/dtp/dtp/en/source/c_csh_plugins_with_dita.html">Context-Sensitive Help Plug-ins with DITA</a></strong><br/>
	Any DITA map document that defines an online documentation (doc) plug-in can be modified to also define a corresponding context-sensitive help plug-in by inserting the appropriate context-related markup.</li>
	</ul>
	</div>
	<div/>
	</body>
	</html>