Documentation Center

Sample BehaviorConfig.xml file

This sample file gives an impression of the structure of the BehaviorConfig.xml file.

<?xml version="1.0" encoding="utf-8"?>
<behaviorconfig xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="BehaviorConfig.xsd" version="1.0">

	<behaviorscopegroup name="Common configuration">
		<behaviorgroup name="Codeblock">
			<block xpath="self::codeblock" type="cannotbesplit-and-candirectlycontaintext" clearsamexpathbehavior="yes">
				<label>Code block</label>
				<placeholdertext>Fill in the code here</placeholdertext>
				<menuitems>
					<menuitem id="add-codeblock">
						<label>Add Codeblock</label>
						<inserttemplate><codeblock/></inserttemplate>
					</menuitem>
				</menuitems>								
			</block>
		</behaviorgroup>
	</behaviorscopegroup>

	<behaviorscopegroup name="Api2ref specific configuration">
		<scopetoschemas>
			<schema location="dita-sdl/1.3/schema/api2ref/xsd/api2ref.xsd"/>
		</scopetoschemas>
		<behaviorgroup name="Api2ref">
			<sheet xpath="self::api2ref">
				<label>API 2 reference</label>
			</sheet>
			<block xpath="self::api2function" type="cannotbesplit-and-candirectlycontaintext">
				<label>API 2 Function</label>
				<contextualmenuitems>
					<contextualmenuitem>
						<label>Add Function Name</label>
						<inserttemplate><functionname/></inserttemplate>
					</contextualmenuitem>
				</contextualmenuitems>
			</block>
			<block xpath="self::classname" type="cannotbesplit-and-candirectlycontaintext" clearsamexpathbehavior="yes">
				<label>Class Name</label>
			</block>
			<block xpath="self::classversion" type="cannotbesplit-and-candirectlycontaintext" clearsamexpathbehavior="yes">
				<label>Class Version</label>
			</block>
			<block xpath="self::functionname" type="cannotbesplit-and-candirectlycontaintext" clearsamexpathbehavior="yes">
				<label>Function Name</label>
				<placeholdertext>Fill in a function name here</placeholdertext>
				<menuitems>
					<menuitem id="add-functionname">
						<label>Add Function Name</label>
						<inserttemplate><functionname/></inserttemplate>
					</menuitem>
				</menuitems>								
			</block>
			<block xpath="self::purpose" type="cannotbesplit-and-candirectlycontaintext" clearsamexpathbehavior="yes">
				<label>Purpose</label>				
			</block>
			<block xpath="self::paramStringIn" type="cannotbesplit-and-cannotdirectlycontaintext" clearsamexpathbehavior="yes">
				<label>Input string parameter</label>
			</block>
			<block xpath="self::paramStringOut" type="cannotbesplit-and-cannotdirectlycontaintext" clearsamexpathbehavior="yes">
				<label>Output string parameter</label>
			</block>
			<block xpath="self::paramName" type="cannotbesplit-and-candirectlycontaintext" clearsamexpathbehavior="yes">
				<label>Name</label>
				<placeholdertext>Type the parameter name here</placeholdertext>
			</block>
			<block xpath="self::paramDesc" type="cannotbesplit-and-candirectlycontaintext" clearsamexpathbehavior="yes">
				<label>Description</label>				
				<placeholdertext>Type the parameter description here</placeholdertext>
			</block>
			<block xpath="self::purpose" type="cannotbesplit-and-candirectlycontaintext" clearsamexpathbehavior="yes">
				<label>Purpose</label>				
			</block>
			<block xpath="self::paramlist" type="cannotbesplit-and-cannotdirectlycontaintext" clearsamexpathbehavior="yes">
				<label>Parameter list</label>
				<contextualmenuitems>
					<contextualmenuitem>
						<label>Add input parameter</label>
						<inserttemplate><paramStringIn><paramName/><paramDesc/></paramStringIn></inserttemplate>
					</contextualmenuitem>
					<contextualmenuitem>
						<label>Add output parameter</label>
						<inserttemplate><paramStringOut><paramName/><paramDesc/></paramStringOut></inserttemplate>
					</contextualmenuitem>
				</contextualmenuitems>
				<menuitems>
					<menuitem id="add-paramlist">
						<label>Add Parameter list</label>
						<inserttemplate><paramlist/></inserttemplate>
					</menuitem>
				</menuitems>
			</block>
			<block xpath="self::remarks" type="cannotbesplit-and-candirectlycontaintext" clearsamexpathbehavior="yes">
				<label>Remarks</label>
				<menuitems>
					<menuitem id="add-remarks">
						<label>Add Remarks</label>
						<inserttemplate><remarks/></inserttemplate>
					</menuitem>
				</menuitems>				
			</block>			
			<block xpath="self::api2desc" type="cannotbesplit-and-cannotdirectlycontaintext">
				<label>API 2 Description</label>
			</block>
			<blockgenericicon xpath="self::*" icon="sort-alpha-asc" tooltipquery="./string(node-name(.))" priority="-5">
				<label>Not specifically configured element</label>
			</blockgenericicon>			
		</behaviorgroup>
	</behaviorscopegroup>

 <menuconfiguration>
    <extramenu xpath="ancestor-or-self::apiref">
      <label>Api Reference</label>
      <description>Menus to insert API reference elements</description>
      <menuitemref ref="add-functionname"/>
      <menuseparator/>
      <menuexpandgroup>
        <label>Advanced</label>
        <description>Choose one of the advanced elements</description>
        <menuitemref ref="add-paramlist"/>
        <menuitemref ref="add-remarks"/>
      </menuexpandgroup>
    </extramenu>
    <extramenu>
      <label>Code</label>
      <description>Menus to insert code elements</description>
      <menuitemref ref="add-codeblock" icon="code"/>
    </extramenu>
 </menuconfiguration>

 <sidebarconfiguration>
   <extrasidebar id="custom-sidebar-example" url="https://example.com/ISHCSORA19/Api/Try/ExtraSidebar/" icon="globe" size="l">
     <label>Custom Sidebar</label>
     <description>Custom Sidebar Example</description>
   </extrasidebar>
 </sidebarconfiguration>
</behaviorconfig>