From: Richard Heck <rgheck@comcast.net>
Date: Fri, 4 Jun 2010 22:00:50 +0000 (+0000)
Subject: Documentation for RequiredArgs tag.
X-Git-Tag: 2.0.0~3183
X-Git-Url: https://git.lyx.org/gitweb/?a=commitdiff_plain;h=25810367848ffb0c52f0eec140f786a5755cb3a0;p=features.git

Documentation for RequiredArgs tag.


git-svn-id: svn://svn.lyx.org/lyx/lyx-devel/trunk@34593 a592a061-630c-0410-9148-cb99ea01b6c8
---

diff --git a/lib/doc/Customization.lyx b/lib/doc/Customization.lyx
index ad65ac3318..34dae5d44c 100644
--- a/lib/doc/Customization.lyx
+++ b/lib/doc/Customization.lyx
@@ -1,5 +1,5 @@
 #LyX 2.0.0svn created this file. For more info see http://www.lyx.org/
-\lyxformat 389
+\lyxformat 390
 \begin_document
 \begin_header
 \textclass scrbook
@@ -76,6 +76,7 @@ End
 
 \graphics default
 \default_output_format default
+\output_sync 0
 \bibtex_command default
 \index_command default
 \paperfontsize 12
@@ -11883,8 +11884,34 @@ int=0
 ] The number of optional arguments that can be used with this layout.
  This is useful for things like section headings, and only makes sense with
  LaTeX.
+ Note that, on output, the optional arguments will all precede any required
+ arguments (see below).
+ So one can have constructs like:
 \end_layout
 
+\begin_deeper
+\begin_layout LyX-Code
+
+\backslash
+mycmd[opt1]{req1}{contents of paragraph}
+\end_layout
+
+\begin_layout Standard
+but one cannot have things like: 
+\end_layout
+
+\begin_layout LyX-Code
+
+\backslash
+mycmd[opt1]{req1}[opt2]{contents of paragraph}
+\end_layout
+
+\begin_layout Standard
+at least, not without ERT (with which you can have anything).
+ 
+\end_layout
+
+\end_deeper
 \begin_layout Description
 \begin_inset Flex CharStyle:Code
 status collapsed
@@ -12170,6 +12197,49 @@ string
 \begin_inset Flex CharStyle:Code
 status collapsed
 
+\begin_layout Plain Layout
+RequiredArgs
+\end_layout
+
+\end_inset
+
+ [
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
+int=0
+\end_layout
+
+\end_inset
+
+] The number of required arguments that the LaTeX command or environment
+ corresponding to this layout expects.
+ In the case of a command, these are required arguments 
+\emph on
+other than
+\emph default
+ that associated with the content of the paragraph itself.
+ These do not actually have to be provided: LyX will output empty arguments
+ if necessary.
+ Note that optional arguments will be output before required arguments.
+ See the discussion of the 
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
+OptionalArgs
+\end_layout
+
+\end_inset
+
+ tag above for more information.
+\end_layout
+
+\begin_layout Description
+\begin_inset Flex CharStyle:Code
+status collapsed
+
 \begin_layout Plain Layout
 Requires 
 \end_layout