Skip to content

Commit 40e660a

Browse files
authored
Add an appendix to the PDF archive (#898)
Move the XML reference to the end
1 parent 8745dbb commit 40e660a

6 files changed

Lines changed: 82 additions & 54 deletions

File tree

_data/sidebars/docs_sidebar.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -209,7 +209,7 @@ entries:
209209

210210
- title: XML reference
211211
url: /configuration-xml-reference.html
212-
output: web, pdf
212+
output: web
213213

214214
- title: Tooling
215215
output: web, pdf
Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
entries:
2+
- title: sidebar
3+
product: Appendix
4+
folders:
5+
6+
- title: >
7+
Appendix I: Configuration details
8+
output: pdf
9+
folderitems:
10+
11+
- title: XML reference
12+
url: /configuration-xml-reference.html
13+
output: pdf
Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
---
2+
layout: page_print
3+
permalink: appendix_part_title.html
4+
search: exclude
5+
---
6+
<div style="text-align: center; margin-top: 35vh; page-break-before: always;">
7+
<h1 style="font-size: 3.5em; font-weight: bold;">Appendix</h1>
8+
</div>

pdfconfigs/config_docs_pdf.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,3 +20,4 @@ defaults:
2020
pdf_sidebars:
2121
- docs_sidebar
2222
- tutorial_sidebar
23+
- pdf_appendix_sidebar

pdfconfigs/prince-list.txt

Lines changed: 22 additions & 49 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@ search: exclude
55

66
{% assign docs_sidebar = site.data.sidebars.docs_sidebar.entries %}
77
{% assign tutorial_sidebar = site.data.sidebars.tutorial_sidebar.entries %}
8+
{% assign pdf_appendix_sidebar = site.data.sidebars.pdf_appendix_sidebar.entries %}
89

910
{{site.url}}{{site.baseurl}}/titlepage.html
1011
{{site.url}}{{site.baseurl}}/tocpage.html
@@ -54,54 +55,26 @@ search: exclude
5455
{% endfor %}
5556
{% endfor %}
5657

58+
{{site.url}}{{site.baseurl}}/appendix_part_title.html
5759

58-
{% comment %}
59-
60-
{% assign sidebar = site.data.sidebars[page.sidebar].entries %}
61-
62-
{% for entry in sidebar %}
63-
{% for folder in entry.folders %}
64-
{% if folder.output contains "web" %}
65-
<li>
66-
<a href="#">{{ folder.title }}</a>
67-
<ul>
68-
{% for folderitem in folder.folderitems %}
69-
{% if folderitem.output contains "web" %}
70-
{% if folderitem.external_url %}
71-
<li><a href="{{folderitem.external_url}}" target="_blank" rel="noopener">{{folderitem.title}}</a></li>
72-
{% elsif page.url == folderitem.url %}
73-
<li class="active"><a href="{{folderitem.url | remove: "/"}}">{{folderitem.title}}</a></li>
74-
{% elsif folderitem.type == "empty" %}
75-
<li><a href="{{folderitem.url | remove: "/"}}">{{folderitem.title}}</a></li>
76-
77-
{% else %}
78-
<li><a href="{{folderitem.url | remove: "/"}}">{{folderitem.title}}</a></li>
79-
{% endif %}
80-
{% for subfolders in folderitem.subfolders %}
81-
{% if subfolders.output contains "web" %}
82-
<li class="subfolders">
83-
<a href="#">{{ subfolders.title }}</a>
84-
<ul>
85-
{% for subfolderitem in subfolders.subfolderitems %}
86-
{% if subfolderitem.output contains "web" %}
87-
{% if subfolderitem.external_url %}
88-
<li><a href="{{subfolderitem.external_url}}" target="_blank" rel="noopener">{{subfolderitem.title}}</a></li>
89-
{% elsif page.url == subfolderitem.url %}
90-
<li class="active"><a href="{{subfolderitem.url | remove: "/"}}">{{subfolderitem.title}}</a></li>
91-
{% else %}
92-
<li><a href="{{subfolderitem.url | remove: "/"}}">{{subfolderitem.title}}</a></li>
93-
{% endif %}
94-
{% endif %}
60+
{% for entry in pdf_appendix_sidebar %}
61+
{% for folder in entry.folders %}
62+
{% if folder.output contains "pdf" %}
63+
{% for folderitem in folder.folderitems %}
64+
{% if folderitem.output contains "pdf" %}
65+
{{site.url}}{{site.baseurl}}{{folderitem.url}}
66+
{% for subfolders in folderitem.subfolders %}
67+
{% if subfolders.output contains "pdf" %}
68+
{% for subfolderitem in subfolders.subfolderitems %}
69+
{% if subfolderitem.output contains "pdf" %}
70+
{{site.url}}{{site.baseurl}}{{subfolderitem.url}}
71+
{% endif %}
72+
{% endfor %}
73+
{% endif %}
74+
{% endfor %}
75+
{% endif %}
9576
{% endfor %}
96-
</ul>
97-
</li>
98-
{% endif %}
99-
{% endfor %}
100-
{% endif %}
101-
{% endfor %}
102-
</ul>
103-
</li>
104-
{% endif %}
105-
{% endfor %}
106-
{% endfor %}
107-
{% endcomment %}
77+
{% endif %}
78+
{% endfor %}
79+
{% endfor %}
80+

pdfconfigs/tocpage.html

Lines changed: 37 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,7 @@ <h1>Table of Contents</h1>
99

1010
{% assign docs_sidebar = site.data.sidebars.docs_sidebar.entries %}
1111
{% assign tutorial_sidebar = site.data.sidebars.tutorial_sidebar.entries %}
12+
{% assign pdf_appendix_sidebar = site.data.sidebars.pdf_appendix_sidebar.entries %}
1213

1314
<ul id="mysidebar" class="nav" style="columns:2">
1415

@@ -48,18 +49,50 @@ <h2 style="margin-top: 30px; padding-bottom: 5px; border-bottom: 1px solid #ccc;
4849

4950
{% for entry in tutorial_sidebar %}
5051
{% for folder in entry.folders %}
51-
{% if folder.output contains "web" and folder.type != "frontmatter" %}
52+
{% if folder.output contains "pdf" and folder.type != "frontmatter" %}
53+
<li class="sectionHead">{{ folder.title }}
54+
<ul>
55+
{% for folderitem in folder.folderitems %}
56+
{% if folderitem.output contains "pdf" and folderitem.type != "frontmatter"%}
57+
<li><a href="{{folderitem.url | prepend: site.baseurl}}">{{folderitem.title}}</a>
58+
{% for subfolders in folderitem.subfolders %}
59+
{% if subfolders.output contains "pdf" and subfolders.type != "frontmatter" %}
60+
<li class="subSectionHead"><span>{{ subfolders.title }}</span>
61+
<ul>
62+
{% for subfolderitem in subfolders.subfolderitems%}
63+
{% if subfolderitem.output contains "pdf" and subfolderitem.type != "frontmatter"%}
64+
<li><a href="{{subfolderitem.url | prepend: site.baseurl}}">{{subfolderitem.title}}</a></li>
65+
{% endif %}
66+
{% endfor %}
67+
</ul>
68+
</li>
69+
{% endif %}
70+
{% endfor %}
71+
</li>
72+
{% endif %}
73+
{% endfor %}
74+
</ul>
75+
</li>
76+
{% endif %}
77+
{% endfor %}
78+
{% endfor %}
79+
80+
<h2 style="margin-top: 30px; padding-bottom: 5px; border-bottom: 1px solid #ccc;">Appendix</h2>
81+
82+
{% for entry in pdf_appendix_sidebar %}
83+
{% for folder in entry.folders %}
84+
{% if folder.output contains "pdf" and folder.type != "frontmatter" %}
5285
<li class="sectionHead">{{ folder.title }}
5386
<ul>
5487
{% for folderitem in folder.folderitems %}
55-
{% if folderitem.output contains "web" and folderitem.type != "frontmatter"%}
88+
{% if folderitem.output contains "pdf" and folderitem.type != "frontmatter"%}
5689
<li><a href="{{folderitem.url | prepend: site.baseurl}}">{{folderitem.title}}</a>
5790
{% for subfolders in folderitem.subfolders %}
58-
{% if subfolders.output contains "web" and subfolders.type != "frontmatter" %}
91+
{% if subfolders.output contains "pdf" and subfolders.type != "frontmatter" %}
5992
<li class="subSectionHead"><span>{{ subfolders.title }}</span>
6093
<ul>
6194
{% for subfolderitem in subfolders.subfolderitems%}
62-
{% if subfolderitem.output contains "web" and subfolderitem.type != "frontmatter"%}
95+
{% if subfolderitem.output contains "pdf" and subfolderitem.type != "frontmatter"%}
6396
<li><a href="{{subfolderitem.url | prepend: site.baseurl}}">{{subfolderitem.title}}</a></li>
6497
{% endif %}
6598
{% endfor %}

0 commit comments

Comments
 (0)