Skip to content

Commit

Permalink
Fixed links and chapter 1
Browse files Browse the repository at this point in the history
  • Loading branch information
@ralfhandl
ralfhandl committed Jul 22, 2023
1 parent 8635966 commit 7cdb5ca
Show file tree
Hide file tree
Showing 12 changed files with 538 additions and 1,946 deletions.
212 changes: 41 additions & 171 deletions docs/odata-csdl-json/odata-csdl-json.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,8 @@
</style>
<link rel="stylesheet" href="styles/markdown-styles-v1.7.3b.css" />
<link rel="stylesheet" href="styles/odata.css" />
<script src="https://polyfill.io/v3/polyfill.min.js?features=es6"></script>
<script src="https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-chtml-full.js" type="text/javascript"></script>
<!--[if lt IE 9]>
<script src="//cdnjs.cloudflare.com/ajax/libs/html5shiv/3.7.3/html5shiv-printshiv.min.js"></script>
<![endif]-->
Expand Down Expand Up @@ -92,7 +94,7 @@ <h4 id="notices">Notices</h4>
<h1 id="table-of-contents">Table of Contents</h1>
<p>[TOC will be inserted here]</p>
<hr />
<h1 id="1-introduction">1 Introduction</h1>
<h1 id="1-introduction"><a name="Introduction" href="#Introduction">1 Introduction</a></h1>
<!-- All text is normative unless otherwise labeled -->

<p>Here is a customized command line which will generate HTML from this markdown file (named odata-csdl-json-v4.02-csd01.md):</p>
Expand All @@ -103,175 +105,43 @@ <h1 id="1-introduction">1 Introduction</h1>
<li><a href="https://docs.oasis-open.org/templates/css/markdown-styles-v1.7.3a.css">https://docs.oasis-open.org/templates/css/markdown-styles-v1.7.3a.css</a> (this one produces HTML that resembles the github display more closely, especially for blocks of code)</li>
</ul>
<p>Note this command generates a Table of Contents (TOC) in HTML which is located at the top of the HTML document, and which requires additional editing in order to be published in the expected OASIS style. This editing can be handled by OASIS staff during publication. A TC may use other ways to generate HTML from markdown, which may generate a TOC in a different way.</p>
<h2 id="11-changes-from-earlier-versions">1.1 Changes from earlier Versions</h2>
<!-- Optional section -->
<h2 id="11-changes-from-earlier-versions"><a name="ChangesfromearlierVersions" href="#ChangesfromearlierVersions">1.1 Changes from earlier Versions</a></h2>
<!-- TODO -->

<!-- Describe significant changes from previous differently-numbered Versions, not changes between stages of the current Version -->

<h2 id="12-glossary">1.2 Glossary</h2>
<!-- Optional section with suggested subsections -->
<h2 id="12-glossary"><a name="Glossary" href="#Glossary">1.2 Glossary</a></h2>
<h3 id="121-definitions-of-terms"><a name="Definitionsofterms" href="#Definitionsofterms">1.2.1 Definitions of terms</a></h3>
<!-- TODO -->

