Offline documentation improvements
h
harald dersch
The latest update provides an option to export to offline documentation, which is highly appreciated. I have the following feedback and suggestions, though:
a) The exported offline documentation does NOT use the site CSS (at least I do not see any option to influence that). Since our article content heavily relies on custom styles, the output looks pretty dull.
b) It were great if you could specify the categories to include in the offline documentation more easily. Currently, you need to specify each single category individually. This gets tedious and error-prone if you only need to export a subset, and have to select multiple categories. An option to select a category and include all sub-category would be highly appreciated. Especially, if you want to automate it using API, you need to provide an endless list of GUIDs.
c) Related to b). I'd like to have some kind of check/warning if you select a couple of categories, and have some articles that link to other articles which are not included in the exported content. In that case you will end up with broken links!
Thanks!
Log In
Karthikeyan J
+ Prasun
N
Navin Kumar
hi harald dersch,
Thank you for the request. It is very detailed and gives us clarity on the expectation. Please find the responses below,
a. Yes, the exported document has its own CSS. When the offline documentation is downloaded, we also expose the CSS along with the same. This is to ensure that we give this control to the user to modify it accordingly. To develop this feature, we would take significant effort, instead you can update the CSS in the downloaded document, and use the same CSS for the other downloads as well.
b. We understand this usability issue, we will address this and update you in this thread.
c. This is a pretty advanced feature but the pain point is very much real. We will prioritize this based on the Customer requests.
d. We don't currently support export using offline documentation in APIs. We understand this is something you want. When we prioritize this, we will also consider the request to allow multiple calls at the same time.
//Antonyraj Sebastin Viswanathan
h
harald dersch
Amendment to b) It seems that the API (/v2/Project/Export) by default retrieves JSON output. Is there a way to export HTML offline doucmentation?
Amendment d) Only one export at a time is allowed, which is rather limiting. What is worse is that if you initiate an export, while another export is already in progress (but with different parameters, e.g. a different set of selected categories), the API seems to return the ID of the first export. IMHO, it should return a dedicated result that another export is already in progress.