You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
I am currently using the program HelpNDoc to build the R-Instat file and I have come across a number of features that may be of interest.
Inserting variable: These are terms/items that have not yet been finalised, and therefore might all need to be changed at a later date. Inserting them as a variable makes it very easy to update them all at once to the agreed upon term. Please let me know if you can think of any repeated terms or sections of text that might need to be updated at a later stage. https://www.helpndoc.com/step-by-step-guides/how-to-add-an-item-to-the-library/
Conditional publishing: This enables one to mark sections of text or library items to only be published if other conditions are met, for example it being a particular version of the program. I am not sure if this applies but I know that there are menu items that are scheduled to be built but not yet ready, so thought I would mention this feature. https://www.helpndoc.com/tags/conditional-content-generation/
Multiple publishing options: "Once you have written your documentation, HelpNDoc can automatically generate Microsoft CHM help files, standard HTML documentation pages, complete Word or PDF document, cross-platform Qt Help, Markdown documents or whole eBooks" I am not sure if we are interested in formats other than in program help files, but wondered if it might be useful to have an online help (in case people can't download a big file) or formats to use in teaching. https://www.helpndoc.com/step-by-step-guides/how-to-publish-your-documentation/
Create image map: There is the option of creating a clickable image, where clicking on a a section of the image will hyperlink you to an anchor (area of text) of your choice. I have not been using this as we have been linking text to anchors. However, I wanted to mention it in case someone felt this would be particularly useful in some way or with certain images. https://www.helpndoc.com/step-by-step-guides/how-to-create-an-image-map/
@rdstern is interested in linking the Climatic menu items to sections of the climatic guide. Upon contacting HelpNdoc to see if this was possible (without including the full climatic guide in the help file) they said that it would depend on where it was hosted. If it was on google drive they queried whether we could use google bookmarks within the documents, and then link to those. Is this something that someone could investigate?
Please let me know if you have any questions, I will do my best to answer and if I cannot Help N Doc seem very responsive so I can pass trickier questions on.
reacted with thumbs up emoji reacted with thumbs down emoji reacted with laugh emoji reacted with hooray emoji reacted with confused emoji reacted with heart emoji reacted with rocket emoji reacted with eyes emoji
-
Hello All,
I am currently using the program HelpNDoc to build the R-Instat file and I have come across a number of features that may be of interest.
Inserting variable: These are terms/items that have not yet been finalised, and therefore might all need to be changed at a later date. Inserting them as a variable makes it very easy to update them all at once to the agreed upon term. Please let me know if you can think of any repeated terms or sections of text that might need to be updated at a later stage. https://www.helpndoc.com/step-by-step-guides/how-to-add-an-item-to-the-library/
Conditional publishing: This enables one to mark sections of text or library items to only be published if other conditions are met, for example it being a particular version of the program. I am not sure if this applies but I know that there are menu items that are scheduled to be built but not yet ready, so thought I would mention this feature. https://www.helpndoc.com/tags/conditional-content-generation/
Multiple publishing options: "Once you have written your documentation, HelpNDoc can automatically generate Microsoft CHM help files, standard HTML documentation pages, complete Word or PDF document, cross-platform Qt Help, Markdown documents or whole eBooks" I am not sure if we are interested in formats other than in program help files, but wondered if it might be useful to have an online help (in case people can't download a big file) or formats to use in teaching. https://www.helpndoc.com/step-by-step-guides/how-to-publish-your-documentation/
Create image map: There is the option of creating a clickable image, where clicking on a a section of the image will hyperlink you to an anchor (area of text) of your choice. I have not been using this as we have been linking text to anchors. However, I wanted to mention it in case someone felt this would be particularly useful in some way or with certain images. https://www.helpndoc.com/step-by-step-guides/how-to-create-an-image-map/
@rdstern is interested in linking the Climatic menu items to sections of the climatic guide. Upon contacting HelpNdoc to see if this was possible (without including the full climatic guide in the help file) they said that it would depend on where it was hosted. If it was on google drive they queried whether we could use google bookmarks within the documents, and then link to those. Is this something that someone could investigate?
Please let me know if you have any questions, I will do my best to answer and if I cannot Help N Doc seem very responsive so I can pass trickier questions on.
Thanks,
Rachel
Beta Was this translation helpful? Give feedback.
All reactions