]> git.lyx.org Git - features.git/blobdiff - lib/examples/PDF-form.lyx
PDF-form.lyx: some corrections and updates
[features.git] / lib / examples / PDF-form.lyx
index b6808599944f92f7f5003d5f89e7c11bf4e4d709..8498335b5c23d1e093a8aaefb017a4341188c2fd 100644 (file)
@@ -147,6 +147,7 @@ pdfform
 \begin_body
 
 \begin_layout Begin PDF Form
+
 \begin_inset Argument 1
 status open
 
@@ -179,7 +180,7 @@ insdljs
 \series default
  must be installed.
  If it is not installed you can export the document anyway but the example
- in the section about dynamic form fields won't appear in the output.
+ in the section about dynamic form elements will not appear in the output.
 \end_layout
 
 \end_inset
@@ -348,7 +349,7 @@ reference "subsec:Submit-button"
 \end_layout
 
 \begin_layout Section
-Form fields
+Form elements
 \end_layout
 
 \begin_layout Standard
@@ -407,12 +408,12 @@ Enter your name here:
 \end_layout
 
 \begin_layout Standard
-You must also specify a name for text fields: Set the cursor into its 
+You must also specify a name for text fields.
+ To do this set the cursor into its 
 \family sans
 Params
 \family default
- inset.
- There insert the parameter 
+ inset and insert the parameter 
 \series bold
 name=customer
 \series default
@@ -435,8 +436,8 @@ Here are 2
 \begin_inset space ~
 \end_inset
 
-fields as example: Fill one and see that the other one will also be filled
- automatically when you click outside of the field:
+fields as example: Fill one and see that the other one will be filled automatica
+lly when you click outside of the field:
 \begin_inset Newline newline
 \end_inset
 
@@ -534,7 +535,7 @@ status open
 \begin_layout Plain Layout
 name=customer2, multiline, width=0.6
 \backslash
-textwidth, height=3cm, value={Testman}
+textwidth, height=3cm, value={proposed text}
 \end_layout
 
 \end_inset
@@ -631,7 +632,7 @@ name=age
 \series bold
 age
 \series default
- is the field name) into the 
+ is the name) into the 
 \family sans
 Params
 \family default
@@ -654,11 +655,7 @@ Insert\SpecialChar menuseparator
 Label
 \family default
 .
- Insert the label text into this inset.
-\begin_inset Newline newline
-\end_inset
-
-The different choices are inserted to the inset as comma-separated list.
+ The different choices are inserted to the inset as comma-separated list.
  There are 3
 \begin_inset space ~
 \end_inset
@@ -677,8 +674,7 @@ Combo The choices are listed in a combo box (dropdown list) but the user
 
 \begin_layout Description
 Popdown All choices are listed below each other.
- If the field is not high enough a scroll bar is automatically added to
- the field.
+ If the menu is not high enough a scroll bar is automatically added.
 \end_layout
 
 \begin_layout Standard
@@ -993,7 +989,15 @@ status collapsed
 \end_inset
 
 What the hell? Now you destroyed your fridge.
- Congratulations.
+\begin_inset Quotes eld
+\end_inset
+
+Congratulations.
+\begin_inset Quotes erd
+\end_inset
+
+
 \begin_inset ERT
 status collapsed
 
@@ -1028,7 +1032,15 @@ status collapsed
 \end_inset
 
 What the hell? Now you destroyed your fridge.
- Congratulations.
+\begin_inset Quotes eld
+\end_inset
+
+Congratulations.
+\begin_inset Quotes erd
+\end_inset
+
+
 \begin_inset ERT
 status collapsed
 
@@ -1061,7 +1073,8 @@ status open
 \series bold
 Note:
 \series default
- All quote characters in form parameters must be inserted as \SpecialChar TeX
+ The outer quotes are part of the JavaScript code and must therefore be
+ inserted as \SpecialChar TeX
  code!
 \end_layout
 
@@ -1072,11 +1085,7 @@ Note:
 
 \begin_layout Standard
 A common usage for push buttons is to open a weblink.
- Such a button is created by inserting a hyperlink into the 
-\family sans
-PushButton
-\family default
- inset.
+ Such a button is created by inserting a hyperlink as button text.
  Here is an example:
 \end_layout
 
@@ -1111,7 +1120,7 @@ target "http://wiki.lyx.org"
 \end_layout
 
 \begin_layout Standard
-To get rid of the special frame for weblinks add this to the additional
+To get rid of the predefined frame for weblinks add this to the additional
  options in the document settings under 
 \family sans
 PDF
@@ -1182,8 +1191,8 @@ Send your data via email
 The submit button creates a forms data format (FDF) file (file extension
  *.fdf) which is then submitted.
  The FDF file contains only the form data.
- They can only be applied to a PDF form if all elements in the form have
- a name.
+ They can later only be applied to a PDF form if all elements in the form
have a name.
 \end_layout
 
 \begin_layout Standard
@@ -1221,7 +1230,7 @@ reference "sec:Preparation"
 
  for the description.
  If there are no specifications you will get \SpecialChar LaTeX
