Skip to content

Commit b8c2bcd

Browse files
authored
Fix sidebar scroll again and add missing footer back (#1154)
* Add missing footers In #1152 the footer partial was only added to the index.rhtml file. This commit adds the footer partial to the other template files. * Remove unnecessary middle divs in nav * Simplify sidebar's overflow settings Because sidebar needs to be scrollable, its overflow should default to auto. Currently it's set to hidden and force individual elements to set overflow auto, which overcomplicates things.
1 parent 6abf596 commit b8c2bcd

File tree

8 files changed

+24
-30
lines changed

8 files changed

+24
-30
lines changed

lib/rdoc/generator/template/darkfish/class.rhtml

+6-7
Original file line numberDiff line numberDiff line change
@@ -8,14 +8,13 @@
88
</div>
99

1010
<%= render '_sidebar_table_of_contents.rhtml' %>
11+
<%= render '_sidebar_sections.rhtml' %>
12+
<%= render '_sidebar_parent.rhtml' %>
13+
<%= render '_sidebar_includes.rhtml' %>
14+
<%= render '_sidebar_extends.rhtml' %>
15+
<%= render '_sidebar_methods.rhtml' %>
1116

12-
<div id="class-metadata">
13-
<%= render '_sidebar_sections.rhtml' %>
14-
<%= render '_sidebar_parent.rhtml' %>
15-
<%= render '_sidebar_includes.rhtml' %>
16-
<%= render '_sidebar_extends.rhtml' %>
17-
<%= render '_sidebar_methods.rhtml' %>
18-
</div>
17+
<%= render '_footer.rhtml' %>
1918
</nav>
2019

2120
<main role="main" aria-labelledby="<%=h klass.aref %>">

lib/rdoc/generator/template/darkfish/css/rdoc.css

+2-7
Original file line numberDiff line numberDiff line change
@@ -212,7 +212,7 @@ nav {
212212
position: fixed;
213213
top: 0;
214214
bottom: 0;
215-
overflow: hidden;
215+
overflow: auto;
216216
z-index: 10;
217217

218218
/* Layout */
@@ -228,11 +228,6 @@ nav[hidden] {
228228
display: none;
229229
}
230230

231-
nav #project-metadata {
232-
overflow: auto; /* Make the content scrollable */
233-
flex: 1; /* Take up remaining space */
234-
}
235-
236231
nav footer {
237232
padding: 1em;
238233
border-top: 1px solid #ccc;
@@ -286,7 +281,7 @@ nav .nav-section {
286281
margin-top: 2em;
287282
border-top: 2px solid #aaa;
288283
font-size: 90%;
289-
overflow: hidden;
284+
flex: 1;
290285
}
291286

292287
nav h2 {

lib/rdoc/generator/template/darkfish/index.rhtml

+2-5
Original file line numberDiff line numberDiff line change
@@ -4,14 +4,11 @@
44
<nav id="navigation" role="navigation">
55
<div id="project-navigation">
66
<%= render '_sidebar_navigation.rhtml' %>
7-
87
<%= render '_sidebar_search.rhtml' %>
98
</div>
109

11-
<div id="project-metadata">
12-
<%= render '_sidebar_pages.rhtml' %>
13-
<%= render '_sidebar_classes.rhtml' %>
14-
</div>
10+
<%= render '_sidebar_pages.rhtml' %>
11+
<%= render '_sidebar_classes.rhtml' %>
1512

1613
<%= render '_footer.rhtml' %>
1714
</nav>

lib/rdoc/generator/template/darkfish/page.rhtml

+2-3
Original file line numberDiff line numberDiff line change
@@ -8,10 +8,9 @@
88
</div>
99

1010
<%= render '_sidebar_table_of_contents.rhtml' %>
11+
<%= render '_sidebar_pages.rhtml' %>
1112

12-
<div id="project-metadata">
13-
<%= render '_sidebar_pages.rhtml' %>
14-
</div>
13+
<%= render '_footer.rhtml' %>
1514
</nav>
1615

1716
<main role="main" aria-label="Page <%=h file.full_name%>">

lib/rdoc/generator/template/darkfish/servlet_not_found.rhtml

+7-6
Original file line numberDiff line numberDiff line change
@@ -2,14 +2,15 @@
22
<%= render '_sidebar_toggle.rhtml' %>
33

44
<nav id="navigation" role="navigation">
5-
<%= render '_sidebar_navigation.rhtml' %>
5+
<div id="project-navigation">
6+
<%= render '_sidebar_navigation.rhtml' %>
7+
<%= render '_sidebar_search.rhtml' %>
8+
</div>
69

7-
<%= render '_sidebar_search.rhtml' %>
10+
<%= render '_sidebar_pages.rhtml' %>
11+
<%= render '_sidebar_classes.rhtml' %>
812

9-
<div id="project-metadata">
10-
<%= render '_sidebar_pages.rhtml' %>
11-
<%= render '_sidebar_classes.rhtml' %>
12-
</div>
13+
<%= render '_footer.rhtml' %>
1314
</nav>
1415

1516
<main role="main">

lib/rdoc/generator/template/darkfish/servlet_root.rhtml

+2-1
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,8 @@
1212
<%= render '_sidebar_search.rhtml' %>
1313
</div>
1414

15-
<%= render '_sidebar_installed.rhtml' %>
15+
<%= render '_sidebar_installed.rhtml' %>
16+
<%= render '_footer.rhtml' %>
1617
</nav>
1718

1819
<main role="main">

lib/rdoc/generator/template/darkfish/table_of_contents.rhtml

+2
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,8 @@
77

88
<%= render '_sidebar_search.rhtml' %>
99
</div>
10+
11+
<%= render '_footer.rhtml' %>
1012
</nav>
1113
<main role="main">
1214
<h1 class="class"><%= h @title %></h1>

test/rdoc/test_rdoc_generator_darkfish.rb

+1-1
Original file line numberDiff line numberDiff line change
@@ -115,7 +115,7 @@ def test_generate
115115
assert_match(%r[Klass/Inner\.html".*>Inner<], summary)
116116

117117
klass = File.binread('Klass.html')
118-
klassnav = klass[%r[<div class="nav-section">.*<div id="class-metadata">]m]
118+
klassnav = klass[%r[<div class="nav-section">.*]m]
119119
assert_match(
120120
%r[<li>\s*<details open>\s*<summary>\s*<a href=\S+>Heading 1</a>\s*</summary>\s*<ul]m,
121121
klassnav

0 commit comments

Comments
 (0)