summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/source/latex/huawei/huawei.dtx
diff options
context:
space:
mode:
Diffstat (limited to 'Master/texmf-dist/source/latex/huawei/huawei.dtx')
-rw-r--r--Master/texmf-dist/source/latex/huawei/huawei.dtx216
1 files changed, 112 insertions, 104 deletions
diff --git a/Master/texmf-dist/source/latex/huawei/huawei.dtx b/Master/texmf-dist/source/latex/huawei/huawei.dtx
index fdb272a996c..d9fa5fa2a9b 100644
--- a/Master/texmf-dist/source/latex/huawei/huawei.dtx
+++ b/Master/texmf-dist/source/latex/huawei/huawei.dtx
@@ -50,13 +50,17 @@
%<class>\NeedsTeXFormat{LaTeX2e}
%<class>\ProvidesClass{huawei}
%<*class>
-[2022-10-14 0.14.2 Template for Huawei Documents]
+[2022-10-29 0.14.3 Template for Huawei Documents]
%</class>
%<*driver>
\documentclass{ltxdoc}
\usepackage[tt=false, type1=true]{libertine}
\usepackage[T1]{fontenc}
\usepackage[utf8]{inputenc}
+\usepackage{microtype}
+\AddToHook{env/verbatim/begin}{\microtypesetup{protrusion=false}}
+\usepackage[dtx,margin=0,log,nocrop]{docshots}
+\docshotPrerequisite{huawei-cover-picture.pdf}
\usepackage{href-ul}
\PageIndex
\EnableCrossrefs
@@ -83,19 +87,12 @@
% style elegant enough both for management and technical
% papers. To use the class you simply mention its name
% in the preamble:
-%
-%\iffalse
-%<*verb>
-%\fi
-\begin{verbatim}
-\documentclass{huawei}
-\begin{document}
-Hello, world!
-\end{document}
-\end{verbatim}
-%\iffalse
-%</verb>
-%\fi
+% \begin{docshot}
+% \documentclass{huawei}
+% \begin{document}
+% Hello, world!
+% \end{document}
+% \end{docshot}
% We recommend you to use
% |latexmk| to compile your |.tex| files to |.pdf|.
@@ -132,7 +129,6 @@ $pdflatex = 'pdflatex %O --shell-escape %S';
% by |pdflatex| during the compilation. You don't need to commit
% them to your repository, since they are temporary and will
% be generated again when you compile your document.
-
% In order to compile the document, just say |latexmk| on the command line.
% \section{Class Options}
@@ -142,68 +138,64 @@ $pdflatex = 'pdflatex %O --shell-escape %S';
% the layout of your document:
% \DescribeMacro{landscape}
-% makes the document in landscape format, also changing the size
-% of the paper to 16x9 inches (the default page size is
-% \href{https://en.wikipedia.org/wiki/Paper_size}{A4}),
-% making it perfect for presentations.
+% The option |landscape| makes the document in landscape format, also changing the size
+% of the paper to 16x9 inches (the default page size is
+% \href{https://en.wikipedia.org/wiki/Paper_size}{A4}),
+% making it perfect for presentations.
% \DescribeMacro{dark}
-% Turns on a dark layout, where the page color is black and the text
+% The option |dark| turns on a dark layout, where the page color is black and the text
% is white.
% \DescribeMacro{slides}
-% makes all headers a bit larger, assuming that the document
-% is in the landscape mode and being presented as a slide deck.
+% The option |slides| makes all headers a bit larger, assuming that the document
+% is in the landscape mode and being presented as a slide deck.
% \DescribeMacro{nocover}
-% avoid printing the cover images on the first page by the
-% |\PrintTitlePage| command.
+% The option |nocover|, if it's present, avoids printing the cover images on the first page by the
+% |\PrintTitlePage| command.
% \DescribeMacro{anonymous}
-% removes the name of the author everywhere, including the bottom
-% of the page, where the author's name stays next to the name of the
-% company.
+% The |anonymous| removes the name of the author everywhere, including the bottom
+% of the page, where the author's name stays next to the name of the
+% company.
% \DescribeMacro{nobrand}
-% avoid mentioning the brand of Huawei anywhere
-% in the document and removes the logo too.
+% The option |nobrand| avoids mentioning the brand of Huawei anywhere
+% in the document and removes the logo too.
% \DescribeMacro{nosecurity}
-% avoids mentioning the level of security at the right top
-% corner of the document and also avoids showing the ID of the author
-% where it usually is visible.
+% The option |nosecurity| avoids mentioning the level of security at the right top
+% corner of the document and also avoids showing the ID of the author
+% where it usually is visible.
% \DescribeMacro{nodate}
-% don't show the date and time at the bottom of each page,
-% where they usually are rendered in ISO~8601 format.
+% The option |nodate| doesn't show the date and time at the bottom of each page,
+% where they usually are rendered in ISO~8601 format.
% \DescribeMacro{nopaging}
-% avoids page numbers at the bottom of each page.
+% The option |nopaging| avoids page numbers at the bottom of each page.
% \DescribeMacro{authordraft}
-% prints a big ``It's a draft'' message across each page.
+% The option |authordraft| prints a big ``It's a draft'' message across each page.
% \section{Preamble}
% In the preamble you can specify meta information about the document,
% such as its title or author's name, here is how:
-
-%\iffalse
-%<*verb>
-%\fi
-\begin{verbatim}
-\documentclass{huawei}
-\renewcommand*\thetitle{Making Compression 15\% Faster}
-\renewcommand*\thesubtitle{Technical Report}
-\renewcommand*\theauthor{Yegor Bugayenko}
-\begin{document}
-\maketitle
-Hello, world!
-\end{document}
-\end{verbatim}
-%\iffalse
-%</verb>
-%\fi
+% \begin{docshot}
+% \documentclass{huawei}
+% \renewcommand*
+% \thetitle{15\% Faster Algorithm}
+% \renewcommand*
+% \thesubtitle{Technical Report}
+% \renewcommand*
+% \theauthor{Yegor Bugayenko}
+% \begin{document}
+% \maketitle
+% Hello, world!
+% \end{document}
+% \end{docshot}
% It's recommended to use |\renewcommand*| instead of
% |\renewcommand| in order to let \LaTeX{} catch you
@@ -241,23 +233,53 @@ Hello, world!
% Inside the document body you can use these commands:
% \DescribeMacro{\PrintFirstPage}
-% |\PrintFirstPage|
-% prints the first page of a project charter or a similar landscape documents,
-% placing the image |front-image.pdf| on the front (the file should be present
-% in the current dir. If you don't have the front image file, just leave
-% the first argument empty.
+% It is recommended to use |\PrintFirstPage| for rendering the first
+% page in landscape document, for example a project charter.
+% The only argument of the commmand is the name of an image to render at the
+% right bottom corner. You can omit the name and just call the command with
+% an empty argument. In this case the default image will be rendered, a pretty
+% good looking one:
+% \begin{docshot}
+% \documentclass[landscape]{huawei}
+% \renewcommand*
+% \thetitle{Perpetum Mobile}
+% \renewcommand*
+% \theauthor{Yegor Bugayenko}
+% \begin{document}
+% \PrintFirstPage{}
+% \end{document}
+% \end{docshot}
% \DescribeMacro{\PrintLastPage}
-% |\PrintLastPage|
-% prints the last page of a project charter or a similar landscape document.
+% |\PrintLastPage| prints the last page of a project charter or a similar landscape document:
+% \begin{docshot}
+% \documentclass[landscape]{huawei}
+% \begin{document}
+% \PrintLastPage{}
+% \end{document}
+% \end{docshot}
% \DescribeMacro{\PrintThankYouPage}
-% |\PrintThankYouPage|
-% prints the last page with a "Thank You" message in the center.
+% |\PrintThankYouPage| prints the last page with a "Thank You" message in the center.
+% \begin{docshot}
+% \documentclass[landscape,dark]{huawei}
+% \begin{document}
+% \PrintThankYouPage{}
+% \end{document}
+% \end{docshot}
% \DescribeMacro{\PrintDisclaimer}
-% |\PrintDisclaimer|
-% prints a paragraph at the bottom of the page with a standard disclaimer.
+% |\PrintDisclaimer| prints a paragraph at the bottom of the page with a standard disclaimer:
+% \begin{docshot}
+% \documentclass{huawei}
+% \begin{document}
+% \section{Introduction}
+% Hello, world!
+% \subsection{More Details}
+% Hello again!
+% \PrintDisclaimer
+% \end{document}
+% \end{docshot}
% \section{Best Practices}
@@ -275,51 +297,36 @@ Hello, world!
% In the landscape format it's recommended to use two columns, for better
% readability of the text. Here is how:
-
-%\iffalse
-%<*verb>
-%\fi
-\begin{verbatim}
-\documentclass{huawei}
-\begin{document}
-\newpage
-\begin{multicols}{2}
-\section*{First}
-Here goes the first column content.
-\columnbreak
-\section*{Second}
-Here goes the second column content.
-\end{multicols}
-\end{document}
-\end{verbatim}
-%\iffalse
-%</verb>
-%\fi
+% \begin{docshot}
+% \documentclass[landscape]{huawei}
+% \begin{document}
+% \newpage
+% \begin{multicols}{2}
+% \section*{First}
+% Here goes the first column content.
+% \columnbreak
+% \section*{Second}
+% Here goes the second column content.
+% \end{multicols}
+% \end{document}
+% \end{docshot}
% \subsection{Crumbs}
% When you need to put many small information pieces into one page,
% we recommend you to use ``crumbs'':
-
-%\iffalse
-%<*verb>
-%\fi
-\begin{verbatim}
-\documentclass{huawei}
-\begin{document}
-\newpage
-\section*{Project Details}
-\begin{multicols}{2}
-\raggedright
-\PrintCrumb{Budget}{\$100K}
-
-\PrintCrumb{Duration}{5 months}
-\end{multicols}
-\end{document}
-\end{verbatim}
-%\iffalse
-%</verb>
-%\fi
+% \begin{docshot}
+% \documentclass{huawei}
+% \begin{document}
+% \newpage
+% \section*{Project Details}
+% \begin{multicols}{2}
+% \raggedright
+% \PrintCrumb{Budget}{\$100K}
+% \PrintCrumb{Duration}{5 months}
+% \end{multicols}
+% \end{document}
+% \end{docshot}
% \StopEventually{}
@@ -402,6 +409,7 @@ Here goes the second column content.
\RequirePackage{enumitem}
\setlist{nosep}
\RequirePackage{microtype}
+\AddToHook{env/verbatim/begin}{\microtypesetup{protrusion=false}}
\RequirePackage{wrapfig}
\RequirePackage{lastpage}
\RequirePackage{tikz}