\documentclass[10pt,a4paper]{article} % Packages \usepackage{fancyhdr} % For header and footer \usepackage{multicol} % Allows multicols in tables \usepackage{tabularx} % Intelligent column widths \usepackage{tabulary} % Used in header and footer \usepackage{hhline} % Border under tables \usepackage{graphicx} % For images \usepackage{xcolor} % For hex colours %\usepackage[utf8x]{inputenc} % For unicode character support \usepackage[T1]{fontenc} % Without this we get weird character replacements \usepackage{colortbl} % For coloured tables \usepackage{setspace} % For line height \usepackage{lastpage} % Needed for total page number \usepackage{seqsplit} % Splits long words. %\usepackage{opensans} % Can't make this work so far. Shame. Would be lovely. \usepackage[normalem]{ulem} % For underlining links % Most of the following are not required for the majority % of cheat sheets but are needed for some symbol support. \usepackage{amsmath} % Symbols \usepackage{MnSymbol} % Symbols \usepackage{wasysym} % Symbols %\usepackage[english,german,french,spanish,italian]{babel} % Languages % Document Info \author{J33f} \pdfinfo{ /Title (kuzzle-js.pdf) /Creator (Cheatography) /Author (J33f) /Subject (kuzzle-js Cheat Sheet) } % Lengths and widths \addtolength{\textwidth}{6cm} \addtolength{\textheight}{-1cm} \addtolength{\hoffset}{-3cm} \addtolength{\voffset}{-2cm} \setlength{\tabcolsep}{0.2cm} % Space between columns \setlength{\headsep}{-12pt} % Reduce space between header and content \setlength{\headheight}{85pt} % If less, LaTeX automatically increases it \renewcommand{\footrulewidth}{0pt} % Remove footer line \renewcommand{\headrulewidth}{0pt} % Remove header line \renewcommand{\seqinsert}{\ifmmode\allowbreak\else\-\fi} % Hyphens in seqsplit % This two commands together give roughly % the right line height in the tables \renewcommand{\arraystretch}{1.3} \onehalfspacing % Commands \newcommand{\SetRowColor}[1]{\noalign{\gdef\RowColorName{#1}}\rowcolor{\RowColorName}} % Shortcut for row colour \newcommand{\mymulticolumn}[3]{\multicolumn{#1}{>{\columncolor{\RowColorName}}#2}{#3}} % For coloured multi-cols \newcolumntype{x}[1]{>{\raggedright}p{#1}} % New column types for ragged-right paragraph columns \newcommand{\tn}{\tabularnewline} % Required as custom column type in use % Font and Colours \definecolor{HeadBackground}{HTML}{333333} \definecolor{FootBackground}{HTML}{666666} \definecolor{TextColor}{HTML}{333333} \definecolor{DarkBackground}{HTML}{00757F} \definecolor{LightBackground}{HTML}{EFF6F7} \renewcommand{\familydefault}{\sfdefault} \color{TextColor} % Header and Footer \pagestyle{fancy} \fancyhead{} % Set header to blank \fancyfoot{} % Set footer to blank \fancyhead[L]{ \noindent \begin{multicols}{3} \begin{tabulary}{5.8cm}{C} \SetRowColor{DarkBackground} \vspace{-7pt} {\parbox{\dimexpr\textwidth-2\fboxsep\relax}{\noindent \hspace*{-6pt}\includegraphics[width=5.8cm]{/web/www.cheatography.com/public/images/cheatography_logo.pdf}} } \end{tabulary} \columnbreak \begin{tabulary}{11cm}{L} \vspace{-2pt}\large{\bf{\textcolor{DarkBackground}{\textrm{kuzzle-js Cheat Sheet}}}} \\ \normalsize{by \textcolor{DarkBackground}{J33f} via \textcolor{DarkBackground}{\uline{cheatography.com/26967/cs/7687/}}} \end{tabulary} \end{multicols}} \fancyfoot[L]{ \footnotesize \noindent \begin{multicols}{3} \begin{tabulary}{5.8cm}{LL} \SetRowColor{FootBackground} \mymulticolumn{2}{p{5.377cm}}{\bf\textcolor{white}{Cheatographer}} \\ \vspace{-2pt}J33f \\ \uline{cheatography.com/j33f} \\ \end{tabulary} \vfill \columnbreak \begin{tabulary}{5.8cm}{L} \SetRowColor{FootBackground} \mymulticolumn{1}{p{5.377cm}}{\bf\textcolor{white}{Cheat Sheet}} \\ \vspace{-2pt}Not Yet Published.\\ Updated 12th May, 2016.\\ Page {\thepage} of \pageref{LastPage}. \end{tabulary} \vfill \columnbreak \begin{tabulary}{5.8cm}{L} \SetRowColor{FootBackground} \mymulticolumn{1}{p{5.377cm}}{\bf\textcolor{white}{Sponsor}} \\ \SetRowColor{white} \vspace{-5pt} %\includegraphics[width=48px,height=48px]{dave.jpeg} Measure your website readability!\\ www.readability-score.com \end{tabulary} \end{multicols}} \begin{document} \raggedright \raggedcolumns % Set font size to small. Switch to any value % from this page to resize cheat sheet text: % www.emerson.emory.edu/services/latex/latex_169.html \footnotesize % Small font. \begin{multicols*}{2} \begin{tabularx}{8.4cm}{x{2.48 cm} x{5.52 cm} } \SetRowColor{DarkBackground} \mymulticolumn{2}{x{8.4cm}}{\bf\textcolor{white}{Where to find docs}} \tn % Row 0 \SetRowColor{LightBackground} REST API & \seqsplit{http://kuzzleio.github.io/kuzzle-api-documentation/} \tn % Row Count 2 (+ 2) % Row 1 \SetRowColor{white} SDK & \seqsplit{http://kuzzleio.github.io/sdk-documentation/} \tn % Row Count 4 (+ 2) % Row 2 \SetRowColor{LightBackground} Real-time filters & \seqsplit{https://github.com/kuzzleio/kuzzle/blob/develop/docs/filters.md} \tn % Row Count 7 (+ 3) % Row 3 \SetRowColor{white} Persistant filters & \seqsplit{https://www.elastic.co/guide/en/elasticsearch/reference/1.7/query-dsl.html} \tn % Row Count 10 (+ 3) \hhline{>{\arrayrulecolor{DarkBackground}}--} \end{tabularx} \par\addvspace{1.3em} \begin{tabularx}{8.4cm}{x{5.36 cm} p{2.64 cm} } \SetRowColor{DarkBackground} \mymulticolumn{2}{x{8.4cm}}{\bf\textcolor{white}{Protocols and ports}} \tn % Row 0 \SetRowColor{LightBackground} REST & 7511 \tn % Row Count 1 (+ 1) % Row 1 \SetRowColor{white} SocketIo & 7512 \tn % Row Count 2 (+ 1) \hhline{>{\arrayrulecolor{DarkBackground}}--} \end{tabularx} \par\addvspace{1.3em} \begin{tabularx}{8.4cm}{X} \SetRowColor{DarkBackground} \mymulticolumn{1}{x{8.4cm}}{\bf\textcolor{white}{Instantiate a Kuzzle connexion}} \tn \SetRowColor{LightBackground} \mymulticolumn{1}{x{8.4cm}}{var kuzzle = new Kuzzle(kuzzleUrl, \{defaultIndex: 'defaultIndex'\}); \newline // kuzzleUrl example "http://localhost:7512"} \tn \hhline{>{\arrayrulecolor{DarkBackground}}-} \end{tabularx} \par\addvspace{1.3em} \begin{tabularx}{8.4cm}{X} \SetRowColor{DarkBackground} \mymulticolumn{1}{x{8.4cm}}{\bf\textcolor{white}{dataCollectionFactory}} \tn \SetRowColor{LightBackground} \mymulticolumn{1}{x{8.4cm}}{var collection = \seqsplit{kuzzle.dataCollectionFactory('optional\_Index'}, \seqsplit{'mandatory\_collection');}} \tn \hhline{>{\arrayrulecolor{DarkBackground}}-} \end{tabularx} \par\addvspace{1.3em} \begin{tabularx}{8.4cm}{X} \SetRowColor{DarkBackground} \mymulticolumn{1}{x{8.4cm}}{\bf\textcolor{white}{createDocument}} \tn \SetRowColor{LightBackground} \mymulticolumn{1}{x{8.4cm}}{kuzzle \newline \seqsplit{.dataCollectionFactory('optional\_index'}, 'mandatory\_collection') \newline \seqsplit{.createDocument('optional\_document\_id'}, \{document: 'object''\}, \{updateIfExist: true\}, function (err, res) \{ \newline // callback called once the create action has been completed \newline // =\textgreater{} the result is a KuzzleDocument object \newline \});} \tn \hhline{>{\arrayrulecolor{DarkBackground}}-} \end{tabularx} \par\addvspace{1.3em} \begin{tabularx}{8.4cm}{X} \SetRowColor{DarkBackground} \mymulticolumn{1}{x{8.4cm}}{\bf\textcolor{white}{deleteDocument}} \tn \SetRowColor{LightBackground} \mymulticolumn{1}{x{8.4cm}}{kuzzle \newline \seqsplit{.dataCollectionFactory('optional\_index'}, 'mandatory\_collection') \newline \seqsplit{.deleteDocument('mandatory\_document\_id'}, function (err, res) \{ \newline // callback called once the delete action has been completed \newline // =\textgreater{} the result is an array containing the deleted document IDs \newline \});} \tn \hhline{>{\arrayrulecolor{DarkBackground}}-} \end{tabularx} \par\addvspace{1.3em} \begin{tabularx}{8.4cm}{X} \SetRowColor{DarkBackground} \mymulticolumn{1}{x{8.4cm}}{\bf\textcolor{white}{subscribe}} \tn \SetRowColor{LightBackground} \mymulticolumn{1}{x{8.4cm}}{var mandatory\_filter = \{\}; \newline var optional\_options = \{\}; \newline var room = \newline kuzzle \newline \seqsplit{.dataCollectionFactory('optional\_index'}, 'mandatory\_collection') \newline \seqsplit{.subscribe(mandatory\_filter}, optional\_options, function (error, result) \{ \newline // called each time a new notification on this filter is received \newline \};} \tn \hhline{>{\arrayrulecolor{DarkBackground}}-} \end{tabularx} \par\addvspace{1.3em} \begin{tabularx}{8.4cm}{x{1.216 cm} x{3.192 cm} x{3.192 cm} } \SetRowColor{DarkBackground} \mymulticolumn{3}{x{8.4cm}}{\bf\textcolor{white}{subscribe options}} \tn % Row 0 \SetRowColor{LightBackground} \seqsplit{metadata} & object & Additional information passed to notifications to other users \tn % Row Count 4 (+ 4) % Row 1 \SetRowColor{white} scope & string (in, out, all, none) default 'all' & Does the document is entering or leaving the filter scope \tn % Row Count 8 (+ 4) % Row 2 \SetRowColor{LightBackground} state & string (pending, done, all) default 'done' & does the document is yet written or not \tn % Row Count 11 (+ 3) % Row 3 \SetRowColor{white} \seqsplit{subscribeToSelf} & boolean (default true) & (Don't) subscribe to your own documents \tn % Row Count 14 (+ 3) % Row 4 \SetRowColor{LightBackground} users & string (in, out, all, none) default none & a user is (un)subscribing to the same filter \tn % Row Count 17 (+ 3) \hhline{>{\arrayrulecolor{DarkBackground}}---} \end{tabularx} \par\addvspace{1.3em} % That's all folks \end{multicols*} \end{document}