<h3 id="121-definitions-of-terms">1.2.1 Definitions of terms</h3>
<h3 id="122-acronyms-and-abbreviations">1.2.2 Acronyms and abbreviations</h3>
<h3 id="123-document-conventions">1.2.3 Document conventions</h3>
<ul>
<li>Naming conventions</li>
<li>Font colors and styles</li>
<li>Typographic conventions</li>
</ul>
<h2 id="13-some-markdown-usage-examples">1.3 Some markdown usage examples</h2>
<p><strong>Text.</strong></p>
<p>Note that text paragraphs in markdown should be separated by a blank line between them -</p>
<p>Otherwise the separate paragraphs will be joined together when the HTML is generated. Even if the text appears to be separate lines in the markdown source.</p>
<p>To avoid having the usual vertical space between paragraphs,<br />
append two or more space characters (or space-backslash) to the end of the lines<br />
which will generate an HTML break tag instead of a new paragraph tag<br />
(as demonstrated here).</p>
<h3 id="131-figures-and-captions">1.3.1 Figures and Captions</h3>
<p>FIGURE EXAMPLE: &lt;note caption is best placed ABOVE figure, so a hyperlink to it will actually display the figure, instead of rendering the figure off the screen above the caption. The same placement should be used for table captions&gt;</p>
<h6 id="figure-1----title-of-figure">Figure 1 -- Title of Figure</h6>
<p><img src="images/image_0.png" alt="image-label should be meaningful" /> (this image is missing)</p>
<h6 id="figure-2----openc2-message-exchange">Figure 2 -- OpenC2 Message Exchange</h6>
<p><img src="images/image_1.png" alt="message exchange" /></p>
<h3 id="132-tables">1.3.2 Tables</h3>
<h4 id="1321-basic-table">1.3.2.1 Basic Table</h4>
<p><strong>Table 1-1. Table Label</strong></p>
<table>
<thead>
<tr class="header">
<th style="text-align: left;">Item</th>
<th style="text-align: left;">Description</th>
</tr>
</thead>
<tbody>
<tr class="odd">
<td style="text-align: left;">Item 1</td>
<td style="text-align: left;">Something<br>(second line)</td>
</tr>
<tr class="even">
<td style="text-align: left;">Item 2</td>
<td style="text-align: left;">Something</td>
</tr>
<tr class="odd">
<td style="text-align: left;">Item 3</td>
<td style="text-align: left;">Something<br>(second line)</td>
</tr>
<tr class="even">
<td style="text-align: left;">Item 4</td>
<td style="text-align: left;">text</td>
</tr>
</tbody>
</table>
<h4 id="1322-table-with-three-columns-and-some-bold-text">1.3.2.2 Table with Three Columns and Some Bold Text</h4>
<p>text.</p>
<table>
<thead>
<tr class="header">
<th style="text-align: left;">Title 1</th>
<th style="text-align: left;">Title 2</th>
<th style="text-align: left;">title 3</th>
</tr>
</thead>
<tbody>
<tr class="odd">
<td style="text-align: left;">something</td>
<td style="text-align: left;">something</td>
<td style="text-align: left;">something else that is a long string of text that <strong>might</strong> need to wrap around inside the table box and will just continue until the column divider is reached</td>
</tr>
<tr class="even">
<td style="text-align: left;">something</td>
<td style="text-align: left;">something</td>
<td style="text-align: left;">something</td>
</tr>
</tbody>
</table>
<h4 id="1323-table-with-a-caption-which-can-be-referenced">1.3.2.3 Table with a caption which can be referenced</h4>
<h6 id="table-1-5-see-reference-label-construction">Table 1-5. See reference label construction</h6>
<table caption uses six ####### to become a linkable element; positioned above table so table is readable after jumping to it>
| Name | Description |
| :--- | :--- |
| **content** | Message body as specified by content_type and msg_type. |
<p>TODO: find out why we need a <span class="math inline">\(dummy\)</span> formula to get <code>monospace</code> look as we want it.</p>
<h3 id="122-acronyms-and-abbreviations"><a name="Acronymsandabbreviations" href="#Acronymsandabbreviations">1.2.2 Acronyms and abbreviations</a></h3>
<!-- TODO -->

