Red Hat Bugzilla – Bug 858764
RFE: Support for non-docbook files (possibly new entity type).
Last modified: 2013-11-07 21:13:29 EST
Description of problem:
From time to time we produce documentation that includes files that are not docbook XML. Sometimes these will be binary files like music or video clips, sometimes they will be HTML output from tools like pydoc that don't speak DocBook XML.
Currently to include such material in a guide you add a files subdirectory under en-US, put the material there, and then link to it from the XML using a <ulink> tag.
This can also be done with topic based books, but you have to maintain the additional files outside of SkyNet. Ideally I think I would like to see a 'Files' entity in skynet where these can be uploaded, and to have ulinks that point to them based on ID (files/12331) automatically expanded for output.
Additionally, particularly to support the API use case, it would be useful to be able to upload an archive of files and have it automatically server side (this would avoid having to manually upload each individual file if you are providing API docs for a lot of modules).
Added to the server in 1.1-SNAPSHOT build 20130503-1014
We've added the ability to store additional files that go in a books "files/" directory to the server. The structure is as follows:
A File has the following attributes:
- File ID
- File Name
- File Path
- Explode Archive
- A collection of LanguageFile's
A LanguageFile has the following attributes:
- LanguageFile ID
- File ID
- File Data
So this allows a user to upload a single file or an archive, along with specifying a custom path if required. It also allows the user to specify if the file is an archive, if it should be exploded when added to a book. Lastly it also allows Translations to be used for each File, in the same way that Images are used.
Marking this as closed since it passed our teams testing and is currently live.