Adding Documentation for AEM Components

Documentation is one of the important key processes when it comes to delivering any kind of software functionality. Meanwhile, It is a technical write-up that is helpful from a developer’s perspective. It contains technical details like how to configure the module to show certain functionality otherwise it is difficult for the new developers to understand the whole process. Explaining the whole functionality is a time-consuming procedure instead one can share a technical document that covers actual functionality.

We can enable the documentation tab by following some simple steps.

6. Now copy the URL from the address bar. In my case, URL will be /mnt/overlay/wcm/core/content/sites/components/details.html/apps/Suraj/title

7. Go to the component inside CRXDE Lite > cq:dialog and set the helpPath property and set the value from the above-copied path.
The code should look as follow.

Sample XML Code:

8. Now allow & add the component to the page, Open the Dialog and Click on the Help (?) icon.

You will see the following component details window

In order to show up documentation as the default active tab when the author clicks on the Help (?) icon, We need to overlay the AEM’s certain functionality. Just follow certain steps.

4. Now go to overlayed path inside /apps folder
/apps/wcm/core/content/sites/components/details/jcr:content/content/single/content/items/content/items/tabs/items/documentation Click on documentation Node and set following property
sling:orderBefore (String) : fixedColumnContainer

5. Once you are done with these steps now reopen the component dialog. Click on the help (?) icon and this will open the following window.

Note: I have tested this functionality on AEM 6.4 & 6.5

You can see the Documentation as a default active tab when the author clicks on the help (?) icon.

Related posts:

All I hear is white noise. When I listen to people talking about what they’re talking about. It’s not going in. Technical information that I don’t know? White noise. All of this talk doesn’t feel…

An accidental observation of a meticulous meteorologist, Edward Lorenz, has catalysed and spawned the birth of chaos theory. In 1961, Lorenz typed in some data into a computer program that could…

In the world of computer science, there are many programming languages, and no single language is superior to another. In other words, each language is best suited to solve certain problems, and in…