Skip to content

Commit 275f3ee

Browse files
committed
Merge branch 'dev' into 'master'
Updates for v1.1 Closes #25 and #24 See merge request archlinux/archmanweb!27
2 parents d176ecc + a24d523 commit 275f3ee

File tree

12 files changed

+310
-138
lines changed

12 files changed

+310
-138
lines changed

README.md

Lines changed: 71 additions & 71 deletions
Original file line numberDiff line numberDiff line change
@@ -54,8 +54,8 @@ our requirements:
5454
2. Functionality does not require Javascript.
5555
3. Pages are addressable by their name and section, both occurring exactly once
5656
in the URL to avoid problems with pages such as
57-
[ar(1)](https://jlk.fjfi.cvut.cz/arch/manpages/man/ar.1) and
58-
[ar(1p)](https://jlk.fjfi.cvut.cz/arch/manpages/man/ar.1p).
57+
[ar(1)](https://man.archlinux.org/man/ar.1) and
58+
[ar(1p)](https://man.archlinux.org/man/ar.1p).
5959
4. The URLs used by the _man_ template should not redirect to permalinks,
6060
otherwise users would start copy-pasting them to the wiki and it would be
6161
hard to check if they are the same as the canonical URLs.
@@ -83,7 +83,7 @@ rebuilding the whole website from scratch:
8383
- Links to other versions of the same manual provided by different packages.
8484
- Links to similar manuals available in other sections or languages.
8585
- Searching in the names and descriptions of packages and manuals, similarly to
86-
[apropos(1)](https://jlk.fjfi.cvut.cz/arch/manpages/about).
86+
[apropos(1)](https://man.archlinux.org/man/apropos.1).
8787

8888
### Similar projects
8989

@@ -103,96 +103,96 @@ are not useful to regular users.
103103

104104
### URLs with dots
105105

106-
- <a href="https://jlk.fjfi.cvut.cz/arch/manpages/man/intro">intro</a>
107-
- <a href="https://jlk.fjfi.cvut.cz/arch/manpages/man/intro.1">intro.1</a>
108-
- <a href="https://jlk.fjfi.cvut.cz/arch/manpages/man/intro.1.en">intro.1.en</a>
109-
- <a href="https://jlk.fjfi.cvut.cz/arch/manpages/man/intro.en">intro.en</a>
110-
- <a href="https://jlk.fjfi.cvut.cz/arch/manpages/man/systemd.service">systemd.service</a>
111-
- <a href="https://jlk.fjfi.cvut.cz/arch/manpages/man/systemd.service.5">systemd.service.5</a>
112-
- <a href="https://jlk.fjfi.cvut.cz/arch/manpages/man/systemd.service.5.en">systemd.service.5.en</a>
113-
- <a href="https://jlk.fjfi.cvut.cz/arch/manpages/man/systemd.service.en">systemd.service.en</a>
114-
- <a href="https://jlk.fjfi.cvut.cz/arch/manpages/man/gimp-2.8">gimp-2.8</a>
115-
- <a href="https://jlk.fjfi.cvut.cz/arch/manpages/man/gimp-2.8.1">gimp-2.8.1</a>
116-
- <a href="https://jlk.fjfi.cvut.cz/arch/manpages/man/gimp-2.8.1.en">gimp-2.8.1.en</a>
117-
- <a href="https://jlk.fjfi.cvut.cz/arch/manpages/man/gimp-2.8.en">gimp-2.8.en</a>
118-
- <a href="https://jlk.fjfi.cvut.cz/arch/manpages/man/CA.pl">CA.pl</a>
119-
- <a href="https://jlk.fjfi.cvut.cz/arch/manpages/man/CA.pl.1ssl">CA.pl.1ssl</a>
120-
- <a href="https://jlk.fjfi.cvut.cz/arch/manpages/man/CA.pl.1ssl.en">CA.pl.1ssl.en</a>
121-
- <a href="https://jlk.fjfi.cvut.cz/arch/manpages/man/CA.pl.en">CA.pl.en</a>
106+
- <a href="https://man.archlinux.org/man/intro">intro</a>
107+
- <a href="https://man.archlinux.org/man/intro.1">intro.1</a>
108+
- <a href="https://man.archlinux.org/man/intro.1.en">intro.1.en</a>
109+
- <a href="https://man.archlinux.org/man/intro.en">intro.en</a>
110+
- <a href="https://man.archlinux.org/man/systemd.service">systemd.service</a>
111+
- <a href="https://man.archlinux.org/man/systemd.service.5">systemd.service.5</a>
112+
- <a href="https://man.archlinux.org/man/systemd.service.5.en">systemd.service.5.en</a>
113+
- <a href="https://man.archlinux.org/man/systemd.service.en">systemd.service.en</a>
114+
- <a href="https://man.archlinux.org/man/gimp-2.8">gimp-2.8</a>
115+
- <a href="https://man.archlinux.org/man/gimp-2.8.1">gimp-2.8.1</a>
116+
- <a href="https://man.archlinux.org/man/gimp-2.8.1.en">gimp-2.8.1.en</a>
117+
- <a href="https://man.archlinux.org/man/gimp-2.8.en">gimp-2.8.en</a>
118+
- <a href="https://man.archlinux.org/man/CA.pl">CA.pl</a>
119+
- <a href="https://man.archlinux.org/man/CA.pl.1ssl">CA.pl.1ssl</a>
120+
- <a href="https://man.archlinux.org/man/CA.pl.1ssl.en">CA.pl.1ssl.en</a>
121+
- <a href="https://man.archlinux.org/man/CA.pl.en">CA.pl.en</a>
122122

123123
### Best match lookup
124124

125125
Ambiguous cases are ordered by section, package repository and package version,
126126
then the first manual is selected.
127127

128-
- <a href="https://jlk.fjfi.cvut.cz/arch/manpages/man/mount">mount</a> redirects to
129-
<a href="https://jlk.fjfi.cvut.cz/arch/manpages/man/mount.8">mount.8</a>
130-
(not <a href="https://jlk.fjfi.cvut.cz/arch/manpages/man/mount.2">mount.2</a>)
131-
- <a href="https://jlk.fjfi.cvut.cz/arch/manpages/man/gv">gv</a> redirects to
132-
<a href="https://jlk.fjfi.cvut.cz/arch/manpages/man/gv.1">gv.1</a>
133-
(not <a href="https://jlk.fjfi.cvut.cz/arch/manpages/man/gv.3guile">gv.3guile</a>,
134-
<a href="https://jlk.fjfi.cvut.cz/arch/manpages/man/gv.3lua">gv.3lua</a> etc.)
135-
- <a href="https://jlk.fjfi.cvut.cz/arch/manpages/man/graphviz/gv">graphviz/gv</a> redirects to
136-
<a href="https://jlk.fjfi.cvut.cz/arch/manpages/man/graphviz/gv.3guile">graphviz/gv.3guile</a>
137-
(not <a href="https://jlk.fjfi.cvut.cz/arch/manpages/man/graphviz/gv.3lua">graphviz/gv.3lua</a> etc.)
138-
- <a href="https://jlk.fjfi.cvut.cz/arch/manpages/man/gv.3">gv.3</a> redirects to
139-
<a href="https://jlk.fjfi.cvut.cz/arch/manpages/man/gv.3guile">gv.3guile</a>
140-
(not <a href="https://jlk.fjfi.cvut.cz/arch/manpages/man/gv.1">gv.1</a>,
141-
<a href="https://jlk.fjfi.cvut.cz/arch/manpages/man/gv.3lua">gv.3lua</a> etc.)
142-
- <a href="https://jlk.fjfi.cvut.cz/arch/manpages/man/aliases.5">aliases.5</a> displays
143-
<a href="https://jlk.fjfi.cvut.cz/arch/manpages/man/extra/postfix/aliases.5">extra/postfix/aliases.5</a>
144-
(not <a href="https://jlk.fjfi.cvut.cz/arch/manpages/man/community/opensmtpd/aliases.5">community/opensmtpd/aliases.5</a>)
145-
- <a href="https://jlk.fjfi.cvut.cz/arch/manpages/man/mysqld.8">mysqld.8</a> displays
146-
<a href="https://jlk.fjfi.cvut.cz/arch/manpages/man/extra/mariadb/mysqld.8">extra/mariadb/mysqld.8</a>
147-
(not <a href="https://jlk.fjfi.cvut.cz/arch/manpages/man/community/percona-server/mysqld.8">community/percona-server/mysqld.8</a>)
148-
- <a href="https://jlk.fjfi.cvut.cz/arch/manpages/man/mailx">mailx</a> and
149-
<a href="https://jlk.fjfi.cvut.cz/arch/manpages/man/mailx.1">mailx.1</a> redirect to
150-
<a href="https://jlk.fjfi.cvut.cz/arch/manpages/man/mail.1.en">mail.1.en</a> as a symbolic link
151-
(not <a href="https://jlk.fjfi.cvut.cz/arch/manpages/man/mailx.1p">mailx.1p</a>)
128+
- <a href="https://man.archlinux.org/man/mount">mount</a> redirects to
129+
<a href="https://man.archlinux.org/man/mount.8">mount.8</a>
130+
(not <a href="https://man.archlinux.org/man/mount.2">mount.2</a>)
131+
- <a href="https://man.archlinux.org/man/gv">gv</a> redirects to
132+
<a href="https://man.archlinux.org/man/gv.1">gv.1</a>
133+
(not <a href="https://man.archlinux.org/man/gv.3guile">gv.3guile</a>,
134+
<a href="https://man.archlinux.org/man/gv.3lua">gv.3lua</a> etc.)
135+
- <a href="https://man.archlinux.org/man/graphviz/gv">graphviz/gv</a> redirects to
136+
<a href="https://man.archlinux.org/man/graphviz/gv.3guile">graphviz/gv.3guile</a>
137+
(not <a href="https://man.archlinux.org/man/graphviz/gv.3lua">graphviz/gv.3lua</a> etc.)
138+
- <a href="https://man.archlinux.org/man/gv.3">gv.3</a> redirects to
139+
<a href="https://man.archlinux.org/man/gv.3guile">gv.3guile</a>
140+
(not <a href="https://man.archlinux.org/man/gv.1">gv.1</a>,
141+
<a href="https://man.archlinux.org/man/gv.3lua">gv.3lua</a> etc.)
142+
- <a href="https://man.archlinux.org/man/aliases.5">aliases.5</a> displays
143+
<a href="https://man.archlinux.org/man/extra/postfix/aliases.5">extra/postfix/aliases.5</a>
144+
(not <a href="https://man.archlinux.org/man/community/opensmtpd/aliases.5">community/opensmtpd/aliases.5</a>)
145+
- <a href="https://man.archlinux.org/man/mysqld.8">mysqld.8</a> displays
146+
<a href="https://man.archlinux.org/man/extra/mariadb/mysqld.8">extra/mariadb/mysqld.8</a>
147+
(not <a href="https://man.archlinux.org/man/community/percona-server/mysqld.8">community/percona-server/mysqld.8</a>)
148+
- <a href="https://man.archlinux.org/man/mailx">mailx</a> and
149+
<a href="https://man.archlinux.org/man/mailx.1">mailx.1</a> redirect to
150+
<a href="https://man.archlinux.org/man/mail.1.en">mail.1.en</a> as a symbolic link
151+
(not <a href="https://man.archlinux.org/man/mailx.1p">mailx.1p</a>)
152152

153153
### Language fallback
154154

155-
- <a href="https://jlk.fjfi.cvut.cz/arch/manpages/man/nvidia-smi.cs">nvidia-smi.cs</a> &rarr;
156-
<a href="https://jlk.fjfi.cvut.cz/arch/manpages/man/nvidia-smi.en">nvidia-smi.en</a> &rarr;
157-
<a href="https://jlk.fjfi.cvut.cz/arch/manpages/man/nvidia-smi.1.en">nvidia-smi.1.en</a>
155+
- <a href="https://man.archlinux.org/man/nvidia-smi.cs">nvidia-smi.cs</a> &rarr;
156+
<a href="https://man.archlinux.org/man/nvidia-smi.en">nvidia-smi.en</a> &rarr;
157+
<a href="https://man.archlinux.org/man/nvidia-smi.1.en">nvidia-smi.1.en</a>
158158
(maybe we should try harder and avoid the double redirect)
159-
- <a href="https://jlk.fjfi.cvut.cz/arch/manpages/man/nvidia-smi.1.cs">nvidia-smi.1.cs</a> &rarr;
160-
<a href="https://jlk.fjfi.cvut.cz/arch/manpages/man/nvidia-smi.1.en">nvidia-smi.1.en</a>
161-
- <a href="https://jlk.fjfi.cvut.cz/arch/manpages/man/nvidia-smi.foo">nvidia-smi.foo</a> &rarr; 404
162-
- <a href="https://jlk.fjfi.cvut.cz/arch/manpages/man/nvidia-smi.1.foo">nvidia-smi.1.foo</a> &rarr; 404
159+
- <a href="https://man.archlinux.org/man/nvidia-smi.1.cs">nvidia-smi.1.cs</a> &rarr;
160+
<a href="https://man.archlinux.org/man/nvidia-smi.1.en">nvidia-smi.1.en</a>
161+
- <a href="https://man.archlinux.org/man/nvidia-smi.foo">nvidia-smi.foo</a> &rarr; 404
162+
- <a href="https://man.archlinux.org/man/nvidia-smi.1.foo">nvidia-smi.1.foo</a> &rarr; 404
163163

164164
### Package filter
165165

166-
- <a href="https://jlk.fjfi.cvut.cz/arch/manpages/man/nvidia-utils/nvidia-smi.en">nvidia-utils/nvidia-smi.en</a>
167-
- <a href="https://jlk.fjfi.cvut.cz/arch/manpages/man/nvidia-340xx-utils/nvidia-smi.en">nvidia-340xx-utils/nvidia-smi.en</a>
168-
- <a href="https://jlk.fjfi.cvut.cz/arch/manpages/man/nvidia-utils/nvidia-smi.cs">nvidia-utils/nvidia-smi.cs</a> &rarr;
169-
<a href="https://jlk.fjfi.cvut.cz/arch/manpages/man/nvidia-utils/nvidia-smi.en">nvidia-utils/nvidia-smi.en</a>
170-
- <a href="https://jlk.fjfi.cvut.cz/arch/manpages/man/nvidia-340xx-utils/nvidia-smi.cs">nvidia-340xx-utils/nvidia-smi.cs</a> &rarr;
171-
<a href="https://jlk.fjfi.cvut.cz/arch/manpages/man/nvidia-340xx-utils/nvidia-smi.cs">nvidia-utils/nvidia-340xx-smi.en</a>
172-
- <a href="https://jlk.fjfi.cvut.cz/arch/manpages/man/foo/nvidia-smi.cs">foo/nvidia-smi.cs</a> &rarr; 404
173-
- <a href="https://jlk.fjfi.cvut.cz/arch/manpages/man/foo/nvidia-smi.en">foo/nvidia-smi.en</a> &rarr; 404
166+
- <a href="https://man.archlinux.org/man/nvidia-utils/nvidia-smi.en">nvidia-utils/nvidia-smi.en</a>
167+
- <a href="https://man.archlinux.org/man/nvidia-340xx-utils/nvidia-smi.en">nvidia-340xx-utils/nvidia-smi.en</a>
168+
- <a href="https://man.archlinux.org/man/nvidia-utils/nvidia-smi.cs">nvidia-utils/nvidia-smi.cs</a> &rarr;
169+
<a href="https://man.archlinux.org/man/nvidia-utils/nvidia-smi.en">nvidia-utils/nvidia-smi.en</a>
170+
- <a href="https://man.archlinux.org/man/nvidia-340xx-utils/nvidia-smi.cs">nvidia-340xx-utils/nvidia-smi.cs</a> &rarr;
171+
<a href="https://man.archlinux.org/man/nvidia-340xx-utils/nvidia-smi.cs">nvidia-utils/nvidia-340xx-smi.en</a>
172+
- <a href="https://man.archlinux.org/man/foo/nvidia-smi.cs">foo/nvidia-smi.cs</a> &rarr; 404
173+
- <a href="https://man.archlinux.org/man/foo/nvidia-smi.en">foo/nvidia-smi.en</a> &rarr; 404
174174

175175
### .so macros
176176

177-
There is a <a href="https://jlk.fjfi.cvut.cz/arch/manpages/man/groff.1">groff(1)</a> extension for the
178-
<a href="https://jlk.fjfi.cvut.cz/arch/manpages/man/man.7">man(7)</a> and
179-
<a href="https://jlk.fjfi.cvut.cz/arch/manpages/man/mdoc.7">mdoc(7)</a>
177+
There is a <a href="https://man.archlinux.org/man/groff.1">groff(1)</a> extension for the
178+
<a href="https://man.archlinux.org/man/man.7">man(7)</a> and
179+
<a href="https://man.archlinux.org/man/mdoc.7">mdoc(7)</a>
180180
languages to include contents of other files using the `.so` macro. In normal
181181
operation where manuals are stored as files on a file system, the
182-
<a href="https://jlk.fjfi.cvut.cz/arch/manpages/man/soelim.1">soelim(1)</a>
182+
<a href="https://man.archlinux.org/man/soelim.1">soelim(1)</a>
183183
pre-processor handles the inclusion. Our system is based on a database rather
184184
than a file system, so we need a custom `soelim` as well.
185185

186186
Some pages which contain the `.so` macro:
187187

188-
- <a href="https://jlk.fjfi.cvut.cz/arch/manpages/man/[.1.zh_CN">[.1.zh_CN</a>
189-
- <a href="https://jlk.fjfi.cvut.cz/arch/manpages/man/pwunconv.8">pwunconv(8)</a>
190-
- <a href="https://jlk.fjfi.cvut.cz/arch/manpages/man/pam.8">pam(8)</a>
191-
- <a href="https://jlk.fjfi.cvut.cz/arch/manpages/man/url.7">url(7)</a>
192-
- <a href="https://jlk.fjfi.cvut.cz/arch/manpages/man/xorg.conf.d.5">xorg.conf.d(5)</a>
193-
- <a href="https://jlk.fjfi.cvut.cz/arch/manpages/man/glibc.7">glibc(7)</a>
194-
- <a href="https://jlk.fjfi.cvut.cz/arch/manpages/man/systemd-logind.8">systemd-logind(8)</a>
195-
- <a href="https://jlk.fjfi.cvut.cz/arch/manpages/man/shorewall6.conf.5">shorewall6.conf(5)</a>
188+
- <a href="https://man.archlinux.org/man/[.1.zh_CN">[.1.zh_CN</a>
189+
- <a href="https://man.archlinux.org/man/pwunconv.8">pwunconv(8)</a>
190+
- <a href="https://man.archlinux.org/man/pam.8">pam(8)</a>
191+
- <a href="https://man.archlinux.org/man/url.7">url(7)</a>
192+
- <a href="https://man.archlinux.org/man/xorg.conf.d.5">xorg.conf.d(5)</a>
193+
- <a href="https://man.archlinux.org/man/glibc.7">glibc(7)</a>
194+
- <a href="https://man.archlinux.org/man/systemd-logind.8">systemd-logind(8)</a>
195+
- <a href="https://man.archlinux.org/man/shorewall6.conf.5">shorewall6.conf(5)</a>
196196
points to a page contained in a different package (`shorewall` instead of `shorewall6`)
197-
- <a href="https://jlk.fjfi.cvut.cz/arch/manpages/man/lsof.8">lsof(8)</a>
197+
- <a href="https://man.archlinux.org/man/lsof.8">lsof(8)</a>
198198
(not a "hardlink", includes an invalid file `./00DIALECTS`)

archmanweb/static/archmanweb/base.css

Lines changed: 28 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,11 @@
44
line-height: 14px !important;
55
padding: 14px 15px 0px !important;
66
}
7+
#archnavbar input {
8+
border: none;
9+
height: 17px;
10+
line-height: 14px !important;
11+
}
712

813
/* simple reset */
914
* {
@@ -17,6 +22,9 @@ body {
1722
/* background: #f6f9fc; */
1823
color: #222;
1924
font: normal 100% sans-serif;
25+
/* set min-width to prevent over-shrinking of the body when
26+
* a flex-container child refuses to shrink */
27+
min-width: min-content;
2028
}
2129

2230
p {
@@ -189,28 +197,42 @@ h5 {
189197
main#content {
190198
display: flex;
191199
margin: 1em;
200+
justify-content: center;
192201
}
193202

194203
#content-left {
195204
display: block;
196205
order: 1;
197-
/* max-width of .man-page-content has to be specified here to make it play
198-
* nice with flex */
206+
/* max-width of the content has to be specified here to make it play nice
207+
* with flex. Setting it to max-content would prevent growing beyond the
208+
* largest child element. */
199209
max-width: 80ch;
200210
/* set min-width to prevent excessive shrinking
201211
* (and to force shrinking in case there is an element which refuses to
202212
* shrink, e.g. a very long line in a <pre> tag) */
203213
min-width: 40ch;
204-
/* shrinks to 0 to apply 70% width */
205-
flex-shrink: 0;
206-
/* sets initial width to 70% */
214+
/* set initial/ideal width to 70% */
207215
flex-basis: 70%;
216+
/* shrink factor of 0 effectively means that it will not shrink below 70% of
217+
* the available space (the sidebar will be shrinked instead) */
218+
flex-shrink: 0;
219+
/* increase grow factor to expand into the extra space at the cost of the
220+
* sidebar */
221+
flex-grow: 1;
208222
}
209223

210224
#sidebar {
211225
display: block;
212226
order: 2;
213227
margin-left: 2em;
228+
/* set min-width to prevent excessive shrinking
229+
* (and to force shrinking in case there is an element which refuses to
230+
* shrink, e.g. a very long word) */
231+
min-width: 20ch;
232+
/* set max-width to prevent excessive growing */
233+
max-width: 40ch;
234+
/* sets flex base width to 30% (complement of the main content's base) */
235+
flex-basis: 30%;
214236
}
215237
#sidebar > * {
216238
margin-bottom: 1em;
@@ -290,7 +312,7 @@ table.styled-table tr td,
290312
table.styled-table th {
291313
padding: 0.35em 0.90em;
292314
text-align: left;
293-
white-space: nowrap;
315+
/*white-space: nowrap;*/
294316
}
295317

296318
table.styled-table th {

archmanweb/static/archmanweb/man_page.css

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,6 @@
22
* Basic style
33
*/
44

5-
.man-page-content {
6-
max-width: 80ch;
7-
}
8-
95
.man-page-content div.manual-text {
106
text-align: justify;
117
margin-left: 5ex;
@@ -95,7 +91,8 @@
9591
/* Arch-styled tables
9692
* style copied from base.css and changed:
9793
* - applied to the "tbl" class
98-
* - removed "white-space: nowrap"
94+
* - removed "white-space: nowrap", set word-break to force shrinking on small
95+
* screens
9996
* - "th" style applied also to "td" in the first row
10097
* - top and bottom margins set to 1em for consistency with other markup elements
10198
* (they have to be the same because mandoc creates elements with text of the
@@ -115,13 +112,15 @@
115112
.man-page-content table.tbl th {
116113
padding: 0.35em 0.90em;
117114
text-align: left;
115+
word-break: break-word;
118116
}
119117

120118
.man-page-content table.tbl th,
121119
.man-page-content table.tbl tr:first-child td:not(:only-child) {
122120
background: rgb(217, 230, 236) none repeat scroll 0 0;
123121
border-bottom: 1px solid #bcd;
124122
font-weight: bold;
123+
word-break: initial;
125124
}
126125

127126
.man-page-content table.tbl tr:hover {

archmanweb/templates/base.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@
2222
{% if search_form is None %}
2323
<form action="{% url 'search' %}" class="search" role="search">
2424
<input type="search" placeholder="Search manual page" name="q" value="{% block current_search_term %}{% endblock %}" />
25-
<input type="submit" value="Go" />
25+
<input type="submit" name="go" value="Go" />
2626
</form>
2727
{% endif %}
2828
<li id="anb-home"><a href="https://archlinux.org/" title="Arch news, packages, projects and more">Home</a></li>

0 commit comments

Comments
 (0)