Word and HTML importers have also been improved as well as table generation for Word and PDF documentation formats. The CHM help file importer has been optimized to be faster for large CHM help files and use less system memory. HelpNDoc’s command line interface has been improved to correctly handle the selection of builds by name and relative paths overrides. Enhanced command line, importers, exporters and bug fixes The different picture properties available from the ribbon toolbar are now correctly updated when picture selection changes, and pictures inserted from the toolbar are now correctly placed where the cursor is located. Ribbon tabs are now optimized when selecting a picture or a table within the topic editor: they could flicker and loose focus when moving the cursor in various parts of a topic. HelpNDoc’s project analyzer is a wonderful assistant which helps produce the most perfect documentation: it provides project statistics, list of hyperlinks, library items and keywords, spelling mistakes… It can now also list all anchors created anywhere in the project. Enhanced project analyzer: list and locate all anchors in your documentation projects Thankfully, the newly released HelpNDoc 6.9 includes a very powerful bar code and QR code creator: technical writers can easily and rapidly encode complex information as machine-readable images, and let their audience use bar code readers or smart-phones to decrypt them! HelpNDoc can currently create the following bar code formats: EAN-8, EAN-13, MSI, QR Code, UPC-A and UPC-E.įurthermore, HelpNDoc treats bar codes and QR codes as reusable library items, meaning that they can be shared between topics and rapidly modified from the project’s central library: any changes will be automatically replicated wherever they are used. This can be cumbersome for some documentation formats (such as printed Word and PDF documents, eBooks…) as it can lead to multi-line, hardly-readable and cryptic content that the end-user need to understand or type without mistakes. 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.It is not uncommon for technical writers to have to share lengthy URLs or alpha-numeric data in their user manuals. 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() Init list aList := TStringList.Create ĪList.Add( 'Topic Caption | Help ID | Help Context ') ĪList.Add( '- ') 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 |