helpPath typically refers to a configuration property that defines the path to the location where help content or documentation is stored within the AEM repository.
The helpPath configuration property is often used in AEM components or templates to specify the location where users can access contextual help documentation related to the specific component or template. This can be helpful for content authors and administrators who need guidance on how to use certain features or elements within the AEM interface.
By setting the helpPath property, you provide a reference to the relevant documentation that users can access directly from the AEM interface, making it easier for them to understand and work with different components and features. Clicking on the help path will redirect the author to documentation which may be useful for them to understand how the component works as expected.
Keep in mind that the exact implementation and usage of helpPath can vary based on the specific version of AEM and the customizations made by the organization. Always refer to the official AEM documentation or any relevant resources specific to your version of AEM for the most accurate and up-to-date information.
Example Code
1 2 3 4 5 6 7 8 9 10 11 12 13 | <jcr:root xmlns:sling="http://sling.apache.org/jcr/sling/1.0" xmlns:jcr="http://www.jcp.org/jcr/1.0" xmlns:nt="http://www.jcp.org/jcr/nt/1.0" xmlns:cq="http://www.day.com/jcr/cq/1.0" xmlns:granite="http://www.adobe.com/jcr/granite/1.0" jcr:primaryType="nt:unstructured" jcr:title="My Custom Component" sling:resourceType="cq/gui/components/authoring/dialog" extraClientlibs="[myproject.components.mycustomcomponent.editor]" helpPath="/content/myproject/help/mycustomcomponent.html" trackingFeature="myproject:mycustomcomponent"> <!-- Define your component's dialog structure here --> </jcr:root> |
