[jira] [Commented] (COR-14) Source documentation, questions to be answered.

["jan iversen (JIRA)" <ji...@apache.org>]

    [ https://issues.apache.org/jira/browse/COR-14?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=14281710#comment-14281710 ] 

jan iversen commented on COR-14:
--------------------------------

There is a need for a document (graphic), how the files interrelate and which files contain external parts.

It would also be nice with a documentation of the kernel works, so that people could more easily add new filters.


> Source documentation, questions to be answered. 
> ------------------------------------------------
>
>                 Key: COR-14
>                 URL: https://issues.apache.org/jira/browse/COR-14
>             Project: Corinthia
>          Issue Type: Improvement
>         Environment: wiki,  documentation
>            Reporter: jan iversen
>
> Writing source documentation is often difficult, because the writer knows it all, so documentation tends to be in such a detail that outsider dont have a chance of getting the big lines.
> I have tried to write down the questions I see (based on my experience from e.g. AOO), and hope they can serve as a part guide line, when writing:
> 1) I want to add a new file format, how do I add my files to the library, and where do I find documentation about the format I have to convert to/from ?
> 2) I have a formatting problem when converting from docx to odf, where do I start debugging ?
> 3) I want to add support for presentation files in html/docx/odf, where do I start ?
> 4) I want to port docFormats to freebsd, what must be done ?
> 5) My document contains a .psd file, its not shown correctly in the saved html file, how do I debug ?
> 6) I want to control memory allocation, how does garbage collection happen ?
> 7) can I have my own memory manager, so I can limit the memory usage ?
> 8) Can I convert docFormats into a dll, what files do I need to change ?
> 9) I want to write a new renderer (qt), which files do I need to change ?
> more to come.



--
This message was sent by Atlassian JIRA
(v6.3.4#6332)