Thanks to HelpNDoc’s very powerful API and script editor, you will be able to quickly and easily achieve things which are impossible with any other Help Authoring Tools: Automate help and documentation generation, export topic identifiers, simplify time-consuming tasks… the possibilities are endless! So take a look at HelpNDoc’s huge list of available API methods and start automating your help, documentation and eBook writing now. Getting help | Gettinghelp | 5 HelpNDoc’s API will help you save time System requirements | Systemrequirements | 4 This way, you won’t have to do the developer’s job and the developer won’t need to have to access the help file’s structure. You can now send that file to your developers so that they can wire the application or web-site with the help file you are currently writing. Create the file aList.SaveToFile(OUTPUT_FILE) īy running this script, HelpNDoc will generate a file located at “c:\tmp\topics.txt” (this can be customized in the script above) with a list of all the topics available in the current project. Get next topic aTopicId := HndTopics.GetTopicNext(aTopicId) Add the topic to the list aList.Add(Format( '%s | %s | %d ', [ Loop through all topics while aTopicId '' do begin Try // Get first topic aTopicId := HndTopics.GetTopicFirst() We offer you some discount for Ibe software. Just because its Parents Day, doesnt mean you should have to spend a lot of money. Init list aList := TStringList.Create ĪList.Add( 'Topic Caption | Help ID | Help Context ') ĪList.Add( '- ') Jul 2023 - 10 OFF discount for Parents Day Discounted price: 107.84 Get HelpNDoc Standard Edition 10 discount OFF now. Var // List of output aList: TStringList Var // Current topic ID aTopicId: string We will use it to create a file with a list of topic identifiers.Ĭonst // Define the output file OUTPUT_FILE = 'c: \tmp \topics.txt ' HelpNDoc includes a very powerful API which can be used from the Script Editor to maintain and automate your projects. Thanks to HelpNDoc’s very powerful script editor, you can easily do that! Use HelpNDoc’s API to automate that job But as a technical writer, you probably won’t be in charge of “wiring” that application or web-site with the help file and you’d rather send a list of topic identifiers to the developers in charge. This makes it possible to reach a specific topic from your software application or web-site. For that purpose, Help Authoring Tools such as HelpNDoc provide two unique identifiers for each topic: an alpha-numeric Help ID and a numeric Help Context number. Once you’ve written your help file or documentation web-site, you’d usually like to be able to integrate it with your existing products: when users are having difficulties performing an action, they should be able to launch the help file and be presented with the correct associated topic explaining that specific action.
0 Comments
Leave a Reply. |
AuthorWrite something about yourself. No need to be fancy, just an overview. ArchivesCategories |