# [LON-CAPA-cvs] cvs: loncom /html/adm/help/tex Authoring_Output_Tags.tex

foxr lon-capa-cvs@mail.lon-capa.org
Mon, 14 Nov 2005 23:34:31 -0000

foxr		Mon Nov 14 18:34:31 2005 EDT

Modified files:
Log:
Add documentation for the attributes accepted by <displayduedate>  with possibly
too much detail on the format parameter.

--- loncom/html/adm/help/tex/Authoring_Output_Tags.tex:1.5	Thu Sep 29 17:13:07 2005
+++ loncom/html/adm/help/tex/Authoring_Output_Tags.tex	Mon Nov 14 18:34:31 2005
@@ -34,7 +34,69 @@
is not part of a course.
\item \textbf{displayduedate}\index{displayduedate}: This will insert the
current due date if one is set in the document. It is generated to
-be inside a table of 1x1 elements.
+be inside a table of 1x1 elements.  The displayduedate tag accepts
+The following attributes:
+   \begin{description}
+      \item{style=plain'' }  Makes the due date appear without any boxing.
+                               If the parameter value is other than  \emph{plain}'',
+			       or if the \textbf{style} parameter is omitted, the
+			       due date will be displayed within a box.
+      \item{format=fmt\_string''}
+                              Allows you to control the format of the due date.
+			      \emph{fmt\_string}'' is an arbitrary string that
+			      can contain any of the following formatting items:
+			      \begin{description}
+			         \item{\%a} Replaced by the abbreviated weekday
+				            name according to the current locale.
+			         \item{\%A} Replaced by the full weekday name
+				           according to the current locale.
+		                 \item{\%b} The abbreviated month name according to the
+				            current locale.
+			         \item{\%B} The full month name according to the
+                                            current locale.
+			         \item{\%c} The preferred date and time representation
+				            for the current locale (the default format
+					    string is just this).
+			         \item{\%C} The century number as a two digit integer
+				 \item{\%d} The day of the month as a decimal number.
+				            Leading zeroes are shown for single digit day numbers.
+				 \item{\%D} Equivalent to \%m/\%d/\%y
+				 \item{\%e} Like \%d but a leadnig zero is replaced by a space.
+				 \item{\%F} Equivalent to \%Y-\%m-\%d
+				 \item{\%G} The four digit year number.
+				 \item{\%g} The two digit year numbger.
+				 \item{\%H} The hour as a two digit number in the range 00 thorugh 23.
+				 \item{\%I} The hour as a two digit number in the range 00 through 12.
+				 \item{\%j} The day your the year in the range 001 through 366.
+				 \item{\%k} The hour (24 hour clock), single digits are preceded by a blank.
+				 \item{\%l} Like \%k but using a 12 hour clock.
+				 \item{\%m} The month as a two digit decimal number in the range 01 through 12.
+				 \item{\%M} The minute as a two digit decimal number in the range 00 through 59.
+				 \item{\%n} A newline character.
+				 \item{\%p} AM or PM depending on the time value.
+				 \item{\%P} am or pm.
+				 \item{\%r} The time in am or pm notation.
+				 \item{\%R} Time in 24 hour notatinon (\%H:\%M).  See also \%T below.
+				 \item{\%s} Number of seconds since midnight of January 1, 1970.
+				 \item{\%S} The second as a decimal number int the range 00 through 59.
+				 \item{\%t} A horizontal tab character.
+				 \item{\%T} The time in 24 hour notation (\%H:\%M:\%S).
+				 \item{\%u} Day of the week as a decimal number with Monday as 1.
+				 \item{\%U} The week number of the current year in the range 00 through 53.
+				            Week 1 is the week containing the first Sunday of the year.
+				 \item{\%V} Same as \%U but week 1 is the first week with at least 4 days,
+				            with Monday being the first day of a week.
+			         \item{\%w} Day of the week as a decimal integer in the range 0 through 7, Sunday is 0.
+				 \item{\%W} Week number of the current year in the range 00 through 53, where
+				            the first Monday of the year is the first day of week 01.
+			         \item{\%x} The preferred date notation in the current locale without the time.
+				 \item{\%X} The preferred time notation in the current locale without the date.
+				 \item{\%y} The year as a decimal number without the century (range 00 through 99).
+				 \item{\%Y} The year as a decimal number including the century.
+				 \item{\%\%} A \% character.
+				 \item{\%+} Date and time in the form returned by the Unix date command.
+			      \end{description}
+   \end{description}
\item \textbf{displaytitle}\index{displaytitle}: This will insert the title
of the problem from the metadata of the problem. Only the first \textbf{displaytitle}
in a problem will show the title; this allows clean usage of \textbf{displaytitle}