[OASIS Issue Tracker] Commented: (AMQP-70) Question on use of approve document template

[OASIS Issues Tracker <workgroup_mailer@lists.oasis-open.org>]

    [ http://tools.oasis-open.org/issues/browse/AMQP-70?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=30464#action_30464 ] 

Rob Godfrey commented on AMQP-70:
---------------------------------

The sources for building the documentation are available within the oasis subversion system. The underlying document is in an XML format that has evolved over many years and iterations of AMQP. The HTML and PDF presentations are generated by applying XSL transforms to the XML (in the case of the HTML this is a direct translation, in the case of the PDF it goes through an intermediate LaTeX format).

There is a Makefile alongside the document source within the repository that will build the output documents as long as all the necessary software is installed (the build works across Linux, OS X and Windows platforms, but does require certain UNIX utilities (such as grep, sed, etc) to be installed on Windows.

We have received requests to make the build system available to others to use, and we will endeavour to isolate the AMQP specific elements to make it more portable should others wish to do so.



> Question on use of approve document template
> --------------------------------------------
>
>                 Key: AMQP-70
>                 URL: http://tools.oasis-open.org/issues/browse/AMQP-70
>             Project: OASIS Advanced Message Queuing Protocol (AMQP) TC
>          Issue Type: Task
>          Components: HTML Formatting, PDF Formatting
>    Affects Versions: CSPRD01
>            Reporter: Rob Godfrey
>
> From Public Review Comment:
> This specification does not currently use an approved template, as required by the TC Process, section2.18 (1). Approved templates can be found via http://docs.oasis-open.org/templates/ If the TC does not want to use one of the current approved templates,  the TC must work  with TC Admin  to get the template authorized and registered. The following MUST be taken into account by the TC and TC Admin during this process:
>  a) there needs to be authoritative and editable source  for the cover pages, bolierplate and table of contents. As is stands I have no idea where this is being generated from.
>  b) there needs to be an authoritative and editable source that declares precisely what document parts make up the specification. In other words how does someone know which parts to include in gerenating the pdf for example.
>  c) the mechanism, tools and scripts required to generate the pdf and html must be documented and made available on http://docs.oasis-open.org/templates/

-- 
This message is automatically generated by JIRA.
-
If you think it was sent incorrectly contact one of the administrators: http://tools.oasis-open.org/issues/secure/Administrators.jspa
-
For more information on JIRA, see: http://www.atlassian.com/software/jira