replace the refcard with an HTML version (by SardemFF7)

This eliminates our build-depedency on latex.
This commit is contained in:
Michael Stapelberg 2012-04-12 16:01:10 +02:00
parent 1bb165a29a
commit 41d034a6db
7 changed files with 194 additions and 116 deletions

3
.gitignore vendored
View File

@ -33,7 +33,4 @@ i3-nagbar/i3-nagbar
i3-msg/i3-msg i3-msg/i3-msg
i3-config-wizard/i3-config-wizard i3-config-wizard/i3-config-wizard
libi3/libi3.a libi3/libi3.a
docs/*.html
docs/*.aux
docs/*.out
docs/*.pdf docs/*.pdf

2
debian/control vendored
View File

@ -3,7 +3,7 @@ Section: utils
Priority: extra Priority: extra
Maintainer: Michael Stapelberg <michael@stapelberg.de> Maintainer: Michael Stapelberg <michael@stapelberg.de>
DM-Upload-Allowed: yes DM-Upload-Allowed: yes
Build-Depends: debhelper (>= 7.0.50~), libx11-dev, libxcb-util0-dev (>= 0.3.8), libxcb-keysyms1-dev, libxcb-xinerama0-dev (>= 1.1), libxcb-randr0-dev, libxcb-icccm4-dev, libxcursor-dev, asciidoc (>= 8.4.4), xmlto, docbook-xml, pkg-config, libev-dev, flex, bison, libyajl-dev, texlive-latex-base, texlive-latex-recommended, texlive-latex-extra, libpcre3-dev, libstartup-notification0-dev (>= 0.10) Build-Depends: debhelper (>= 7.0.50~), libx11-dev, libxcb-util0-dev (>= 0.3.8), libxcb-keysyms1-dev, libxcb-xinerama0-dev (>= 1.1), libxcb-randr0-dev, libxcb-icccm4-dev, libxcursor-dev, asciidoc (>= 8.4.4), xmlto, docbook-xml, pkg-config, libev-dev, flex, bison, libyajl-dev, libpcre3-dev, libstartup-notification0-dev (>= 0.10)
Standards-Version: 3.9.2 Standards-Version: 3.9.2
Homepage: http://i3wm.org/ Homepage: http://i3wm.org/

3
debian/i3-wm.docs vendored
View File

@ -25,3 +25,6 @@ docs/tree-shot1.png
docs/tree-shot2.png docs/tree-shot2.png
docs/tree-shot3.png docs/tree-shot3.png
docs/tree-shot4.png docs/tree-shot4.png
docs/refcard.html
docs/refcard_style.css
docs/logo-30.png

View File

@ -1,7 +1,9 @@
# To pass additional parameters for asciidoc # To pass additional parameters for asciidoc
ASCIIDOC=asciidoc ASCIIDOC=asciidoc
all: hacking-howto.html debugging.html debugging-release-version.html userguide.html ipc.html multi-monitor.html wsbar.html refcard.pdf testsuite.html i3bar-protocol.html ASCIIDOC_TARGETS:=hacking-howto.html debugging.html debugging-release-version.html userguide.html ipc.html multi-monitor.html wsbar.html testsuite.html i3bar-protocol.html
all: ${ASCIIDOC_TARGETS}
hacking-howto.html: hacking-howto hacking-howto.html: hacking-howto
$(ASCIIDOC) -a toc -n $< $(ASCIIDOC) -a toc -n $<
@ -30,8 +32,5 @@ multi-monitor.html: multi-monitor
wsbar.html: wsbar wsbar.html: wsbar
$(ASCIIDOC) -a toc -n $< $(ASCIIDOC) -a toc -n $<
refcard.pdf: refcard.tex
pdflatex refcard.tex && pdflatex refcard.tex
clean: clean:
find . -regex ".*\.\(aux\|out\|log\|toc\|bm\|pdf\|dvi\|log\|html\)" -exec rm '{}' \; rm -f ${ASCIIDOC_TARGETS}

BIN
docs/logo-30.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 2.7 KiB

186
docs/refcard.html Normal file
View File

@ -0,0 +1,186 @@
<!DOCTYPE html>
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>i3 Reference Card</title>
<link rel="stylesheet" href="refcard_style.css" />
<style type="text/css">
* { margin: 0; padding: 0; vertical-align: middle; }
html { font-family: LinuxLibertine, Linux Libertine O, Linux Libertine, serif; font-size: 15px; /* column-count: 3; column-gap: 10px; -moz-column-count: 3; -moz-column-gap: 10px; -webkit-column-count: 3; -webkit-column-gap: 10px; */ }
body > div { display: inline-block; width: 33%; margin: 0.25%; vertical-align: top; }
body > div:first-child { margin-left: 0; }
body > div:last-child { margin-right: 0; }
#logo { float: left; width: 40px; margin: 7px; }
header { font-size: 1.1em; text-align: center; }
h1 { font-size: 1.1em; }
header a { font-size: 0.7em; }
header p { margin: 5px 0; font-size: 0.8em; text-align: left; }
kbd { font-family: LinuxBiolinumKeyboard, Linux Biolinum Keyboard O, Linux Biolinum Keyboard, DejaVu Sans Mono, monospace; font-size: 0.9em; }
code { font-family: DejaVu Sans Mono, monospace; font-size: 0.8em; }
section { break-inside: avoid-column; -moz-break-inside: -moz-avoid-column; -webkit-break-inside: avoid-column; }
h2 { margin: 7px 0 2px; padding: 2px 4px; font-size: 1.1em; font-family: LinuxBiolinum, Linux Biolinum O, Linux Biolinum, sans; background-color: #b3b3b3; }
table { width: 100%; }
.i3mod { width: 15px; }
td:last-child { text-align: right; }
.ref { font-size: 0.8em; }
#copyright { margin: 20px 0 15px; font-size: 0.7em; text-align: center; }
#licence { max-width: 70%; margin: 3px auto; font-size: 0.6em; text-align: right; }
</style>
<style type="text/css" media="print">
html { font-size: 13px; }
</style>
</head>
<body><div>
<header>
<img id="logo" src="logo-30.png" alt="" />
<h1>i3 Reference Card</h1>
<a href="http://i3wm.org/docs/userguide.html">http://i3wm.org/docs/userguide.html</a>
<p>
Throughout this guide, the i3 logo will be used to refer to the configured modifier.
This is the <kbd></kbd> key (<code>Mod1</code>) by default,
with super/<kbd></kbd> (<code>Mod4</code>) being a popular alternative.
</p>
</header>
<section>
<h2>Basics</h2>
<table>
<tr>
<td><img class="i3mod" src="logo-30.png" alt="" />+<kbd></kbd>
<td>open new terminal
<tr>
<td><img class="i3mod" src="logo-30.png" alt="" />+<kbd>j</kbd>
<td>focus left
<tr>
<td><img class="i3mod" src="logo-30.png" alt="" />+<kbd>k</kbd>
<td>focus down
<tr>
<td><img class="i3mod" src="logo-30.png" alt="" />+<kbd>l</kbd>
<td>focus up
<tr>
<td><img class="i3mod" src="logo-30.png" alt="" />+<kbd>;</kbd>
<td>focus right
</table>
</section>
<section>
<h2>Changing the container layout</h2>
<table>
<tr>
<td><img class="i3mod" src="logo-30.png" alt="" />+<kbd>e</kbd>
<td>default
<tr>
<td><img class="i3mod" src="logo-30.png" alt="" />+<kbd>s</kbd>
<td>stacking
<tr>
<td><img class="i3mod" src="logo-30.png" alt="" />+<kbd>w</kbd>
<td>tabbed
</table>
</section>
</div><div>
<section>
<h2>Fullscreen mode</h2>
<table>
<tr>
<td><img class="i3mod" src="logo-30.png" alt="" />+<kbd>f</kbd>
<td>toggle fullscreen
</table>
</section>
<section>
<h2>Opening other applications</h2>
<table>
<tr>
<td><img class="i3mod" src="logo-30.png" alt="" />+<kbd>d</kbd>
<td>open application (with dmenu)
</table>
<section>
<h2>Closing windows</h2>
<table>
<tr>
<td><img class="i3mod" src="logo-30.png" alt="" />+<kbd></kbd>+ <kbd>q</kbd>
<td>kill a window
</table>
</section>
<section>
<h2>Using workspaces</h2>
<table>
<tr>
<td><img class="i3mod" src="logo-30.png" alt="" />+<kbd>1</kbd><kbd>9</kbd>
<td>switch to another workspace
</table>
</section>
<section>
<h2>Moving windows to workspaces</h2>
<table>
<tr>
<td><img class="i3mod" src="logo-30.png" alt="" />+<kbd></kbd> + <kbd>1</kbd><kbd>9</kbd>
<td>move a window to another workspace
</table>
</section>
</div><div>
<section>
<h2>Resizing</h2>
<p class="ref">Look at “Resizing containers / windows” section of the user guide.</p>
</section>
<section>
<h2>Restart / Exit</h2>
<table>
<tr>
<td><img class="i3mod" src="logo-30.png" alt="" />+<kbd></kbd> + <kbd>r</kbd>
<td>restart i3 inplace
<tr>
<td><img class="i3mod" src="logo-30.png" alt="" />+<kbd></kbd> + <kbd>e</kbd>
</section><td>exit i3
</table>
<section>
<h2>Floating</h2>
<table>
<tr>
<td><img class="i3mod" src="logo-30.png" alt="" />+<kbd></kbd> + <kbd></kbd>
<td>toggle floating
<tr>
<td><img class="i3mod" src="logo-30.png" alt="" />+<kbd></kbd>
<td>drag floating
</table>
</section>
<!-- footer -->
<p id="copyright">
Copyright © 2012, Michael Stapelberg
<br />
All rights reserved
<br />
Designed by Zeus Panchenko
</p>
<p id="licence">
Permission is granted to copy, distribute and/or modify this document provided
the copyright notice and this permission notice are preserved on all copies.
</p>
</div></body>
</html>

View File

@ -1,107 +0,0 @@
\documentclass[10pt,a4,landscape]{article}
% \usepackage[cam,a4,center,info,]{crop} % frame
\usepackage[height=20cm,width=25.7cm,noheadfoot,landscape]{geometry} % A4 - 210×297 mm
\usepackage[T1]{fontenc}
\usepackage{multicol}
\usepackage{color}
\usepackage{url}
\usepackage{lastpage}
\usepackage{hyperref}
\hypersetup{
pdftitle={i3 Reference Card},
pdfauthor={\textcopyright\ Zeus Panchenko},
pdfkeywords={i3, refcard},
pdfsubject={based on http://i3wm.org/docs/userguide.html},
pdfpagemode={FullScreen}}
\definecolor{lightgray}{gray}{0.7}
\pagestyle{empty}
\setlength{\parindent}{0in}
\setlength{\columnseprule}{0.5pt}
\setlength{\columnsep}{20pt}
\newcommand{\RefCardTitle}[2]
{\centering{\Large{\textbf{i3 Reference Card (#1/#2)\\
{\scriptsize{\url{http://i3wm.org/docs/userguide.html}}}}}}
\vspace{1mm}}
\newcommand{\RefCardSec}[1] {\vspace{2mm} \raggedright {\vspace{0.5mm}
\colorbox{lightgray} {\makebox[0.31\textwidth][l]
{\Large{\textsc{\textsf{\textbf{\color{black}#1}}}}}}
\vspace{0.5mm}}}
\newcommand{\RefCardRow}[2] {\normalsize{\textbf{\texttt{#1}}}
\hspace{\stretch{1}} \raggedleft{\small{\textnormal{#2}}} \\}
\begin{document}
\centering
\begin{multicols}{3}
\RefCardTitle{\thepage}{\pageref{LastPage}}
\RefCardSec{Moving around}
\RefCardRow{Mod1+Enter}{open new terminal}
\RefCardRow{Mod1+j}{focus (left)}
\RefCardRow{Mod1+k}{focus (down)}
\RefCardRow{Mod1+l}{focus (up)}
\RefCardRow{Mod1+;}{focus (right)}
\RefCardRow{Mod1+Shift+j}{move window (left)}
\RefCardRow{Mod1+Shift+k}{move window (down)}
\RefCardRow{Mod1+Shift+l}{move window (up)}
\RefCardRow{Mod1+Shift+;}{move window (right)}
\RefCardRow{Mod1+Control+j}{snap (left)}
\RefCardRow{Mod1+Control+k}{snap (down)}
\RefCardRow{Mod1+Control+l}{snap (up)}
\RefCardRow{Mod1+Control+;}{snap (right)}
\RefCardRow{Mod1+Shift+q}{kill a window}
\RefCardRow{Mod1+Shift+<number>}{move a window to another workspace}
\RefCardSec{Changing container modes}
\RefCardRow{Mod1+e}{default}
\RefCardRow{Mod1+h}{stacking}
\RefCardRow{Mod1+w}{tabbed}
\RefCardRow{Mod1+Shift+f}{global fullscreen}
\RefCardRow{Mod1+f}{toggle fullscreen}
\RefCardRow{Mod1+Shift+Space}{toggle floating}
\RefCardRow{Mod1+<Mouse>}{drag floating}
\RefCardSec{Opening other applications}
\RefCardRow{Mod1+v}{open application launcher (dmenu)}
\RefCardSec{Using workspaces}
\RefCardRow{Mod1+<number>}{switch to another workspace}
\RefCardSec{Restarting i3 inplace}
\RefCardRow{Mod1+Shift+r}{restart i3 inplace}
\RefCardSec{Exiting i3}
\RefCardRow{Mod1+Shift+e}{exit i3}
\vspace{1cm}
\tiny{
\begin{center}
Copyright \copyright 2009, Michael Stapelberg \\
All rights reserved. \\
Designed by Zeus Panchenko
\end{center}
Permission is granted to copy, distribute and/or modify this
document provided the copyright notice and this permission
notice are preserved on all copies.}
\end{multicols}
\end{document}