- errors!
+ errors.
 \end_layout
 
 \end_inset
@@ -1390,10 +1399,6 @@ Button
 Style
 \end_layout
 
-\begin_layout Text Field Style
-
-\end_layout
-
 \begin_layout Standard
 The content of the styles is a comma-separated list of parameters.
  The possible parameters are listed in sec.
@@ -1426,7 +1431,7 @@ key "hyperref"
 print
 \emph default
  is always part of the definition.
- Otherwise the fields will not appear in the PDF.
+ Otherwise the elements will not appear in the PDF.
  The defined style is applied to all elements following the definition.
 \end_layout
 
@@ -1435,37 +1440,99 @@ Here are some examples:
 \end_layout
 
 \begin_layout Text Field Style
+
 print, bordercolor=red, borderstyle=U, backgroundcolor=lightgray, color=lime,
  maxlen=10, align=2, charsize=16pt
+\begin_inset Note Note
+status open
+
+\begin_layout Plain Layout
+The parameter 
+\series bold
+borderstyle
+\series default
+ can be 
+\series bold
+U
+\series default
+ (underlined), 
+\series bold
+S
+\series default
+ (solid), 
+\series bold
+D
+\series default
+ (dashed), 
+\series bold
+B
+\series default
+ (bevel) or 
+\series bold
+I
+\series default
+ (inverted bevel).
+\end_layout
+
+\end_inset
+
+
 \end_layout
 
 \begin_layout Check Box Style
+
 print, borderstyle=S, checkboxsymbol=
 \backslash
 ding{55}
 \end_layout
 
 \begin_layout Combo Box Style
+
 print, bordercolor={0.33 0.66 0.33}, borderstyle=D
 \end_layout
 
 \begin_layout Popdown Box Style
+
 print, menulength=2
+\begin_inset Note Note
+status collapsed
+
+\begin_layout Plain Layout
+The parameter
+\series bold
+ menulength
+\series default
+ determines the number of displayed menu entries.
+ It does not work currently because of a bug in the \SpecialChar LaTeX
+ package 
+\series bold
+hyperref
+\series default
+.
+\end_layout
+
+\end_inset
+
+
 \end_layout
 
 \begin_layout Radio Box Style
+
 print, borderstyle=I, radiosymbol=3
 \end_layout
 
 \begin_layout Push Button Style
+
 print, borderstyle=B, bordercolor=lime
 \end_layout
 
 \begin_layout Submit Button Style
+
 print, borderwidth=0, bordercolor=white
 \end_layout
 
 \begin_layout Reset Button Style
+
 print, bordercolor=lime
 \end_layout
 
@@ -1542,43 +1609,6 @@ Show border hover color for fields
 \end_inset
 
 
-\end_layout
-
-\begin_layout Standard
-\begin_inset Note Greyedout
-status open
-
-\begin_layout Plain Layout
-The option 
-\series bold
-borderstyle
-\series default
- can be 
-\series bold
-U
-\series default
- (underlined), 
-\series bold
-S
-\series default
- (solid), 
-\series bold
-D
-\series default
- (dashed), 
-\series bold
-B
-\series default
- (bevel) or 
-\series bold
-I
-\series default
- (inverted bevel).
-\end_layout
-
-\end_inset
-
-
 \end_layout
 
 \begin_layout Itemize
@@ -1637,7 +1667,12 @@ number
 \begin_inset space ~
 \end_inset
 
-2 of 
+2 of the documentation of the \SpecialChar LaTeX
+ package 
+\series bold
+pifont
+\series default
+, 
 \begin_inset CommandInset citation
 LatexCommand cite
 key "pifont"
@@ -1741,9 +1776,9 @@ status open
 \begin_layout Plain Layout
 
 \series bold
-Note
+Note
 \series default
- that the option
+The parameter
 \series bold
 borderstyle B
 \series default
@@ -1808,6 +1843,47 @@ Sex:
 
 \end_layout
 
+\begin_layout Standard
+\begin_inset VSpace defskip
+\end_inset
+
+
+\begin_inset Note Greyedout
+status open
+
+\begin_layout Plain Layout
+
+\series bold
+Note:
+\series default
+ The parameters 
+\series bold
+backgroundcolor
+\series default
+, 
+\series bold
+color
+\series default
+, 
+\series bold
+height 
+\series default
+and 
+\series bold
+width
+\series default
+ have no effect for push, submit and reset buttons.
+\end_layout
+
+\end_inset
+
+
+\end_layout
+
+\begin_layout Standard
+As workaround use a colored box and/or color the box text.
+\end_layout
+
 \begin_layout Itemize
 Push button with a bevel border and colored text:
 \begin_inset VSpace defskip
@@ -1886,49 +1962,12 @@ Don't click on this button!!!
 \end_inset
 
 
