Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Differences of 00-027 with original #28

Closed
ronaldtse opened this issue Feb 7, 2020 · 4 comments
Closed

Differences of 00-027 with original #28

ronaldtse opened this issue Feb 7, 2020 · 4 comments
Assignees
Labels
bug Something isn't working

Comments

@ronaldtse
Copy link
Contributor

ronaldtse commented Feb 7, 2020

Differences between the original and the generated document:

  • Style of the front page is different. Only release date is given in the original document (no submission/approval/publication date).
  • Instead of the License Agreement, which is included in the generated document, the original contains Notice.
  • List of Figures is included in the generated document, unlike in the original.
  • The first section (Preface) is numbered with 0 in the original document and with 1 in the generated document.
  • Header and footer content is different.
  • I'm not sure whether the page break should be added in .adoc after each section, or it should be set as a general rule that each section starts on a new page. Please let me know if I should add page breaks.
  • In the original document, figures and their captions are left-aligned, while they are centered in the generated document (which I believe is good).
  • [class=steps] is not working in OGC.
  • In cross-references, generated document uses the word "Clause", while the original document uses "section".
  • [appendix,obligation=informative] produces the title "Annex", while "Appendix" is expected.

Originally from #25 .

@ronaldtse ronaldtse added the bug Something isn't working label Feb 7, 2020
@opoudjis
Copy link
Contributor

opoudjis commented Mar 3, 2020

This spec is 20 years old, and the following discrepancies, I would argue, should not be addressed: they would be a non-trivial amount of customisation (only some of which can be done via configuration), for an edge case.

Style of the front page is different. Only release date is given in the original document (no submission/approval/publication date).

Instead of the License Agreement, which is included in the generated document, the original contains Notice.

(A new boilerplate XML could be generated to put the text specific to this version of OGC, but I do not believe it is worthwhile.)

List of Figures is included in the generated document, unlike in the original.

The first section (Preface) is numbered with 0 in the original document and with 1 in the generated document.

In the original document, figures and their captions are left-aligned, while they are centered in the generated document (which I believe is good).

In cross-references, generated document uses the word "Clause", while the original document uses "section".

[appendix,obligation=informative] produces the title "Annex", while "Appendix" is expected.

The following are known issues from #21

Header and footer content is different.

[class=steps] is not working in OGC.

@opoudjis
Copy link
Contributor

opoudjis commented Mar 3, 2020

I'm not sure whether the page break should be added in .adoc after each section, or it should be set as a general rule that each section starts on a new page. Please let me know if I should add page breaks.

This is a completely differently formatted document, and page breaks used to be the rule back in 2000; it is not now. I do not believe that reproducing the 2000 formatting in the current flavour is worthwhile: I would not insert page breaks.

@opoudjis
Copy link
Contributor

opoudjis commented Mar 3, 2020

Putting on hold, with recommendation to close.

@opoudjis opoudjis closed this as completed Mar 3, 2020
@ronaldtse
Copy link
Contributor Author

@opoudjis agree to close this one.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working
Projects
None yet
Development

No branches or pull requests

2 participants