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

WIP: Binary num rep - issue 36 #35

Open
wants to merge 2 commits into
base: master
Choose a base branch
from

Conversation

mbeckerle
Copy link
Collaborator

Please review this and comment.

This is my take on creating an OGF document, but using asciidoc to do so.

I think the PDF looks pretty good as an OGF doc. The asciidoc can be reviewed using github review stuff.

@@ -0,0 +1,135 @@
// please start a new sentence on a new line.
Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ignore this file for this PR review please. It is part of a different PR.

It documents experimental features which add new binary number representations and binary calendar representations.
[discrete]
===== Contents
toc::[]
Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

In the PDF the TOC does not contain the sub-sections of the back-matter. It needs to.

@@ -0,0 +1,88 @@
:title: Extended Binary Number and Binary Calendar Representations
Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

PDF comes through with metadata title "Untitled".

The limited permissions granted above are perpetual and will not be revoked by the OGF or its successors or assignees.

[bibliography]
==== References
Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think the references should be before the back-matter.

[bibliography]
==== References

* [[[DFDL]]] OGF DFDL 1.0 specification: http://www.ogf.org/documents/GFD.207.pdf/
Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Link broken due to final trailing "/" after ".pdf".

Copyright (C) Open Grid Forum, 2022. Some Rights Reserved. Distribution is Unlimited.
[discrete]
===== Abstract
This document provides experience information to the OGF community on the Data Format Description Language (DFDL) 1.0 specification (GFD-P-R.207)
Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Might as well link to DFDL reference entry.

@smhdfdl
Copy link
Contributor

smhdfdl commented Nov 4, 2022

can you attach the pdf please, and describe how you got the pdf from the adoc.

@mbeckerle
Copy link
Collaborator Author

gwde-dfdl-experience-9-experimental-number-reps.pdf

The PDF is attahed. It is part of the PR as well.

I created this PR by editing the asciidoc using IntelliJ IDEA and hitting the "PDF" button. There is a command line way using asciidoc as well.

@mbeckerle mbeckerle changed the title WIP: Binary num rep WIP: Binary num rep - issue 36 May 24, 2023
This is for review by the team as a concept.

I think it looks good.

PDF is provided so you can see how that comes out, but the source code can be reviewed using github review.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants