\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{{[}deleted{]}} \pdfinfo{ /Title (shfb-xml-doc-comments.pdf) /Creator (Cheatography) /Author ({[}deleted{]}) /Subject (SHFB XML Doc Comments 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}{9C1019} \definecolor{LightBackground}{HTML}{FBF7F7} \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{SHFB XML Doc Comments Cheat Sheet}}}} \\ \normalsize{by \textcolor{DarkBackground}{{[}deleted{]}} via \textcolor{DarkBackground}{\uline{cheatography.com/19978/cs/2860/}}} \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}{[}deleted{]} \\ \uline{cheatography.com/deleted-19978} \\ \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 11th 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{tabularx}{17.67cm}{X} \SetRowColor{DarkBackground} \mymulticolumn{1}{x{17.67cm}}{\bf\textcolor{white}{Introduction}} \tn \SetRowColor{white} \mymulticolumn{1}{x{17.67cm}}{This cheat sheet has two main parts. The first part gives a brief overview of the possible elements and where the are supported by Sandcastle Help File Builder in XML doc comments in the source code. After this each element is detailed a bit more.% Row Count 5 (+ 5) } \tn \hhline{>{\arrayrulecolor{DarkBackground}}-} \end{tabularx} \par\addvspace{1.3em} \begin{tabularx}{17.67cm}{x{5.8718 cm} x{11.3982 cm} } \SetRowColor{DarkBackground} \mymulticolumn{2}{x{17.67cm}}{\bf\textcolor{white}{Used Icons}} \tn % Row 0 \SetRowColor{LightBackground} \{\{fa-check-square-o\}\} & \{\{link="http://msdn.microsoft.com/en-us/library/5ast78ax.aspx"\}\}Syntax is verified by the compiler. \tn % Row Count 4 (+ 4) % Row 1 \SetRowColor{white} \{\{fa-minus-square-o\}\} & Not supported by SHFB \tn % Row Count 6 (+ 2) \hhline{>{\arrayrulecolor{DarkBackground}}--} \SetRowColor{LightBackground} \mymulticolumn{2}{x{17.67cm}}{These icons are used on the sections that describe the elements to indicate some additional information.} \tn \hhline{>{\arrayrulecolor{DarkBackground}}--} \end{tabularx} \par\addvspace{1.3em} \begin{tabularx}{17.67cm}{x{5.2297 cm} x{7.5915 cm} x{4.0488 cm} } \SetRowColor{DarkBackground} \mymulticolumn{3}{x{17.67cm}}{\bf\textcolor{white}{root elements}} \tn % Row 0 \SetRowColor{LightBackground} \{\{nobreak\}\}\textless{}summary\textgreater{} & Describe the member or type in one or two lines & \tn % Row Count 3 (+ 3) % Row 1 \SetRowColor{white} \{\{nobreak\}\}\textless{}param\textgreater{} & Describe a parameter & \{\{fa-check-square-o\}\} \tn % Row Count 6 (+ 3) % Row 2 \SetRowColor{LightBackground} \{\{nobreak\}\}\textless{}returns\textgreater{} & Describe the return value & \tn % Row Count 8 (+ 2) % Row 3 \SetRowColor{white} \{\{nobreak\}\}\textless{}remarks\textgreater{} & Full description of the member ot the type & \tn % Row Count 11 (+ 3) % Row 4 \SetRowColor{LightBackground} \{\{nobreak\}\}\textless{}permission\textgreater{} & ??? & \{\{fa-check-square-o\}\} \tn % Row Count 14 (+ 3) % Row 5 \SetRowColor{white} \{\{nobreak\}\}\textless{}exception\textgreater{} & Describe an exception that can be thrown from the member & \{\{fa-check-square-o\}\} \tn % Row Count 18 (+ 4) % Row 6 \SetRowColor{LightBackground} \{\{nobreak\}\}\textless{}inheritdoc\textgreater{} & Inherit documenation from an ancestor & \tn % Row Count 21 (+ 3) % Row 7 \SetRowColor{white} \{\{nobreak\}\}\textless{}example\textgreater{} & Provide an example & \tn % Row Count 23 (+ 2) % Row 8 \SetRowColor{LightBackground} \{\{nobreak\}\}\textless{}exclude\textgreater{} & Exclude the member from the documentation & \tn % Row Count 26 (+ 3) % Row 9 \SetRowColor{white} \{\{nobreak\}\}\textless{}filterprioroty\textgreater{} & Used by the VB editor to filter elements out of the pop-up & \{\{fa-minus-square-o\}\} \tn % Row Count 30 (+ 4) \end{tabularx} \par\addvspace{1.3em} \begin{tabularx}{17.67cm}{x{5.2297 cm} x{7.5915 cm} x{4.0488 cm} } \SetRowColor{DarkBackground} \mymulticolumn{3}{x{17.67cm}}{\bf\textcolor{white}{root elements (cont)}} \tn % Row 10 \SetRowColor{LightBackground} \{\{nobreak\}\}\textless{}include\textgreater{} & Import documentation from an external file & \{\{fa-check-square-o\}\} \tn % Row Count 3 (+ 3) % Row 11 \SetRowColor{white} \{\{nobreak\}\}\textless{}overloads\textgreater{} & Generic description for member overloads & \tn % Row Count 6 (+ 3) % Row 12 \SetRowColor{LightBackground} \{\{nobreak\}\}\textless{}preliminary\textgreater{} & Shot the documentation as prelimenary & \tn % Row Count 9 (+ 3) % Row 13 \SetRowColor{white} \{\{nobreak\}\}\textless{}seealso\textgreater{} & Link to other content from the "See Also' section & \{\{fa-check-square-o\}\} \tn % Row Count 12 (+ 3) % Row 14 \SetRowColor{LightBackground} \{\{nobreak\}\}\textless{}threadsafety\textgreater{} & ??? & \tn % Row Count 15 (+ 3) % Row 15 \SetRowColor{white} \{\{nobreak\}\}\textless{}tocexclude\textgreater{} & Exclude the member from the table of contents & \tn % Row Count 18 (+ 3) % Row 16 \SetRowColor{LightBackground} \{\{nobreak\}\}\textless{}typeparam\textgreater{} & Describe a type parameter of a generic type & \{\{fa-check-square-o\}\} \tn % Row Count 21 (+ 3) % Row 17 \SetRowColor{white} \{\{nobreak\}\}\textless{}value\textgreater{} & Describe the value of a property & \tn % Row Count 23 (+ 2) \hhline{>{\arrayrulecolor{DarkBackground}}---} \end{tabularx} \par\addvspace{1.3em} \begin{tabularx}{17.67cm}{x{6.2419 cm} x{8.9411 cm} p{1.687 cm} } \SetRowColor{DarkBackground} \mymulticolumn{3}{x{17.67cm}}{\bf\textcolor{white}{block elements}} \tn % Row 0 \SetRowColor{LightBackground} \{\{nobreak\}\}\textless{}code\textgreater{} & Format a block as code. Syntax highlighting is possible. & \tn % Row Count 3 (+ 3) % Row 1 \SetRowColor{white} \{\{nobreak\}\}\textless{}inheritdoc\textgreater{} & Inherit common documentation form an ancestor & \tn % Row Count 6 (+ 3) % Row 2 \SetRowColor{LightBackground} \{\{nobreak\}\}\textless{}list\textgreater{} & Create a list or a table & \tn % Row Count 8 (+ 2) % Row 3 \SetRowColor{white} \{\{nobreak\}\}\textless{}para\textgreater{} & Create as a parapraph & \tn % Row Count 10 (+ 2) \hhline{>{\arrayrulecolor{DarkBackground}}---} \end{tabularx} \par\addvspace{1.3em} \begin{tabularx}{17.67cm}{x{4.8923 cm} x{7.9289 cm} x{4.0488 cm} } \SetRowColor{DarkBackground} \mymulticolumn{3}{x{17.67cm}}{\bf\textcolor{white}{inline elements}} \tn % Row 0 \SetRowColor{LightBackground} \{\{nobreak\}\}\textless{}c\textgreater{} & Format short text as code. & \tn % Row Count 2 (+ 2) % Row 1 \SetRowColor{white} \{\{nobreak\}\}\textless{}note\textgreater{} & Format the content of the block as a note. Use atributes to set the note type. & \tn % Row Count 7 (+ 5) % Row 2 \SetRowColor{LightBackground} \{\{nobreak\}\}\textless{}paramref\textgreater{} & Reference a parameter of the method. Method name set by attribute {\bf{name}}. & \tn % Row Count 12 (+ 5) % Row 3 \SetRowColor{white} \mymulticolumn{3}{x{17.67cm}}{\{\{nobreak\}\}\textless{}pre\textgreater{}} \tn % Row Count 13 (+ 1) % Row 4 \SetRowColor{LightBackground} \{\{nobreak\}\}\textless{}see\textgreater{} & In-line reference to an internal ({\bf{cref}}), an external ({\bf{href}}), or a language specific content ({\bf{langword}}). Target of reference set by attribute. & \{\{fa-check-square-o\}\} \tn % Row Count 22 (+ 9) % Row 5 \SetRowColor{white} \{\{nobreak\}\}\textless{}typeparamref\textgreater{} & Reference a type parameter of the method. Method name set by attribute {\bf{name}}. & \tn % Row Count 27 (+ 5) \hhline{>{\arrayrulecolor{DarkBackground}}---} \end{tabularx} \par\addvspace{1.3em} \begin{tabularx}{17.67cm}{X} \SetRowColor{DarkBackground} \mymulticolumn{1}{x{17.67cm}}{\bf\textcolor{white}{Externals Links}} \tn % Row 0 \SetRowColor{LightBackground} \mymulticolumn{1}{x{17.67cm}}{\{\{link="http://shfb.codeplex.com/"\}\}SHFB Site} \tn % Row Count 1 (+ 1) % Row 1 \SetRowColor{white} \mymulticolumn{1}{x{17.67cm}}{\{\{link="http://msdn.microsoft.com/en-us/library/b2s063f7.aspx"\}\}XML Documentation comments on MSDN} \tn % Row Count 3 (+ 2) \hhline{>{\arrayrulecolor{DarkBackground}}-} \end{tabularx} \par\addvspace{1.3em} \begin{tabularx}{17.67cm}{x{10.0166 cm} p{7.2534 cm} } \SetRowColor{DarkBackground} \mymulticolumn{2}{x{17.67cm}}{\bf\textcolor{white}{\textless{}summary\textgreater{}}} \tn % Row 0 \SetRowColor{LightBackground} Type & Root \tn % Row Count 1 (+ 1) % Row 1 \SetRowColor{white} Content & mixed \tn % Row Count 2 (+ 1) \hhline{>{\arrayrulecolor{DarkBackground}}--} \SetRowColor{LightBackground} \mymulticolumn{2}{x{17.67cm}}{The summary provides a short description of the type or the member. This summary is used in intellisense and in various places in the generated documentation.} \tn \hhline{>{\arrayrulecolor{DarkBackground}}--} \end{tabularx} \par\addvspace{1.3em} \end{document}