mohalfaki / bungeni-portal

Automatically exported from code.google.com/p/bungeni-portal
0 stars 0 forks source link

Rendering Attachment contents inline #759

Open GoogleCodeExporter opened 9 years ago

GoogleCodeExporter commented 9 years ago
Current Scenario

Currently the Bill in Bungeni has a rich text field where a summary of the bill 
is typed in /pasted.
This summary field is rendered as the "body" of the bill when viewed over the 
web browser.

Bill (or for that matter other ) documents can be large documents running to 
tens or a few hundred pages, and may not be suitable for pasting into the rich 
text field. The full length bill is added as an attachment to the Bill. This 
full length bill can then be viewed by downloading the attachment and viewing 
it separately.

Requirement

It must be possible to attach a full length "attachment" bill/question/tabled 
document/motion etc (i.e. any parliamentary document) as an attachment to its 
main document in Bungeni and render it in the body of the Document.

User Story

- The user adds the metadata for the bill. 
- The user enters the summary.
- The user then adds attachments to the Bill. 
- The user selects a "type" for the attachment - the current types provided are 
image, annex, document, bill. This should instead be in line with Akoma Ntoso 
document part typology :
 * main
 * annex
 * attachment
 * image
- An additional "display as main document" checkbox is provided while attaching 
the attachment to the bill.
When the bill is viewed - 
   * if there is an attachment of type "main" with the "display as main document" checkbox selected, that attachment is converted to html and rendered in-line in the body of the bill. There will be a link below the "summary" of the bill - The link will say "expand : <type of attachment>, <title of the attachment>"  , clicking on which will expand the summary in place to show the full rendering of the bill from the attachment.
   * If there is an attachment of type "annex" with the "display as main document" checkbox selected, that annex  will be shown on the main page of the bill below the body with a link : "expand : Annex : <title of annex> ". Clicking on it will render the annex in place in the page of the bill.
Similarly for "image" and "attachment"

Some Other Notes

 - Rendering of attachment to HTML can be done per mime-type. E.g. akomantoso-xml has a converter implementation while PDF has its own converter implementation. This type specific implementation covers both the actual conversion aspect to HTML and the display of the html in the page. For e.g. - displaying Akoma Ntoso XML attachment in the page may be done with a hierarchical Tree View render involving a UI widget ; while displaying a PDF attachment may be just as flat converted html.  This needs to be explored in a technical overview of the issue.

 - A service based implementation for accepting attachments on an item may be required in the future, to allow external apps to post attachments to bungeni. e.g. Bungeni Editor posting an Akoma Ntoso bill to bungeni ; or a hansard system posting debates to bungeni . This needs to be explored in a technical overview of the issue.

Original issue reported on code.google.com by ashok.ha...@gmail.com on 3 Jul 2012 at 7:35