Skip to content

Commit 0311a63

Browse files
author
Kasper Peeters
committed
Make manual pages overview more readable.
1 parent 570377c commit 0311a63

File tree

6 files changed

+59
-9
lines changed

6 files changed

+59
-9
lines changed

Makefile

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,19 +2,22 @@
22
all:
33
@echo -n "\nTo build Cadabra, \n\n mkdir build\n cd build\n cmake ..\n make\n\nThe other targets here are (for maintainer purposes only)\n\n tarball: build a tarball cadabra2-latest.tar.gz of current HEAD\n doc: generate doxygen docs in doc\n webup: build web pages/tutorials/man pages and upload to server\n updatesnoop: sync snoop repo\n packages: create deb/rpm packages on buildbot\n\nIf you need help, email [email protected]\n\n"
44

5-
.PHONY: doc webup
5+
.PHONY: doc tarball claybuild webup format packages updatesnoop
66

77
tarball:
88
git archive --format=tar --prefix=cadabra2-latest/ HEAD | gzip > ${HOME}/tmp/cadabra2-latest.tar.gz
99

1010
doc:
1111
doxygen config/Doxyfile
1212

13-
webup:
13+
claybuild:
14+
cd web2/cadabra2/source; rm -Rf build; clay build
15+
16+
webup: claybuild
1417
cd build; make -f web2/Makefile
1518
doxygen config/Doxyfile
1619
rsync -avz --chmod=+rx doxygen/ cadabra_web:/var/www/cadabra2/doxygen/
17-
cd web2/cadabra2/source; clay build; rsync -avz --chmod=+rx build/ cadabra_web:/var/www/cadabra2/; rsync -avz --chmod=+rx static/styles/ cadabra_web:/var/www/cadabra2/static/styles; rsync -avz --chmod=+rx static/fonts/ cadabra_web:/var/www/cadabra2/static/fonts; rsync -avz --chmod=+rx static/images/ cadabra_web:/var/www/cadabra2/static/images/; rsync -avz --chmod=+rx static/icons/ cadabra_web:/var/www/cadabra2/static/icons/; rsync -avz --chmod=+rx static/pdf/ cadabra_web:/var/www/cadabra2/static/pdf/; rsync -avz --chmod=+rx static/scripts/ cadabra_web:/var/www/cadabra2/static/scripts/; rsync -avz --chmod=+r static/robots.txt cadabra_web:/var/www/cadabra2
20+
cd web2/cadabra2/source; rsync -avz --chmod=+rx build/ cadabra_web:/var/www/cadabra2/; rsync -avz --chmod=+rx static/styles/ cadabra_web:/var/www/cadabra2/static/styles; rsync -avz --chmod=+rx static/fonts/ cadabra_web:/var/www/cadabra2/static/fonts; rsync -avz --chmod=+rx static/images/ cadabra_web:/var/www/cadabra2/static/images/; rsync -avz --chmod=+rx static/icons/ cadabra_web:/var/www/cadabra2/static/icons/; rsync -avz --chmod=+rx static/pdf/ cadabra_web:/var/www/cadabra2/static/pdf/; rsync -avz --chmod=+rx static/scripts/ cadabra_web:/var/www/cadabra2/static/scripts/; rsync -avz --chmod=+r static/robots.txt cadabra_web:/var/www/cadabra2
1821

1922
format:
2023
astyle --style=k/r --indent=tab=3 --recursive --attach-classes --attach-namespaces --indent-classes --indent-namespaces --indent-switches --break-closing-braces '*.hh'

web2/cadabra2/source/layout.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -208,6 +208,6 @@
208208
"logo": "https://cadabra.science/static/icons/cadabra2.png"
209209
}
210210
</script>
211-
211+
<script type="text/javascript" src="/static/js/cadabra.js"></script>
212212
</body>
213213
</html>

web2/cadabra2/source/man.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ <h2>Packages</h2>
2727
the usual Python way with <code>import</code>. Their content is
2828
listed below.
2929
</p>
30-
<table>
30+
<table class="package-toc-table">
3131
{% include "packages_toc.html" %}
3232
</table>
3333

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
var x = document.getElementsByClassName("folding");
2+
var i;
3+
for (i = 0; i < x.length; i++) {
4+
console.log(x[i]);
5+
x[i].onclick = function(el) {
6+
if(el.currentTarget.classList.contains('uncovered')) {
7+
el.currentTarget.classList.remove('uncovered');
8+
} else {
9+
el.currentTarget.classList.add('uncovered');
10+
}
11+
}
12+
}
13+
14+

web2/cadabra2/source/static/styles/cadabra-web.css

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -182,6 +182,39 @@ div#main h3 {
182182
color: green;
183183
font-size: 16px;
184184
}
185+
table.package-toc-table {
186+
border-spacing: 0px;
187+
}
188+
.package-toc-table .package-name {
189+
height: 2em;
190+
vertical-align: bottom;
191+
font-family: "Bree Serif";
192+
font-weight: normal;
193+
color: green;
194+
font-size: 16px;
195+
cursor: pointer;
196+
}
197+
.package-toc-table tr td:first-child {
198+
min-width: 30px;
199+
}
200+
.package-toc-table .package-desc {
201+
height: 2em;
202+
vertical-align: top;
203+
}
204+
.package-toc-table tr:not(:nth-child(1)):not(:nth-child(2)) {
205+
transform: scale(1, 0);
206+
line-height: 0px;
207+
transition: transform .5s, line-height .5s;
208+
visibility: none;
209+
}
210+
.package-toc-table tr:not(:nth-child(1)):not(:nth-child(2)) {
211+
padding: 0px;
212+
}
213+
.package-toc-table tbody.uncovered tr:not(:nth-child(1)):not(:nth-child(2)) {
214+
transform: scale(1, 1);
215+
line-height: 1.5em;
216+
}
217+
185218
.latex_view h3 {
186219
margin-left: 0px !important;
187220
}

web2/scan.py

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -40,9 +40,9 @@ def scan_file(prevcat, dir, filename, ext):
4040
is_multi = (package_name!="")
4141

4242
if is_multi:
43-
print('<h3>'+package_name+'</h3>')
44-
print('<p>'+package_desc+'</p>')
45-
print('<table>')
43+
print('<tbody class="folding">')
44+
print('<tr class="package-name"><td colspan=4">'+package_name+'</td></tr>')
45+
print('<tr class="package-desc"><td colspan=4>'+package_desc+'</td></tr>')
4646

4747
for cell in data["cells"]:
4848
if not "cells" in cell:
@@ -80,7 +80,7 @@ def scan_file(prevcat, dir, filename, ext):
8080
print('<td>'+desc+'</td></tr>')
8181

8282
if is_multi:
83-
print('</table>')
83+
print('<tr><td colspan=4>&nbsp;</td></tr></tbody>')
8484

8585
return prevcat
8686

0 commit comments

Comments
 (0)