Writing an online help file, a user manual, an eBook or any other format handled by HelpNDoc is usually lengthy ongoing and non-linear process. Oftentimes, as the content evolves, the overall topic hierarchy can become sub-optimal and a re-organization is required in order to make the documentation easier to read and navigate. Even though HelpNDoc provides tools to easily re-organize the table of contents, in some cases the process can be lengthy and error-prone, such as when an alphabetical sorting of topics is required. Thankfully, HelpNDoc includes scripts to automatically re-order topics by title. Let’s see how rapidly and easily this can be done.
Run the topic sorting script
Not only does HelpNDoc include powerful scripting capabilities, it also comes bundled with useful script sources such as the “SortAllTopics” and “SortChildTopics” scripts which are able to automatically sort topics by title.
Once you’ve added some topics to your documentation and perhaps organized them, HelpNDoc’s scripting capabilities come in handy to help automate the topic sorting task:
- From HelpNDoc’s “Tools” ribbon tab, click “Script Editor”
- From the script editor window, click the arrow next to the “Load script” button
- Click “SortAllTopics.hnd.pas” to load the topic sorting script
- Click “Run script”… and voilà! The whole table of contents is sorted by title
That was easy enough. But what if you only need to sort some topics, and not all of them ? Simply select one topic in the table of contents, load and run the “SortChildTopics.hnd.pas” script as explained above, and all its children will be sorted alphabetically.
Custom sorting and special requirements
Sorting topics by title isn’t always useful and some projects might need automated sorting of topics based on some other attributes, such as the topics’ help identifiers. For those special requirements, the bundled scripts can serve as a starting point and can easily be customized using HelpNDoc’s powerful and extensive API.
From its straightforward user interface to its advanced scripting capabilities, HelpNDoc provides all the tools needed to produce amazing help files, product manuals, eBooks… as rapidly and easily as possible. And the best part is that HelpNDoc is completely free for personal use and evaluation purposes. Try it now, and enjoy documenting!
See also
- Mastering Multi-Channel Publishing: Why HelpNDoc Leaves WordPress in the Dust
- Empowering Technical Writers: Harnessing HelpNDoc's Override Features for Unlimited Documentation Variations
- The Future of Documentation: How Help Authoring Tools are Empowering Technical Writers and Organizations
- Bridging the Gap Between Teachers and Students: Harnessing the Power of Help-Authoring Tools for Engaging Content Creation
- How technical writers can include PHP code in their online documentation