Skip to content

Commit

Permalink
cleanup in docs
Browse files Browse the repository at this point in the history
  • Loading branch information
jemmybutton committed Feb 7, 2022
1 parent 99b5b76 commit 4b197c6
Showing 1 changed file with 20 additions and 8 deletions.
28 changes: 20 additions & 8 deletions byrne-latex.tex
Original file line number Diff line number Diff line change
Expand Up @@ -604,7 +604,7 @@ \subsubsection{byNamedCircle(CIRCLES\_LIST)}\label{byNamedCircle}

\subsection{Arbitraty figures}

\subsubsection{byArbitraryFigureDefine.ArbitraryFigureName(figurePath, color, dashed, thick)}\label{byArbitraryFigureDefine}
\subsubsection{byArbitraryFigureDefine.ArbitraryFigureName(figurePath, col\-or, dashed, thick)}\label{byArbitraryFigureDefine}

Defines an arbitrary figure (basically, any path). Returns nothing.

Expand All @@ -618,7 +618,7 @@ \subsubsection{byArbitraryFigureDefine.ArbitraryFigureName(figurePath, color, da

\texttt{thick}~— is figure line thick. \texttt{0} for regular line and \texttt{1} for thin line \ref{lineWidth}.

\subsubsection{byArbitraryFigure.ArbitraryFigureName(figurePath, color, dashed, thick)}\label{byArbitraryFigure}
\subsubsection{byArbitraryFigure.ArbitraryFigureName(figurePath, color, dash\-ed, thick)}\label{byArbitraryFigure}

Defines an arbitrary figure. Returns nothing.

Expand Down Expand Up @@ -740,7 +740,7 @@ \subsubsection{byAngleDefineExtended.AngleName(A, B, C, color, style)(OPTIONAL\_

\texttt{OPTIONAL\_COLORS\_LIST}~— a comma-separated list of optional color names. See \ref{AngleStyles} for details.

\subsubsection{byAngleExtended.AngleName(A, B, C, color, style)(OPTIONAL\_COLORS\_LIST)}\label{byAngleExtended}
\subsubsection{byAngleExtended.AngleName(A, B, C, color, style)(OPTION\-AL\_COLORS\_LIST)}\label{byAngleExtended}

Defines and draws an angle based on three points. Returns a picture of the angle.

Expand Down Expand Up @@ -968,7 +968,11 @@ \section{\LaTeX\ part reference}

\subsection{General purpose}

\subsubsection{\textbackslash defineNewPicture[offspringPictureScaleFactor] [mainPictureScaleFactor] \{\METAPOST\ code\}}\label{defineNewPicture}
\sloppy

\subsubsection{\textbackslash defineNewPicture [offspringPicture\-Sca\-leFactor] [mainPicture\-Sca\-le\-Factor] \{\METAPOST\ code\}}\label{defineNewPicture}

\fussy

This macro is used to describe a main diagram.

Expand All @@ -994,8 +998,12 @@ \subsubsection{\textbackslash drawCurrentPicture}

% \addToUndefineList

\sloppy

\subsubsection{\textbackslash defineFromCurrentPicture \{verticalAlignment\} \{PictureName\} \{\METAPOST\ code\}}

\fussy

This macro is used to describe a diagram, based on the main diagram.

\texttt{verticalAlignment}~— vertical alignment declaration. \texttt{middle} to align the picture with the middle of the line, anything else for bottom alignment.
Expand All @@ -1006,8 +1014,12 @@ \subsubsection{\textbackslash defineFromCurrentPicture \{verticalAlignment\} \{P

Can be drawn using \texttt{\textbackslash PictureName}.

\subsubsection{\textbackslash drawFromCurrentPicture[verticalAlignment] [PictureName] \{\METAPOST\ code\}}
\sloppy

\subsubsection{\textbackslash drawFromCurrentPicture [verticalAlignment] [PictureName] \{\METAPOST\nolinebreak\ code\}}

\fussy

This macro is used to describe and draw a diagram, based on the main diagram.

\texttt{verticalAlignment}~— optional vertical alignment declaration. \texttt{middle} to align the picture with the middle of the line, anything else for bottom alignment.
Expand Down Expand Up @@ -1134,7 +1146,7 @@ \subsubsection{\textbackslash drawAngleWithSides \{AngleName\}}

Can be called later using \texttt{\textbackslash anglewithsidesAngleName}.

\subsubsection{\textbackslash drawPolygon[verticalAlignment][PolygonNewName]\{PolygonName\}}
\subsubsection{\textbackslash drawPolygon[verticalAlignment][PolygonNewName] \{Poly\-gon\-Na\-me\}}

Draws a polygon.

Expand Down Expand Up @@ -1214,15 +1226,15 @@ \subsubsection{\textbackslash drawPointL[verticalAlignment][LinesToOmit]\{PointN

\texttt{PointName}~— name of the point to reference in the main diagram.

If a list of lines to omit is given, can be called later using \texttt{\textbackslash pointlPointNameMinusLinesToOmit}, otherwise~— \texttt{\textbackslash pointlPointName}.
If a list of lines to omit is given, can be called later using \texttt{\textbackslash pointl\-Point\-Name\-Minus\-Lines\-To\-Omit}, otherwise~— \texttt{\textbackslash pointlPointName}.

\subsubsection{\textbackslash drawPoint[verticalAlignment][LinesToOmit]\{PointName\}}

Draws a point, depicted as line segments starting/ending in it with a point mark if defined \drawPoint{A}. Only the lines which were actually drawn, not just defined, are used.

Arguments are the same as in \texttt{drawPointL} \ref{drawPointL}.

If a list of lines to omit is given, can be called later using \texttt{\textbackslash pointPointNameMinusLinesToOmit}, otherwise~— \texttt{\textbackslash pointPointName}.
If a list of lines to omit is given, can be called later using \texttt{\textbackslash point\-Point\-Name\-Minus\-Lines\-To\-Omit}, otherwise~— \texttt{\textbackslash pointPointName}.

%\drawMagnitude

Expand Down

0 comments on commit 4b197c6

Please sign in to comment.