%% Overleaf
%% Software Manual and Technical Document Template
%%
%% This provides an example of a software manual created in Overleaf.
\documentclass{ol-softwaremanual}
% Packages used in this example
\usepackage{graphicx} % for including images
\usepackage{microtype} % for typographical enhancements
\usepackage{minted} % for code listings
\usepackage{amsmath} % for equations and mathematics
\setminted{style=friendly,fontsize=\small}
\renewcommand{\listoflistingscaption}{List of Code Listings}
\usepackage{hyperref} % for hyperlinks
\usepackage[a4paper,top=4.2cm,bottom=4.2cm,left=3.5cm,right=3.5cm]{geometry} % for setting page size and margins
% Custom macros used in this example document
\newcommand{\doclink}[2]{\href{#1}{#2}\footnote{\url{#1}}}
\newcommand{\cs}[1]{\texttt{\textbackslash #1}}
% Frontmatter data; appears on title page
\title{Technical Document \\Template}
\version{2.3.1}
\author{Overleaf}
\softwarelogo{\includegraphics[width=8cm]{logo}}
\begin{document}
\maketitle
\tableofcontents
\listoflistings
\newpage
\section{Introduction}
This document is an example of a software manual created using \LaTeX\ and Overleaf. It provides a nice clean format for producing this type of technical document.
Simply start writing your document and use the Recompile button to view the updated PDF preview. Examples of commonly used commands and features can be found in the sections below, to help you get started.
To change the logo shown on the front page, simply upload your own logo image file (via the file-tree menu) to replace the default logo.pdf file.
Once you're familiar with the editor, you can find various project settings in the Overleaf menu, accessed via the button in the very top left of the editor. To view tutorials, user guides, and further documentation, please visit our \doclink{https://www.overleaf.com/learn}{help library}. If you haven't used \LaTeX\ before, our \doclink{https://www.overleaf.com/learn/latex/Learn_LaTeX_in_30_minutes}{Learn \LaTeX\ in 30 minutes} tutorial is an excellent place to start.
For large documents, it can be useful to split the document into multiple source files.
Double-clicking on text in Overleaf's PDF preview will take you directly to the corresponding code in the editor.
\section{Including code samples}
\input{code-samples}
\section{Some further examples to get started}
\input{further-examples}
\end{document}