-\end_layout
-
-\begin_layout Standard
-\begin_inset VSpace defskip
-\end_inset
-
-
-\begin_inset Note Greyedout
-status open
-
-\begin_layout Plain Layout
-
-\series bold
-Note
-\series default
-: The options 
-\series bold
-backgroundcolor
-\series default
-, 
-\series bold
-color
-\series default
-, 
-\series bold
-height 
-\series default
-and 
-\series bold
-width
-\series default
- have no effect for push, submit and reset buttons.
-\end_layout
-
+\begin_inset VSpace bigskip
 \end_inset
 
 
 \end_layout
 
-\begin_layout Standard
-As workaround use a colored box and/or color the box text.
-\end_layout
-
 \begin_layout Itemize
 Submit button without border, with cyan background and increased height:
 \begin_inset VSpace defskip
@@ -1953,6 +1992,25 @@ name=submit2
 \end_inset
 
 
+\begin_inset Box Frameless
+position "c"
+hor_pos "c"
+has_inner_box 1
+inner_pos "c"
+use_parbox 0
+use_makebox 1
+width "6cm"
+special "none"
+height "1in"
+height_special "totalheight"
+thickness "0.4pt"
+separation "3pt"
+shadowsize "4pt"
+framecolor "black"
+backgroundcolor "cyan"
+status open
+
+\begin_layout Plain Layout
 \begin_inset Box Frameless
 position "c"
 hor_pos "c"
@@ -1960,7 +2018,7 @@ has_inner_box 1
 inner_pos "c"
 use_parbox 1
 use_makebox 0
-width "5cm"
+width "4.5cm"
 special "none"
 height "4in"
 height_special "totalheight"
@@ -1968,7 +2026,7 @@ thickness "0.4pt"
 separation "3pt"
 shadowsize "4pt"
 framecolor "black"
-backgroundcolor "cyan"
+backgroundcolor "none"
 status open
 
 \begin_layout Plain Layout
@@ -1983,6 +2041,11 @@ Send your data via mail
 \end_inset
 
 
+\end_layout
+
+\end_inset
+
+
 \begin_inset VSpace bigskip
 \end_inset
 
@@ -2057,12 +2120,12 @@ Reset the form
 \end_layout
 
 \begin_layout Section
-PDF viewer action buttons
+PDF action buttons
 \end_layout
 
 \begin_layout Standard
-One often needs basic actions to be done by the PDF viewer program.
For example to print the form.
+One often needs basic actions to be done by the PDF viewer program, for
+ example to print the form.
  Such PDF program-specific actions can be triggered by adding inserting
  the custom inset 
 \family sans
@@ -2321,6 +2384,7 @@ Save form as
 \end_layout
 
 \begin_layout PDF Link Setup
+
 pdfborder={0 0 0}
 \begin_inset Note Note
 status open
@@ -2341,7 +2405,15 @@ To customize the border color, border thickness and the distance to the
 \begin_inset space \thinspace{}
 \end_inset
 
-pt thick, teal border:
+pt thick, teal border and 3
+\begin_inset space \thinspace{}
+\end_inset
+
+pt border separation :
+\begin_inset VSpace defskip
+\end_inset
+
+
 \begin_inset Newline newline
 \end_inset
 
@@ -2453,7 +2525,7 @@ Note:
 \series bold
 pdfborder
 \series default
- affects all link types, not only the menu links.
+ affects all link types, not only the action links.
 \end_layout
 
 \end_inset
@@ -2462,6 +2534,7 @@ pdfborder
 \end_layout
 
 \begin_layout PDF Link Setup
+
 pdfborder={0 0 4}
 \end_layout
 
@@ -2552,6 +2625,7 @@ menubordercolor
 \end_layout
 
 \begin_layout PDF Link Setup
+
 pdfborder={0 0 1}, menubordercolor={0.1 0.9 0.5}
 \end_layout
 
@@ -2617,6 +2691,7 @@ To change the background color use a colored box.
 \end_layout
 
 \begin_layout PDF Link Setup
+
 pdfborder={0 0 0}
 \end_layout
 
@@ -2674,16 +2749,17 @@ Save form as
 \end_layout
 
 \begin_layout PDF Link Setup
+
 pdfborder={0 0 1}, menubordercolor={1 0 0}
 \end_layout
 
 \begin_layout Section
-Dynamic form fields
+Dynamic form elements
 \end_layout
 
 \begin_layout Standard
-It is also possible to have dynamic form fields.
- This means that depending on the actions of the user fields can (dis)appear
+It is also possible to have dynamic form elements.
+ This means that depending on the actions of the user elements can (dis)appear
  or change their appearance.
  To use this feature, add these lines to your LaTeX preamble:
 \end_layout
@@ -3171,6 +3247,7 @@ fi
 \end_layout
 
 \begin_layout End PDF Form
+
 \begin_inset Note Note
 status open
 
@@ -3191,12 +3268,6 @@ General notes
 Submitting and applying data requires that all form elements have a name.
 \end_layout
 
-\begin_layout Itemize
-All braces, brackets, backslashes and quote characters in form parameters
- must be inserted as \SpecialChar TeX
- code!
-\end_layout
-
 \begin_layout Itemize
 Creating a PDF form requires pdflatex or lualatex.
  Use therefore either the \SpecialChar LyX