<p>Here is a reference to the table caption: Please see <a href="#table-1-5-see-reference-label-construction">Table 1-5 or other meaningful label</a></p>
<h3 id="133-lists">1.3.3 Lists</h3>
<p>Bulleted list:</p>
<ul>
<li>bullet item 1.</li>
<li><strong>Bold</strong> bullet item 2.</li>
<li>bullet item 3.</li>
<li>bullet item 4.</li>
</ul>
<p>Indented or multi-level bullet list - add two spaces per level before bullet character (* or -):</p>
<ul>
<li>main bullet type
<ul>
<li>Example second bullet
<ul>
<li>See third level
<ul>
<li>fourth level</li>
</ul></li>
</ul></li>
</ul></li>
</ul>
<p>Numbered list:</p>
<ol type="1">
<li>item 1</li>
<li>item 2</li>
<li>item 3</li>
</ol>
<p>Left-justified list without bullets or numbers: To list multiple items without full paragraph breaks between items, add space-backslash after each item except the last.</p>
<h3 id="134-reference-label-construction">1.3.4 Reference Label Construction</h3>
<p>REFERENCES and ANCHORS</p>
<ul>
<li>in markdown source, format the Reference tags as level 6 headings like: <code>###### [RFC2119]</code></li>
</ul>
<h6 id="rfc2119">[RFC2119]</h6>
<p>Bradner, S., "Key words ..."</p>
<ul>
<li><p>reference text has to be on a separate line below the tag</p></li>
<li><p>format cross-references (citations of the references) like: <code>see [[RFC2119](#rfc2119)]</code><br />
"see [<a href="#rfc2119">RFC2119</a>]"<br />
(note the outer square brackets in markdown will appear in the visible HTML text)</p></li>
<li><p>The text in the Reference tag (following ###### ) will become an HTML anchor using the following conversion rules:</p>
<ul>
<li>punctuation marks will be dropped (including "[" )</li>
<li>leading white spaces will be dropped</li>
<li>upper case will be converted to lower</li>
<li>spaces between letters will be converted to a single hyphen</li>
</ul></li>
<li><p>The same HTML anchor construction rules apply to cross-references and to section headings.</p>
<ul>
<li>Thus, a section heading like "## 1.2 Glossary"</li>
<li>becomes an anchor in HTML like <code>&lt;a href="#12-glossary"&gt;</code></li>
<li>referenced in the markdown like: see <a href="#12-glossary">Section 1.2</a></li>
<li>in markdown: <code>"see [Section 1.2](#12-glossary)"</code></li>
<li>similar HTML anchors are also used in constructing the TOC</li>
</ul></li>
</ul>
<h3 id="135-code-blocks">1.3.5 Code Blocks</h3>
<p>Text to appear as an indented code block with grey background and monospace font - use three back-ticks before and after the code block.</p>
<p>Note the actual backticks will not appear in the HTML format. If it's necessary to display visible backticks, place a back-slash before them like: ``` .</p>
<pre><code>{
&quot;target&quot;: {
&quot;x_kmip_2.0&quot;: {
{&quot;kmip_type&quot;: &quot;json&quot;},
{&quot;operation&quot;: &quot;RekeyKeyPair&quot;},
{&quot;name&quot;: &quot;publicWebKey11DEC2017&quot;}
}
}
}</code></pre>
<p>Text to be highlighted as code can also be surrounded by a single "backtick" character: <code>code text</code></p>
<h3 id="136-blockquotes">1.3.6 Blockquotes</h3>
<p>To create a blockquote, start a line with greater than (&gt;) followed by an optional space.</p>
<p>Blockquotes can be nested, and can also contain other formatting.</p>
<p>The stylesheet <a href="https://docs.oasis-open.org/templates/css/markdown-styles-v1.7.3a.css">https://docs.oasis-open.org/templates/css/markdown-styles-v1.7.3a.css</a> results in an indented block with a left-side bar.</p>
<h2 id="14-page-breaks">1.4 Page Breaks</h2>
<p>Add horizontal rule lines where page breaks are desired in the PDF - before each major section</p>
<ul>
<li>insert the line rules in markdown by inserting 3 or more hyphens on a line by themselves: ---</li>
<li>place these before each main section in markdown (usually "#" - which generates the HTML <code>&lt;h1&gt;</code> tag)</li>
</ul>
<h3 id="123-document-conventions"><a name="Documentconventions" href="#Documentconventions">1.2.3 Document conventions</a></h3>
<p>Keywords defined by this specification use <code>this monospaced font</code>.</p>
<p>Some sections of this specification are illustrated with non-normative examples.</p>
<div class="example">
<p>Example 1: text describing an example uses this paragraph style</p>
<pre><code>Non-normative examples use this paragraph style.</code></pre>
</div>
<p>All examples in this document are non-normative and informative only. Examples labeled with ⚠ contain advanced concepts or make use of keywords that are defined only later in the text, they can be skipped at first reading.</p>
<p>All other text is normative unless otherwise labeled.</p>
<div class="example">
<p>Here is a customized command line which will generate HTML from this markdown file (named <code>odata-csdl-json-v4.02-csd01.md</code>). Line breaks are added for readability only:</p>
<pre><code>pandoc -f gfm+tex_math_dollars+fenced_divs
-t html
-o odata-csdl-json-v4.02-csd01.html
-c styles/markdown-styles-v1.7.3b.css
-c styles/odata.css
-s
--mathjax
--eol=lf
--wrap=none
--metadata pagetitle=&quot;OData Common Schema Definition Language (CSDL) JSON Representation Version 4.02&quot;
odata-csdl-json-v4.02-csd01.md</code></pre>
<p>This uses pandoc 3.1.2 from <a href="https://github.com/jgm/pandoc/releases/tag/3.1.2">https://github.com/jgm/pandoc/releases/tag/3.1.2</a>.</p>
</div>
<hr />
<h1 id="2-section-heading">2 Section Heading</h1>
<p>text.</p>
Expand Down Expand Up @@ -309,13 +179,13 @@ <h6 id="odata-v402">[OData-v4.02]</h6>
<li><em>OData Version 4.02 Part 2: URL Conventions</em>. Latest stage. <a href="https://docs.oasis-open.org/odata/odata/v4.02/odata-v4.02-part2-url-conventions.html">https://docs.oasis-open.org/odata/odata/v4.02/odata-v4.02-part2-url-conventions.html</a></li>
</ul></li>
</ul>
<h5 id="rfc2119-1">[RFC2119]</h5>
<p>Bradner, S., "Key words for use in RFCs to Indicate Requirement Levels", BCP 14, RFC 2119, DOI 10.17487/RFC2119, March 1997, <a href="http://www.rfc-editor.org/info/rfc2119">http://www.rfc-editor.org/info/rfc2119</a>.</p>
<h6 id="rfc8174">[RFC8174]</h6>
<p>Leiba, B., "Ambiguity of Uppercase vs Lowercase in RFC 2119 Key Words", BCP 14, RFC 8174, DOI 10.17487/RFC8174, May 2017, <a href="http://www.rfc-editor.org/info/rfc8174">http://www.rfc-editor.org/info/rfc8174</a>.</p>
<h5 id="rfc2119"><a name="rfc2119">[RFC2119]</h5>
<p><em>Bradner, S., "Key words for use in RFCs to Indicate Requirement Levels", BCP 14, RFC 2119, DOI 10.17487/RFC2119, March 1997</em> <a href="http://www.rfc-editor.org/info/rfc2119">http://www.rfc-editor.org/info/rfc2119</a>.</p>
<h6 id="rfc8174"><a name="rfc8174">[RFC8174]</h6>
<p><em>Leiba, B., "Ambiguity of Uppercase vs Lowercase in RFC 2119 Key Words", BCP 14, RFC 8174, DOI 10.17487/RFC8174, May 2017</em> <a href="http://www.rfc-editor.org/info/rfc8174">http://www.rfc-editor.org/info/rfc8174</a>.</p>
<h2 id="a2-informative-references">A.2 Informative References</h2>
<h6 id="rfc3552">[RFC3552]</h6>
<p>Rescorla, E. and B. Korver, "Guidelines for Writing RFC Text on Security Considerations", BCP 72, RFC 3552, DOI 10.17487/RFC3552, July 2003, <a href="https://www.rfc-editor.org/info/rfc3552">https://www.rfc-editor.org/info/rfc3552</a>.</p>
<h6 id="rfc3552"><a name="rfc3552">[RFC3552]</h6>
<p><em>Rescorla, E. and B. Korver, "Guidelines for Writing RFC Text on Security Considerations", BCP 72, RFC 3552, DOI 10.17487/RFC3552, July 2003</em> <a href="https://www.rfc-editor.org/info/rfc3552">https://www.rfc-editor.org/info/rfc3552</a>.</p>
<hr />
<h1 id="appendix-b-safety-security-and-privacy-considerations">Appendix B. Safety, Security and Privacy Considerations</h1>
<!-- Optional section -->
Expand Down
Loading

0 comments on commit 7cdb5ca

Please sign in to comment.