\hypertarget{namespaceexcerpts_1_1ui}{\section{excerpts.\+ui Namespace Reference}
\label{namespaceexcerpts_1_1ui}\index{excerpts.\+ui@{excerpts.\+ui}}
}
\subsection*{Functions}
\begin{DoxyCompactItemize}
\item 
def \hyperlink{namespaceexcerpts_1_1ui_a05f4a4d942695ac7c46513bd83d9f42a}{excerpts}
\begin{DoxyCompactList}\small\item\em Extract, Convert and Save Markdown Style Comments From a File. \end{DoxyCompactList}\end{DoxyCompactItemize}


\subsection{Function Documentation}
\hypertarget{namespaceexcerpts_1_1ui_a05f4a4d942695ac7c46513bd83d9f42a}{\index{excerpts\+::ui@{excerpts\+::ui}!excerpts@{excerpts}}
\index{excerpts@{excerpts}!excerpts\+::ui@{excerpts\+::ui}}
\subsubsection[{excerpts}]{\setlength{\rightskip}{0pt plus 5cm}def excerpts.\+ui.\+excerpts (
\begin{DoxyParamCaption}
\item[{}]{file\+\_\+name, }
\item[{}]{comment\+\_\+character = {\ttfamily \char`\"{}\#\char`\"{}}, }
\item[{}]{magic\+\_\+character = {\ttfamily \char`\"{}\%\char`\"{}}, }
\item[{}]{allow\+\_\+pep8 = {\ttfamily True}, }
\item[{}]{output\+\_\+path = {\ttfamily \char`\"{}\char`\"{}}, }
\item[{}]{prefix = {\ttfamily \char`\"{}\char`\"{}}, }
\item[{}]{postfix = {\ttfamily \char`\"{}\char`\"{}}, }
\item[{}]{run\+\_\+pandoc = {\ttfamily True}, }
\item[{}]{compile\+\_\+latex = {\ttfamily False}, }
\item[{}]{pandoc\+\_\+formats = {\ttfamily \char`\"{}tex\char`\"{}}}
\end{DoxyParamCaption}
)}}\label{namespaceexcerpts_1_1ui_a05f4a4d942695ac7c46513bd83d9f42a}


Extract, Convert and Save Markdown Style Comments From a File. 

This is merely a wrapper to \hyperlink{namespaceexcerpts_1_1main_ae001c32da9a6230932a0a5ef60b67d16}{excerpt()}, \hyperlink{namespaceexcerpts_1_1main_a7143bff678d0d683e5ad4a042f2f78b6}{modify\+\_\+path()} and \hyperlink{namespaceexcerpts_1_1op_afa997ba28545787455430d2b7fc92fe0}{pandoc()}.


\begin{DoxyParams}{Parameters}
{\em file\+\_\+name} & The file from which the lines are to be extracted. \\
\hline
{\em comment\+\_\+character} & The comment character of the files language. \\
\hline
{\em magic\+\_\+character} & The magic character marking lines as excerpts. \\
\hline
{\em allow\+\_\+pep8} & Remove a leading single comment character and blank. \\
\hline
{\em output\+\_\+path} & Set a new file name or an output directory. \\
\hline
{\em postfix} & Set the output file postfix. \\
\hline
{\em prefix} & Set the output file prefix. \\
\hline
{\em run\+\_\+pandoc} & Run pandoc on the markdown file created? \\
\hline
{\em compile\+\_\+latex} & Compile the La\+Te\+X file? \\
\hline
{\em pandoc\+\_\+formats} & The pandoc output formats to be used. \\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}
0 if output generation was successful, 1 otherwise. 
\end{DoxyReturn}
