Skip to content

Commit 3e6ae6f

Browse files
Committing current changes
Signed-off-by: Steve Springett <[email protected]>
1 parent 2681380 commit 3e6ae6f

File tree

4 files changed

+100
-53
lines changed

4 files changed

+100
-53
lines changed

docgen/json/templates/cyclonedx/base.html

Lines changed: 16 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@
2929
<body class="blue" data-spy="scroll" data-target=".js-scrollspy" onload="anchorOnLoad();" id="root">
3030

3131
<nav class="navbar fixed-top navbar-expand-sm navbar-inverse">
32-
<a href="https://cyclonedx.org" class="navbar-brand site-header__logo"><img src="https://cyclonedx.org/theme/assets/images/layout/logo-white.svg" width="150"></img></a>
32+
<a href="/" class="navbar-brand site-header__logo"><img src="https://cdx-staging.pages.dev/images/logo-all-white.svg" height="48" width="276"></img></a>
3333
<button class="navbar-toggler" type="button" data-toggle="collapse" data-target="#navbarScroll" aria-controls="navbarScroll" aria-expanded="false" aria-label="Toggle navigation">
3434
<span class="navbar-toggler-icon"></span>
3535
</button>
@@ -40,27 +40,27 @@
4040
v${version} (JSON)
4141
</a>
4242
<ul class="dropdown-menu" aria-labelledby="navbarScrollingDropdown">
43-
<li><a class="dropdown-item" href="https://cyclonedx.org/docs/1.6/json/">v1.6 (JSON)</a></li>
44-
<li><a class="dropdown-item" href="https://cyclonedx.org/docs/1.5/json/">v1.5 (JSON)</a></li>
45-
<li><a class="dropdown-item" href="https://cyclonedx.org/docs/1.4/json/">v1.4 (JSON)</a></li>
46-
<li><a class="dropdown-item" href="https://cyclonedx.org/docs/1.3/json/">v1.3 (JSON)</a></li>
47-
<li><a class="dropdown-item" href="https://cyclonedx.org/docs/1.2/json/">v1.2 (JSON)</a></li>
43+
<li><a class="dropdown-item" href="/docs/1.6/json/">v1.6 (JSON)</a></li>
44+
<li><a class="dropdown-item" href="/docs/1.5/json/">v1.5 (JSON)</a></li>
45+
<li><a class="dropdown-item" href="/docs/1.4/json/">v1.4 (JSON)</a></li>
46+
<li><a class="dropdown-item" href="/docs/1.3/json/">v1.3 (JSON)</a></li>
47+
<li><a class="dropdown-item" href="/docs/1.2/json/">v1.2 (JSON)</a></li>
4848
<li><hr class="dropdown-divider"/></li>
49-
<li><a class="dropdown-item" href="https://cyclonedx.org/docs/1.6/xml/">v1.6 (XML)</a></li>
50-
<li><a class="dropdown-item" href="https://cyclonedx.org/docs/1.5/xml/">v1.5 (XML)</a></li>
51-
<li><a class="dropdown-item" href="https://cyclonedx.org/docs/1.4/xml/">v1.4 (XML)</a></li>
52-
<li><a class="dropdown-item" href="https://cyclonedx.org/docs/1.3/xml/">v1.3 (XML)</a></li>
53-
<li><a class="dropdown-item" href="https://cyclonedx.org/docs/1.2/xml/">v1.2 (XML)</a></li>
54-
<li><a class="dropdown-item" href="https://cyclonedx.org/docs/1.1/xml/">v1.1 (XML)</a></li>
55-
<li><a class="dropdown-item" href="https://cyclonedx.org/docs/1.0/xml/">v1.0 (XML)</a></li>
49+
<li><a class="dropdown-item" href="/docs/1.6/xml/">v1.6 (XML)</a></li>
50+
<li><a class="dropdown-item" href="/docs/1.5/xml/">v1.5 (XML)</a></li>
51+
<li><a class="dropdown-item" href="/docs/1.4/xml/">v1.4 (XML)</a></li>
52+
<li><a class="dropdown-item" href="/docs/1.3/xml/">v1.3 (XML)</a></li>
53+
<li><a class="dropdown-item" href="/docs/1.2/xml/">v1.2 (XML)</a></li>
54+
<li><a class="dropdown-item" href="/docs/1.1/xml/">v1.1 (XML)</a></li>
55+
<li><a class="dropdown-item" href="/docs/1.0/xml/">v1.0 (XML)</a></li>
5656
</ul>
5757
</li>
5858
</ul>
5959
</div>
6060
</nav>
6161

