blob: 14304fa81c66e25e41c8724967c4756d861cef69 [file] [log] [blame]
<?xml version="1.0" encoding="UTF-8"?>
<org.eclipse.epf.uma:ContentDescription xmi:version="2.0"
xmlns:xmi="http://www.omg.org/XMI" xmlns:org.eclipse.epf.uma="http://www.eclipse.org/epf/uma/1.0.5/uma.ecore"
xmlns:epf="http://www.eclipse.org/epf" epf:version="1.5.0" xmlns:rmc="http://www.ibm.com/rmc"
rmc:version="7.5.0" xmi:id="-B1Bw5L_j1EXDXFbgGxCo_g"
name="detailing_common_method_element_fields,_zVLrkJZwEd2ireJkqESkdQ" guid="-B1Bw5L_j1EXDXFbgGxCo_g"
changeDate="2008-11-05T10:14:33.000-0800" version="7.5.0">
<mainDescription>&lt;p>&#xD;
In general, use the individual method element properties to capture specific information about the element.&amp;nbsp;This&#xD;
simplifies the text so that&amp;nbsp;the reader can easily focus on the information they’re interested in.&#xD;
&lt;/p>&#xD;
&lt;p>&#xD;
&lt;strong>General information&lt;/strong>:&#xD;
&lt;/p>&#xD;
&lt;ul>&#xD;
&lt;li>&#xD;
&lt;strong>Name&lt;/strong>: For information on how to name method elements, see &lt;a class=&quot;elementLinkWithType&quot;&#xD;
href=&quot;./../../../core.mdev.common.base/guidances/guidelines/method_element_naming_conventions_4A4F743B.html&quot;&#xD;
guid=&quot;_lAphAF5-EduT-Px7fh0LSg&quot;>Guideline: Method Element Naming Conventions&lt;/a>.&#xD;
&lt;/li>&#xD;
&lt;li>&#xD;
&lt;strong>Presentation Name&lt;/strong>: For information on how to name method elements, see &lt;a&#xD;
class=&quot;elementLinkWithType&quot;&#xD;
href=&quot;./../../../core.mdev.common.base/guidances/guidelines/method_element_naming_conventions_4A4F743B.html&quot;&#xD;
guid=&quot;_lAphAF5-EduT-Px7fh0LSg&quot;>Guideline: Method Element Naming Conventions&lt;/a>.&#xD;
&lt;/li>&#xD;
&lt;li>&#xD;
&lt;strong>Brief Description&lt;/strong>: For information on how to write the brief description for method elements, see&#xD;
&lt;a class=&quot;elementLinkWithType&quot;&#xD;
href=&quot;./../../../core.mdev.common.base/guidances/guidelines/writing_brief_descriptions_D01D2F53.html&quot;&#xD;
guid=&quot;_cJbBkCAhEdy1y5bWsXfCCg&quot;>Guideline: Writing Brief Descriptions&lt;/a>.&#xD;
&lt;/li>&#xD;
&lt;/ul>&#xD;
&lt;p>&#xD;
&lt;strong>Detail information&lt;/strong>:&#xD;
&lt;/p>&#xD;
&lt;p>&#xD;
Use the Purpose and Description sections of method element to state the purpose or conclusion of the idea that’s being&#xD;
communicated. Use the remaining sections to provide a detailed explanation of the subject.&#xD;
&lt;/p>&#xD;
&lt;ul>&#xD;
&lt;li>&#xD;
&lt;strong>Purpose&lt;/strong>: Describes the reason for the method element.&amp;nbsp;&amp;nbsp;&#xD;
&lt;/li>&#xD;
&lt;li>&#xD;
&lt;strong>Main description&lt;/strong>: Provides an extended description that explains what the method element is beyond&#xD;
what is covered elsewhere.&lt;span style=&quot;mso-spacerun: yes&quot;>&amp;nbsp;&lt;/span>&#xD;
&lt;/li>&#xD;
&lt;li>&#xD;
&lt;strong>Key considerations&lt;/strong>: Contains useful material that does not easily fit into any of the other&#xD;
sections, such as advice and guidance of a critical nature. as well as warnings, cautions, pitfalls and dangers&#xD;
&lt;/li>&#xD;
&lt;/ul>&#xD;
&lt;p>&#xD;
&lt;strong>Version information&lt;/strong>:&#xD;
&lt;/p>&#xD;
&lt;ul>&#xD;
&lt;li>&#xD;
&lt;span style=&quot;mso-spacerun: yes&quot;>&lt;strong>Version&lt;/strong>: The version number of the element.&amp;nbsp;In many cases,&#xD;
versioning is done at the plug-in level, rather than at the individual element level.&lt;/span>&amp;nbsp; For more&#xD;
information, see &lt;a class=&quot;elementLinkWithType&quot;&#xD;
href=&quot;./../../../core.mdev.common.base/guidances/guidelines/maintaining_change_histories_and_version_numbers_B83271.html&quot;&#xD;
guid=&quot;_k91OkFpBEdutiI3y4Hpy9Q&quot;>Guideline: Maintaining Change Histories and Version Numbers&lt;/a>.&#xD;
&lt;/li>&#xD;
&lt;li>&#xD;
&lt;strong>Change date&lt;/strong>: Today’s date is entered by clicking in the field. It cannot be removed.&amp;nbsp;For more&#xD;
information, see &lt;a class=&quot;elementLinkWithType&quot;&#xD;
href=&quot;./../../../core.mdev.common.base/guidances/guidelines/maintaining_change_histories_and_version_numbers_B83271.html&quot;&#xD;
guid=&quot;_k91OkFpBEdutiI3y4Hpy9Q&quot;>Guideline: Maintaining Change Histories and Version Numbers&lt;/a>.&#xD;
&lt;/li>&#xD;
&lt;li>&#xD;
&lt;strong>Change description&lt;/strong>: Enter any free-form text. The history of these descriptions is&#xD;
maintained.&amp;nbsp;For more information, see &lt;a class=&quot;elementLinkWithType&quot;&#xD;
href=&quot;./../../../core.mdev.common.base/guidances/guidelines/maintaining_change_histories_and_version_numbers_B83271.html&quot;&#xD;
guid=&quot;_k91OkFpBEdutiI3y4Hpy9Q&quot;>Guideline: Maintaining Change Histories and Version Numbers&lt;/a>.&#xD;
&lt;/li>&#xD;
&lt;li>&#xD;
&lt;strong>Authors&lt;/strong>: Identify the author(s) of this content.&amp;nbsp;&#xD;
&lt;/li>&#xD;
&lt;li>&#xD;
&lt;strong>Copyright&lt;/strong>: The element's copyright.&amp;nbsp;This is generally only completed for the plug-in, since&#xD;
every element gets the plug-in’s copyright, unless it is overridden for a particular element. For more information,&#xD;
see &lt;a class=&quot;elementLinkWithType&quot;&#xD;
href=&quot;./../../../core.mdev.common.base/guidances/guidelines/trademarks_and_copyrights_F14EB70C.html&quot;&#xD;
guid=&quot;_OxsfkH8MEdu_ipWWZJimvQ&quot;>Guideline: Trademarks and Copyrights&lt;/a>.&#xD;
&lt;/li>&#xD;
&lt;/ul>&#xD;
&lt;p>&#xD;
&lt;strong>Icon&lt;/strong>:&#xD;
&lt;/p>&#xD;
&lt;ul>&#xD;
&lt;li>&#xD;
&lt;strong>Shape icon:&lt;/strong> Specify the icon to be displayed in the upper left of the content page when published.&#xD;
Define a new icon or use one from another plug-in.&#xD;
&lt;/li>&#xD;
&lt;li>&#xD;
&lt;strong>Node icon:&lt;/strong> Specify the icon displayed by this node in the tree view of the published site. Define&#xD;
a new icon or use one from another plug-in.&#xD;
&lt;/li>&#xD;
&lt;/ul></mainDescription>
</org.eclipse.epf.uma:ContentDescription>