Skip to content

Commit

Permalink
Improved docs.
Browse files Browse the repository at this point in the history
  • Loading branch information
oliver-sanders committed May 31, 2016
1 parent e0879d1 commit a30ac8c
Showing 1 changed file with 18 additions and 3 deletions.
21 changes: 18 additions & 3 deletions doc/cug.tex
Original file line number Diff line number Diff line change
Expand Up @@ -2822,6 +2822,10 @@ \subsubsection{Graph Types}
graph = "delayed_cold_corge => corge"

# Repeat once at the final cycle point
[[[ R1/P0Y ]]]
graph = "end_garply"

# Repeat once at the final cycle point (alternative form)
[[[ R1/$ ]]]
graph = "end_garply"

Expand Down Expand Up @@ -2953,20 +2957,31 @@ \subsubsection{Graph Types}
[[dependencies]]
# Repeat once 12 hours after the initial cycle point
# Equivalent to [[[ R1/T12 ]]]
[[[ R1/^+PT12H ]]]
[[[ R1/^+PT12H ]]] # R[limit]/[date-time]
graph = "foo_check"

# Repeat once at the final cycle point
# Equivalent to [[[ R1//+P0D ]]]
[[[ R1/$ ]]]
[[[ R1/$ ]]] # R[limit]/[date-time]
graph = "foo => end"

# Repeat 3 hourly starting two days before the final cycle point
[[[ $-P2D/PT3H ]]]
[[[ $-P2D/PT3H ]]] # [date-time]/[interval]
graph = "foo => bar"
\end{lstlisting}
\lstset{language=transcript}

Note that there can be multiple ways to write the same headings, for instance
the following all repeat once at the final cycle point:

\lstset{language=suiterc}
\begin{lstlisting}
[[[ R1/P0Y ]]] # R[limit]/[interval]
[[[ R1/P0Y/$ ]]] # R[limit]/[interval]/[date-time]
[[[ R1/$ ]]] # R[limit]/[date-time]
\end{lstlisting}
\lstset{language=transcript}



\subparagraph{How Multiple Graph Strings Combine}
Expand Down

0 comments on commit a30ac8c

Please sign in to comment.