6262

63-
<div class="container-fluid" style="margin-top:70px; margin-bottom:3rem">
63+
<div class="container-fluid" style="margin-top:110px; margin-bottom:3rem">
6464
<h1>${title}</h1>
6565

6666
{%- if title -%}
@@ -75,6 +75,7 @@ <h1>{{ title }}</h1>
7575

7676
{{ content(schema) }}
7777

78+
<!--
7879
<footer class="site-footer__copyright fixed-bottom">
7980
<div class="container">
8081
<div class="row">
@@ -84,6 +85,7 @@ <h1>{{ title }}</h1>
8485
</div>
8586
</div>
8687
</footer>
88+
-->
8789

8890
</body>
8991
</html>

docgen/json/templates/cyclonedx/content.html

Lines changed: 25 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -60,17 +60,37 @@
6060
{%- endif -%}
6161

6262
{# Enum and const #}
63-
{%- if schema.kw_enum -%}
63+
{%- if schema.kw_enum and schema.kw_meta_enum -%}
64+
<div class="enum-value" id="{{ schema.kw_enum.html_id }}">
65+
<h4>Must be one of:</h4>
66+
<table class="table table-striped table-bordered">
67+
<thead class="thead-dark">
68+
<tr>
69+
<th class="text-nowrap" scope="col">Name</th>
70+
<th scope="col">Description</th>
71+
</tr>
72+
</thead>
73+
<tbody>
74+
{%- for enum_choice in schema.kw_enum.array_items -%}
75+
<tr>
76+
<td class="text-nowrap">
77+
<strong>{{ enum_choice.literal | python_to_json }}</strong>
78+
</td>
79+
<td>
80+
{{ (schema.enum_description(enum_choice.literal) | get_description_literal) }}
81+
</td>
82+
</tr>
83+
{%- endfor -%}
84+
</tbody>
85+
</table>
86+
</div>
87+
{%- elif schema.kw_enum -%}
6488
<div class="enum-value" id="{{ schema.kw_enum.html_id }}">
6589
<h4>Must be one of:</h4>
6690
<ul class="list-group">
6791
{%- for enum_choice in schema.kw_enum.array_items -%}
6892
<li class="list-group-item enum-item">
69-
{%- if schema.kw_meta_enum -%}<strong>{%- endif -%}
7093
{{ enum_choice.literal | python_to_json }}
71-
{%- if schema.kw_meta_enum -%}</strong>
72-
: {{ (schema.enum_description(enum_choice.literal) | get_description_literal) }}
73-
{%- endif -%}
7494
</li>
7595
{%- endfor -%}
7696
</ul>

docgen/json/templates/cyclonedx/schema_doc.css

Lines changed: 12 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -4,32 +4,39 @@ body {
44
margin: 0;
55
padding: 0;
66
}
7+
.navbar {
8+
height: 90px;
9+
padding: 0;
10+
}
711
.navbar-inverse .navbar-nav>.open>a,
812
.navbar-inverse .navbar-nav>.open>a:focus,
913
.navbar-inverse .navbar-nav>.open>a:hover,
1014
.navbar-inverse {
11-
background-color: #071525;
15+
background-image: linear-gradient(269.12deg, rgba(232, 52, 82, 1) 0%, rgba(136, 38, 125, 1) 51.26%, rgba(52, 57, 175, 1) 100%);
1216
}
1317
.navbar-brand, .navbar-fixed-top {
14-
padding: 0 15px 0 15px;
18+
padding: 0 30px 0 30px;
1519
}
1620
.navbar-inverse .navbar-nav>li>a {
1721
color: #ffffff;
1822
}
1923
.site-header__logo img {
20-
height: 50px;
24+
height: 90px;
2125
}
2226
.version-selector {
2327
font-size: 1.2rem
2428
}
29+
.table .thead-dark th {
30+
background-color: #323550;
31+
}
2532
.container {
2633
margin-right: auto;
2734
margin-left: auto;
2835
padding-left: 15px;
2936
padding-right: 15px;
3037
}
3138
.container-fluid {
32-
padding: 15px 15px;
39+
padding: 30px 30px;
3340
}
3441
.site-footer__copyright {
3542
text-align: center;
@@ -45,7 +52,7 @@ body {
4552
padding-left: 30px !important;
4653
}
4754
h1, h2, h3, h4, h5, h6 {
48-
color: #23527c;
55+
color: rgb(52 57 175);
4956
}
5057
h1 {
5158
font-size: 36px;

docgen/xml/xs3p.xsl

Lines changed: 47 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -319,7 +319,7 @@
319319

320320
<script src="https://cdnjs.cloudflare.com/ajax/libs/markdown-it/8.3.2/markdown-it.min.js" type="text/javascript" charset="UTF-8"></script>
321321
</head>
322-
<body data-spy="scroll" data-target=".xs3p-sidebar" data-offset="65">
322+
<body data-spy="scroll" data-target=".xs3p-sidebar" data-offset="110">
323323

324324
<div class="navbar navbar-fixed-top navbar-inverse" role="navigation">
325325
<div class="container">
@@ -332,29 +332,31 @@
332332
<span class="icon-bar"><xsl:text> </xsl:text></span>
333333
</button>
334334
-->
335-
<a href="https://cyclonedx.org" class="navbar-brand site-header__logo"><img src="https://cyclonedx.org/theme/assets/images/layout/logo-white.svg" width="150" /></a>
335+
<a href="/" class="navbar-brand site-header__logo"><img src="https://cdx-staging.pages.dev/images/logo-all-white.svg" height="48" width="276" /></a>
336336

337337
<!-- Version selection dropdown -->
338+
<div style="display:flex; align-items:center; height:100%;">
338339
<ul class="nav navbar-nav navbar-right">
339340
<li class="dropdown">
340341
<a href="#" class="dropdown-toggle version-selector" data-toggle="dropdown" role="button" aria-haspopup="true" aria-expanded="false">v<xsl:value-of select="$cycloneDxVersion"/> (XML)<span class="caret"></span></a>
341342
<ul class="dropdown-menu">
342-
<li><a class="dropdown-item" href="https://cyclonedx.org/docs/1.6/json/">v1.6 (JSON)</a></li>
343-
<li><a class="dropdown-item" href="https://cyclonedx.org/docs/1.5/json/">v1.5 (JSON)</a></li>
344-
<li><a class="dropdown-item" href="https://cyclonedx.org/docs/1.4/json/">v1.4 (JSON)</a></li>
345-
<li><a class="dropdown-item" href="https://cyclonedx.org/docs/1.3/json/">v1.3 (JSON)</a></li>
346-
<li><a class="dropdown-item" href="https://cyclonedx.org/docs/1.2/json/">v1.2 (JSON)</a></li>
343+
<li><a class="dropdown-item" href="/docs/1.6/json/">v1.6 (JSON)</a></li>
344+
<li><a class="dropdown-item" href="/docs/1.5/json/">v1.5 (JSON)</a></li>
345+
<li><a class="dropdown-item" href="/docs/1.4/json/">v1.4 (JSON)</a></li>
346+
<li><a class="dropdown-item" href="/docs/1.3/json/">v1.3 (JSON)</a></li>
347+
<li><a class="dropdown-item" href="/docs/1.2/json/">v1.2 (JSON)</a></li>
347348
<li style="padding:0"><hr class="dropdown-divider"/></li>
348-
<li><a class="dropdown-item" href="https://cyclonedx.org/docs/1.6/xml/">v1.6 (XML)</a></li>
349-
<li><a class="dropdown-item" href="https://cyclonedx.org/docs/1.5/xml/">v1.5 (XML)</a></li>
350-
<li><a class="dropdown-item" href="https://cyclonedx.org/docs/1.4/xml/">v1.4 (XML)</a></li>
351-
<li><a class="dropdown-item" href="https://cyclonedx.org/docs/1.3/xml/">v1.3 (XML)</a></li>
352-
<li><a class="dropdown-item" href="https://cyclonedx.org/docs/1.2/xml/">v1.2 (XML)</a></li>
353-
<li><a class="dropdown-item" href="https://cyclonedx.org/docs/1.1/xml/">v1.1 (XML)</a></li>
354-
<li><a class="dropdown-item" href="https://cyclonedx.org/docs/1.0/xml/">v1.0 (XML)</a></li>
349+
<li><a class="dropdown-item" href="/docs/1.6/xml/">v1.6 (XML)</a></li>
350+
<li><a class="dropdown-item" href="/docs/1.5/xml/">v1.5 (XML)</a></li>
351+
<li><a class="dropdown-item" href="/docs/1.4/xml/">v1.4 (XML)</a></li>
352+
<li><a class="dropdown-item" href="/docs/1.3/xml/">v1.3 (XML)</a></li>
353+
<li><a class="dropdown-item" href="/docs/1.2/xml/">v1.2 (XML)</a></li>
354+
<li><a class="dropdown-item" href="/docs/1.1/xml/">v1.1 (XML)</a></li>
355+
<li><a class="dropdown-item" href="/docs/1.0/xml/">v1.0 (XML)</a></li>
355356
</ul>
356357
</li>
357358
</ul>
359+
</div>
358360

359361
</div>
360362
</div>
@@ -471,12 +473,12 @@
471473
if ($(".xs3p-sidebar").css("position") == "fixed" &amp;&amp; $(window).height() &lt; $(".xs3p-sidebar").height()) {
472474
var perc = $(window).scrollTop() / $("#xs3p-content").height();
473475
var overflow = $(".xs3p-sidebar").height() + 105 - $(window).height();
474-
$(".xs3p-sidebar").css("top", (65 - Math.round(overflow * perc)) + "px");
476+
$(".xs3p-sidebar").css("top", (110 - Math.round(overflow * perc)) + "px");
475477
}
476478
});
477479
$(window).resize(function() {
478480
if ($(".xs3p-sidebar").css("position") == "fixed") {
479-
$(".xs3p-sidebar").css("top", "65px");
481+
$(".xs3p-sidebar").css("top", "110px");
480482
}
481483
});
482484
</xsl:text>
@@ -753,34 +755,44 @@ body {
753755
}
754756

755757
.navbar {
756-
padding: 0.5rem 1rem;
758+
padding: 0;
759+
height: 90px;
757760
}
758761
.navbar-inverse .navbar-nav>.open>a,
759762
.navbar-inverse .navbar-nav>.open>a:focus,
760-
.navbar-inverse .navbar-nav>.open>a:hover,
763+
.navbar-inverse .navbar-nav>.open>a:hover {
764+
background-image: none;
765+
background-color: transparent;
766+
}
761767
.navbar-inverse {
762-
background-color: #071525;
768+
background-image: linear-gradient(269.12deg, rgba(232, 52, 82, 1) 0%, rgba(136, 38, 125, 1) 51.26%, rgba(52, 57, 175, 1) 100%);
763769
}
764770
.navbar-brand {
765771
display: inline-block;
766772
margin-right: 1rem;
767773
font-size: 1.25rem;
768774
line-height: inherit;
769775
white-space: nowrap;
770-
padding: 0 15px 0 15px;
776+
padding: 0 30px 0 30px;
777+
}
778+
.navbar-header {
779+
height: 100%;
771780
}
772781
.navbar-fixed-top {
773-
padding: 8px 15px 8px 15px;
782+
774783
}
775784
.navbar-inverse .navbar-nav>li>a {
776785
color: #ffffff;
777786
}
778787
.site-header__logo img {
779-
height: 50px;
788+
height: 90px;
780789
}
781790
.version-selector {
782791
font-size: 1.6rem
783792
}
793+
.table .thead-dark th {
794+
background-color: #323550;
795+
}
784796
.version-selector .caret {
785797
border-left: 8px solid transparent;
786798
border-right: 8px solid transparent;
@@ -794,38 +806,44 @@ body {
794806
padding: 6px 20px;
795807
line-height: 1.42857143;
796808
}
797-
809+
h1, h2, h3, h4, h5, h6 {
810+
color: rgb(52 57 175) !important;
811+
}
812+
h1 a, h2 a, h3 a, h4 a, h5 a, h6 a {
813+
color: rgb(52 57 175) !important;
814+
}
798815
code {
799816
color: #333;
800817
}
801818

802819
.container {
820+
height: 100%;
803821
margin-left: 0;
804822
margin-right: 0;
805823
}
806824

807825
.container-fluid {
808-
padding: 15px 15px;
826+
padding: 30px 30px;
809827
}
810828

811829
.nav-sub-item &gt; a {
812830
padding-left: 30px !important;
813831
}
814832

815833
a {
816-
color: #1e4877;
834+
color: #2157c4;
817835
}
818836
a.name {
819-
padding-top: 65px;
837+
padding-top: 110px;
820838
}
821839

822840
h3.xs3p-subsection-heading {
823841
margin-bottom: 30px;
824842
}
825843

826844
section, #top {
827-
margin-top: -65px;
828-
padding-top: 65px;
845+
margin-top: -110px;
846+
padding-top: 110px;
829847
}
830848

831849
pre {
@@ -907,7 +925,7 @@ pre {
907925
@media (min-width: 992px) {
908926
.xs3p-sidebar {
909927
position: fixed;
910-
top: 65px;
928+
top: 110px;
911929
width: 22%;
912930
}
913931
}

0 commit comments

Comments
 (0)