summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/doc/context/third/gantt/gantt.txt
diff options
context:
space:
mode:
Diffstat (limited to 'Master/texmf-dist/doc/context/third/gantt/gantt.txt')
-rw-r--r--Master/texmf-dist/doc/context/third/gantt/gantt.txt58
1 files changed, 58 insertions, 0 deletions
diff --git a/Master/texmf-dist/doc/context/third/gantt/gantt.txt b/Master/texmf-dist/doc/context/third/gantt/gantt.txt
new file mode 100644
index 00000000000..3ec64a526ad
--- /dev/null
+++ b/Master/texmf-dist/doc/context/third/gantt/gantt.txt
@@ -0,0 +1,58 @@
+Gantt is a module for drawing Gantt charts via metapost or pgf/tikz.
+
+== Description ==
+In the following you will find a short description of environments and commands:
+
+=== Gantt ===
+The gantt environment draws the canvas of a gantt figure.
+\startgantt[…]{no of Tasks to plot}{no of time slots}
+The optional argument […] can be filled in a key=value syntax, using one or more of the following keys:
+* sf - scale factor for metapost (default: 1)
+* xunitlength - length of one time slot (default: 1cm)
+* fontsize - fontsize of labels (default: \tf)
+* titlefontsize - fontsize of title section (default: \tfx)
+* drawledgerline - Switch to enable/disable the drawing of horizontal ledger lines (default value: false)
+
+=== Ganttitle ===
+This is the environment for drawing the title section.
+\startganttitle (…) \stopganttitle
+
+=== Titleelement ===
+This draws one element of the title.
+\titleelement{label}{length}
+
+=== Numtitle ===
+This draws a numbered sequence of title elements.
+\numtitle{start number}{increment}{end number}{length of each title element}
+
+=== Ganttbar ===
+This draws a single, unconnected bar for representing a task.
+\ganttbar[pattern=value,color=value]{label}{start}{length}
+where the optional comma separated arguments are:
+* <pattern> - is a tikz pattern (e.g. north east lines (default), north west lines, crosshatch, crosshatch dots, grid, …)
+* <color> - a color of the pattern (e.g. black (default), red, green blue gray, dark gray)
+
+=== Ganttcon ===
+This draws an arrow between the bars specified by coordinates.
+\ganttcon{startx}{starty}{endx}{endy}
+
+=== Ganttbarcon ===
+This draws a single bar and connects the bar with the previous bar for consecutive tasks.
+\ganttbarcon[pattern=value,color=value]{label}{start}{length}
+The optional pattern argument are the same as for \ganttbar.
+
+=== Ganttgroup ===
+This draws a bar to group tasks.
+\ganttgroup{label}{start}{length}
+
+=== Ganttmilestone ===
+This draws a milestone using a diamond.
+\ganttmilestone[color=value]{label}{start}
+The optional color argument argument is:
+* <color> - a color of the pattern (e.g. black (default), red, green blue gray, dark gray)
+
+=== Ganttmilestonecon ===
+This draws a milestone using a diamond and connects the milestone with the previous bar or milestone.
+\ganttmilestonecon[color=value]{label}{start}
+The optional color argument argument is:
+* <color> - a color of the pattern (e.g. black (default), red, green blue gray, dark gray)