-#LyX 2.1 created this file. For more info see http://www.lyx.org/
-\lyxformat 474
+#LyX 2.3 created this file. For more info see http://www.lyx.org/
+\lyxformat 544
\begin_document
\begin_header
+\save_transient_properties true
+\origin /systemlyxdir/examples/
\textclass scrartcl
\begin_preamble
-% to be able to use custom colors
-\usepackage[svgnames,rgb]{xcolor}
-
-% ------------------------------------
% used to check for needed LaTeX packages
\usepackage{ifthen}
\newboolean{insdljs}
\IfFileExists{insdljs.sty}
{\usepackage[pdftex]{insdljs}
- \setboolean{insdljs}{true}}
+ \setboolean{insdljs}{true}
+ \pdfcatalog{/AA \the\pdflastobj\space 0 R}}
{\setboolean{insdljs}{false}}
-\pdfcatalog{/AA \the\pdflastobj\space 0 R}
-
\ifinsdljs % only execute if package insdljs is installed
\begin{insDLJS}[exaaae]{exaaae}{JavaScript}
this.delay = true;
if((event.value == "u") || (event.value == "unlimited")) {
this.getField("from").display = display.hidden;
- this.getField("to").display = display.hidden;
+ this.getField("until").display = display.hidden;
} else {
this.getField("from").display = display.visible;
- this.getField("to").display = display.visible;
+ this.getField("until").display = display.visible;
this.getField("from").setFocus();
}
this.delay = false;
\language_package default
\inputencoding auto
\fontencoding global
-\font_roman default
-\font_sans default
-\font_typewriter default
-\font_math auto
+\font_roman "default" "default"
+\font_sans "default" "default"
+\font_typewriter "default" "default"
+\font_math "auto" "auto"
\font_default_family default
\use_non_tex_fonts false
\font_sc false
\font_osf false
-\font_sf_scale 100
-\font_tt_scale 100
+\font_sf_scale 100 100
+\font_tt_scale 100 100
+\use_microtype false
+\use_dash_ligatures false
\graphics default
-\default_output_format default
+\default_output_format pdf2
\output_sync 0
\bibtex_command bibtex
\index_command default
\pdf_colorlinks false
\pdf_backref false
\pdf_pdfusetitle false
-\pdf_quoted_options "linkcolor=black, citecolor=black, urlcolor=blue, filecolor=blue, pdfpagelayout=OneColumn, pdfnewwindow=true, pdfstartview=XYZ, plainpages=false, urlbordercolor={1 0 0}"
+\pdf_quoted_options "pdfpagelayout=OneColumn, pdfnewwindow=true, pdfstartview=XYZ, plainpages=false, urlbordercolor={1 0 0}"
\papersize a4paper
\use_geometry false
\use_package amsmath 1
\use_package amssymb 1
-\use_package cancel 0
+\use_package cancel 1
\use_package esint 1
\use_package mathdots 1
\use_package mathtools 1
\use_package mhchem 1
-\use_package stackrel 0
-\use_package stmaryrd 0
-\use_package undertilde 0
+\use_package stackrel 1
+\use_package stmaryrd 1
+\use_package undertilde 1
\cite_engine basic
\cite_engine_type default
\biblio_style plain
\suppress_date true
\justification true
\use_refstyle 0
+\use_minted 0
\notefontcolor #0000ff
\index Index
\shortcut idx
\tocdepth 2
\paragraph_separation skip
\defskip medskip
-\quotes_language english
+\is_math_indent 0
+\math_numbering_side default
+\quotes_style english
+\dynamic_quotes 0
\papercolumns 1
\papersides 1
\paperpagestyle default
status open
\begin_layout Plain Layout
+
action=mailto:forms@lyx.test?subject=The submitted PDF form, method=post
\end_layout
status open
\begin_layout Plain Layout
-To export all parts of this document to PDF the LaTeX-package
+To export all parts of this document to PDF the \SpecialChar LaTeX
+-package
\series bold
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
Form
\family default
- from LyX's dropdown menu at the beginning of the document.
+ from \SpecialChar LyX
+'s dropdown menu at the beginning of the document.
If only a part of the document should be a form, add
\family sans
Begin
environment.
This is done by using the menu
\family sans
-Insert\SpecialChar \menuseparator
+Insert\SpecialChar menuseparator
PDF
\begin_inset space ~
\end_inset
-form
+Form
\begin_inset space ~
\end_inset
-parameters
+Parameters
\family default
.
For example in this document the following was inserted to the parameter
\begin_inset Quotes erd
\end_inset
- and the HTML method is
+ and the submit method is
\series bold
post
\series default
\begin_inset CommandInset ref
LatexCommand ref
-reference "sub:Submit-button"
+reference "subsec:Submit-button"
\end_inset
\end_layout
\begin_layout Section
-Form fields
+Form elements
\end_layout
\begin_layout Standard
\begin_inset space ~
\end_inset
-possible types of fields in a PDF form:
+possible elements in a PDF form:
\end_layout
\begin_layout Subsection
\family default
using the menu
\family sans
-Insert\SpecialChar \menuseparator
+Insert\SpecialChar menuseparator
Custom
\begin_inset space ~
\end_inset
status open
\begin_layout Plain Layout
-
\begin_inset Argument 1
status open
\end_layout
\begin_layout Standard
-You must also specify a field 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 for example the parameter
+ inset and insert the parameter
\series bold
name=customer
\series default
is the field name).
\end_layout
-\begin_layout Standard
-\begin_inset Note Greyedout
-status open
-
-\begin_layout Plain Layout
-
-\series bold
-Note:
-\series default
- All braces and brackets in form parameters must be inserted as TeX code!
-\end_layout
-
-\end_inset
-
-
-\end_layout
-
\begin_layout Standard
Using the same name for several text fields results in an automatic duplication
of the inserted text.
\begin_inset space ~
\end_inset
-fields as example: Fill one and see that the other one will also be filled
- automatically:
+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
status open
\begin_layout Plain Layout
-
\begin_inset Argument 1
status open
status open
\begin_layout Plain Layout
-
\begin_inset Argument 1
status open
\end_inset
+\end_layout
+
+\begin_layout Standard
+\begin_inset Note Greyedout
+status open
+
+\begin_layout Plain Layout
+
+\series bold
+Note:
+\series default
+ Special characters should be avoided in element names.
+\end_layout
+
+\end_inset
+
+
\end_layout
\begin_layout Standard
status open
\begin_layout Plain Layout
-
\begin_inset Argument 1
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
\series bold
Note:
\series default
- It is highly recommended to use a uniform layout of all fields in your
- form.
+ It is highly recommended to use a uniform layout of all fields in a form.
See sec.
\begin_inset space \thinspace{}
\end_inset
\begin_inset CommandInset ref
LatexCommand ref
-reference "sec:Form-field-customization"
+reference "sec:Form-element-customization"
\end_inset
- for how this is done.
+ how this is done.
\end_layout
\end_inset
status open
\begin_layout Plain Layout
-
\begin_inset Argument 1
status open
\end_layout
\begin_layout Standard
-You must also specify a field name for check boxes: Insert for example the
- parameter
+You must specify also for check boxes a name.
+ Insert e.
+\begin_inset space \thinspace{}
+\end_inset
+
+g.
+\begin_inset space \space{}
+\end_inset
+
+the parameter
\series bold
name=age
\series default
\series bold
age
\series default
- is the field name) into the
+ is the name) into the
\family sans
Params
\family default
.
A label for the inset is added by using the menu
\family sans
-Insert\SpecialChar \menuseparator
+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
\begin_layout Description
Combo The choices are listed in a combo box (dropdown list) but the user
- is allowed to choose something that is not in the predefined list.
+ is allowed to input something that is not in the predefined list.
\end_layout
\begin_layout Description
Popdown All choices are listed below each other.
- It the filed 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
-To determine the choice menu type, add the parameter
+To determine the choice menu type one uses the parameter
\series bold
radio
\series default
status open
\begin_layout Plain Layout
-
\begin_inset Argument 1
status open
status open
\begin_layout Plain Layout
-
\begin_inset Argument 1
status open
status open
\begin_layout Plain Layout
-
\begin_inset Argument 1
status open
\end_layout
\begin_layout Standard
-You must also specify a field name for choice menus: Insert for example
- the parameter
+You must also specify a name for choice menus.
+ Insert for example the parameter
\series bold
name=country
\series default
\series bold
country
\series default
- is the field name) into the
+ is the name) into the
\family sans
Params
\family default
\end_inset
.
- By specifying names you can also preset/propose e.g.
+ With the name you can also preset/propose e.g.
\begin_inset space \space{}
\end_inset
status open
\begin_layout Plain Layout
-
\begin_inset Argument 1
status open
\end_inset
-\end_layout
-
-\begin_layout Standard
-\begin_inset Note Greyedout
-status open
-
-\begin_layout Plain Layout
-
-\series bold
-Note:
-\series default
- Due to a bug in the LaTeX package
-\series bold
-hyperref
-\series default
- it is currently only possible the set the first choice as default.
-\end_layout
-
-\end_inset
-
-
-\end_layout
-
-\begin_layout Standard
-\begin_inset Newpage newpage
-\end_inset
-
-
\end_layout
\begin_layout Subsection
status open
\begin_layout Plain Layout
-
\begin_inset Argument 1
status open
\begin_layout Standard
The action that is triggered by pressing the button is specified by JavaScript
code.
- To specify it, add the parameter
+ To do this, add the parameter
\series bold
onclick={}
\series default
and insert the JavaScript code between the braces.
+ For info about JavaScript, see its documentation,
+\begin_inset CommandInset citation
+LatexCommand cite
+key "JavaScript"
+literal "true"
+
+\end_inset
+
+.
+ In the following example this JavaScript code was used:
+\begin_inset Newline newline
+\end_inset
+
+
+\series bold
+app.alert(
+\begin_inset ERT
+status collapsed
+
+\begin_layout Plain Layout
+
+"
+\end_layout
+
+\end_inset
+
+What the hell? Now you destroyed your fridge.
+
+\begin_inset Quotes eld
+\end_inset
+
+Congratulations.
+\begin_inset Quotes erd
+\end_inset
+
+
+\begin_inset ERT
+status collapsed
+
+\begin_layout Plain Layout
+
+"
+\end_layout
+
+\end_inset
+
+)
\end_layout
\begin_layout Standard
status open
\begin_layout Plain Layout
-
\begin_inset Argument 1
status open
\begin_layout Plain Layout
-onclick={app.alert("What the hell? Now you destroyed your fridge.
- Congratulations.")}
+onclick={app.alert(
+\begin_inset ERT
+status collapsed
+
+\begin_layout Plain Layout
+
+"
\end_layout
\end_inset
-Don't click on this button or your fridge will be destroyed!!!
-\end_layout
+What the hell? Now you destroyed your fridge.
+
+\begin_inset Quotes eld
+\end_inset
+Congratulations.
+\begin_inset Quotes erd
\end_inset
-\end_layout
+\begin_inset ERT
+status collapsed
-\begin_layout Standard
-For info about JavaScript, see its documentation,
-\begin_inset CommandInset citation
-LatexCommand cite
-key "JavaScript"
+\begin_layout Plain Layout
+
+"
+\end_layout
\end_inset
-.
+)}
\end_layout
-\begin_layout Standard
-A common usage for pus buttons is to open a weblink.
- Such a button is created by inserting the command
-\series bold
+\end_inset
-\backslash
-href
-\series default
- into the button inset.
-
-\series bold
+Don't click on this button or your fridge will be destroyed!!!
+\end_layout
-\backslash
-href
-\series default
- is used in the scheme
-\begin_inset Newline newline
\end_inset
-\series bold
-
-\backslash
-href{link target}{text}
\end_layout
\begin_layout Standard
-In the following button this code was used:
-\begin_inset Newline newline
-\end_inset
+\begin_inset Note Greyedout
+status open
+\begin_layout Plain Layout
\series bold
+Note:
+\series default
+ The outer quotes are part of the JavaScript code and must therefore be
+ inserted as \SpecialChar TeX
+ code!
+\end_layout
-\backslash
-href{http://wiki.lyx.org}{Information how to fill out this form}
+\end_inset
+
+
+\end_layout
+
+\begin_layout Standard
+A common usage for push buttons is to open a weblink.
+ Such a button is created by inserting a hyperlink as button text.
+ Here is an example:
\end_layout
\begin_layout Standard
status open
\begin_layout Plain Layout
-
\begin_inset Argument 1
status open
\end_inset
-\backslash
-href{http://wiki.lyx.org}{Information how to fill out this form}
+\begin_inset CommandInset href
+LatexCommand href
+name "Information how to fill out this form"
+target "https://wiki.lyx.org"
+literal "false"
+
+\end_inset
+
+
\end_layout
\end_inset
\end_layout
\begin_layout Standard
-To get rid of the frame for weblinks add this to the additional options
- in the document settings under
+To get rid of the predefined frame for weblinks add this to the additional
+ options in the document settings under
\family sans
PDF
\begin_inset space ~
Submit button
\begin_inset CommandInset label
LatexCommand label
-name "sub:Submit-button"
+name "subsec:Submit-button"
\end_inset
SubmitButton
\family default
.
- Write inside the inset the label for the button.
+ The label for the button is written into the inset.
Here is an example:
\end_layout
status open
\begin_layout Plain Layout
-
\begin_inset Argument 1
status open
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 fields 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
Note:
\series default
You can only use a submit button if you specified the submit method and
- target in the PDF form environment options! See sec.
+ a target in the inset
+\family sans
+PDF
+\begin_inset space ~
+\end_inset
+
+Form
+\begin_inset space ~
+\end_inset
+
+Parameters
+\family default
+! See sec.
\begin_inset space \thinspace{}
\end_inset
\end_inset
for the description.
- If there are no specifications you will get LaTeX errors!
-\end_layout
-
-\end_inset
-
-
-\end_layout
-
-\begin_layout Standard
-\begin_inset Note Greyedout
-status open
-
-\begin_layout Plain Layout
-
-\series bold
-Note:
-\series default
- If you have more than one submit button in your document you must specify
- a name for each of them to avoid LaTeX errors! For example add
-\series bold
-name=submit1
-\series default
- (where
-\series bold
-submit1
-\series default
- is the button name).
+ If there are no specifications you will get \SpecialChar LaTeX
+ errors.
\end_layout
\end_inset
\end_layout
\begin_layout Standard
-A reset button is used to reset all form fields to the initial state.
+A reset button is used to reset all form elements to the initial state.
It is added by inserting the custom inset
\family sans
ResetButton
\family default
.
- Write inside the inset the label for the button.
+ The label for the button is written into the inset.
Here is an example:
\end_layout
status open
\begin_layout Plain Layout
-
\begin_inset Argument 1
status open
\end_inset
-\end_layout
-
-\begin_layout Standard
-\begin_inset Note Greyedout
-status open
-
-\begin_layout Plain Layout
-
-\series bold
-Note:
-\series default
- If you have more than one reset button in your document you must specify
- a name for each of them to avoid LaTeX errors! For example add
-\series bold
-name=reset1
-\series default
- (where
-\series bold
-reset1
-\series default
- is the button name).
-\end_layout
-
-\end_inset
-
-
\end_layout
\begin_layout Section
-Form field customization
+Form element customization
\begin_inset CommandInset label
LatexCommand label
-name "sec:Form-field-customization"
+name "sec:Form-element-customization"
\end_inset
\begin_inset space ~
\end_inset
-Style
+Style
\end_layout
\begin_layout Description
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.
\begin_inset Quotes erd
\end_inset
- of the documentation of the LaTeX package
+ of the documentation of the \SpecialChar LaTeX
+ package
\series bold
hyperref
\series default
\begin_inset CommandInset citation
LatexCommand cite
key "hyperref"
+literal "true"
\end_inset
.
- It is important that the parameter print is always part of the definition,
- otherwise the fields won't appear in the PDF output.
- The defined style is applied to all fields following the definition.
+ It is important that the parameter
+\emph on
+print
+\emph default
+ is always part of the definition.
+ Otherwise the elements will not appear in the PDF.
+ The defined style is applied to all elements following the definition.
\end_layout
\begin_layout Subsubsection*
\begin_layout Text Field Style
print, bordercolor=red, borderstyle=U, backgroundcolor=lightgray, color=lime,
maxlen=10, align=2, charsize=16pt
-\end_layout
+\begin_inset Note Note
+status open
-\begin_layout Check Box Style
-print, borderstyle=S, checkboxsymbol=
-\backslash
-ding{55}
-\end_layout
+\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
\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=6
+print, borderstyle=I, radiosymbol=3
\end_layout
\begin_layout Push Button Style
status open
\begin_layout Plain Layout
-
\begin_inset Argument 1
status open
\end_layout
-\begin_layout Standard
-The
-\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
-
\begin_layout Standard
\begin_inset Note Greyedout
status open
\begin_layout Plain Layout
\series bold
-Note
-\series default
- that the
-\series bold
-value
-\series default
- has only an effect for text fields if a
-\series bold
-name
+Note:
\series default
- was specified.
+ To see in
+\emph on
+Adobe Reader
+\emph default
+ and
+\emph on
+Acrobat
+\emph default
+ custom background colors you must disable in these programs the highlighting
+ of form fields.
+ (Option
+\begin_inset Quotes eld
+\end_inset
+
+Show border hover color for fields
+\begin_inset Quotes erd
+\end_inset
+
+)
\end_layout
\end_inset
status open
\begin_layout Plain Layout
-
\begin_inset Argument 1
status open
\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"
+literal "true"
\end_inset
\end_layout
\begin_layout Itemize
-Combo box with dashed, colored border:
+Combo choice menu with dashed, colored border where the last entry is preselecte
+d:
\begin_inset VSpace defskip
\end_inset
status open
\begin_layout Plain Layout
-
\begin_inset Argument 1
status open
\end_layout
\begin_layout Itemize
-Popdown box where only 2
-\begin_inset space ~
-\end_inset
-
-entries are shown and where the last entry is preselected:
+Popdown choice menu where the second entry is preselected:
\begin_inset VSpace defskip
\end_inset
status open
\begin_layout Plain Layout
-
\begin_inset Argument 1
status open
\begin_layout Plain Layout
-popdown, name=country2, value=Az
+popdown, name=country2, default=Ar
\end_layout
\end_inset
\begin_layout Plain Layout
\series bold
-Note
+Note:
\series default
- that the
+The parameters
\series bold
borderstyle B
\series default
\series bold
I
\series default
- and also
+ and
\series bold
color
\series default
- has no effect for popdown boxes.
+ have no effect for popdown choice menus.
\end_layout
\end_inset
\end_layout
\begin_layout Itemize
-Radio box with inverted bevel border and symbol number
+Radio choice menu with inverted bevel border and symbol number
\begin_inset space ~
\end_inset
-6 as checkmark:
+3 as checkmark:
\begin_inset VSpace defskip
\end_inset
status open
\begin_layout Plain Layout
-
\begin_inset Argument 1
status open
\end_inset
-\end_layout
-
-\begin_layout Itemize
-Push button with a bevel border and colored text:
-\begin_inset VSpace defskip
-\end_inset
-
-
-\begin_inset Newline newline
-\end_inset
-
-
-\begin_inset Flex PushButton
-status open
-
-\begin_layout Plain Layout
-
-\begin_inset Argument 1
-status open
-
-\begin_layout Plain Layout
-onclick={app.alert("Why do you click this?")}
-\end_layout
-
-\end_inset
-
-
-\backslash
-colorbox{lime}{
-\backslash
-textcolor{red}{Don't click on this button!!!}}
-\end_layout
-
-\end_inset
-
-
\end_layout
\begin_layout Standard
\begin_layout Plain Layout
\series bold
-Note
+Note:
\series default
- that the
+ The parameters
\series bold
backgroundcolor
\series default
- and
+,
\series bold
- color
+color
\series default
- has no effect for push, submit and reset buttons.
+,
+\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 the command
-\series bold
+As workaround use a colored box and/or color the box text.
+\end_layout
-\backslash
-colorbox
-\series default
- as described in sec.
-\begin_inset space \thinspace{}
+\begin_layout Itemize
+Push button with a bevel border and colored text:
+\begin_inset VSpace defskip
\end_inset
- 5.7
-\begin_inset Quotes eld
-\end_inset
-Colored Boxes
-\begin_inset Quotes erd
+\begin_inset Newline newline
\end_inset
- in LyX's
-\emph on
-EmbeddedObjects
-\emph default
- manual and
-\series bold
-\backslash
-textcolor
-\series default
- that is used is used in the scheme
-\begin_inset Newline newline
-\end_inset
+\begin_inset Flex PushButton
+status open
+\begin_layout Plain Layout
+\begin_inset Argument 1
+status open
-\series bold
+\begin_layout Plain Layout
+onclick={app.alert(
+\begin_inset ERT
+status collapsed
-\backslash
-textcolor{color}{characters to color}
-\series default
+\begin_layout Plain Layout
-\begin_inset Newline newline
-\end_inset
+"
+\end_layout
-In the button above this code was used:
-\begin_inset Newline newline
\end_inset
+Why do you click this?
+\begin_inset ERT
+status collapsed
-\family sans
+\begin_layout Plain Layout
-\backslash
-colorbox{lime}{
-\backslash
-textcolor{red}{Don't click on this button!!!}}
+"
\end_layout
-\begin_layout Standard
-\begin_inset Note Greyedout
+\end_inset
+
+)}
+\end_layout
+
+\end_inset
+
+
+\begin_inset Box Frameless
+position "t"
+hor_pos "c"
+has_inner_box 1
+inner_pos "t"
+use_parbox 0
+use_makebox 1
+width ""
+special "none"
+height "1in"
+height_special "totalheight"
+thickness "0.4pt"
+separation "3pt"
+shadowsize "4pt"
+framecolor "black"
+backgroundcolor "lime"
status open
\begin_layout Plain Layout
-\series bold
-Note
-\series default
- that the
-\series bold
-height
-\series default
-and
-\series bold
-width
-\series default
- has no effect for push, submit and reset buttons.
+\color red
+Don't click on this button!!!
\end_layout
\end_inset
\end_layout
-\begin_layout Standard
-As workaround use the box method described in sec.
-\begin_inset space \thinspace{}
\end_inset
-\begin_inset CommandInset ref
-LatexCommand ref
-reference "sub:Action-button-customization"
-
+\begin_inset VSpace bigskip
\end_inset
\end_layout
\begin_layout Itemize
-Submit button without border, with cyan background color and increased height:
+Submit button without border, with cyan background and increased height:
\begin_inset VSpace defskip
\end_inset
status open
\begin_layout Plain Layout
-
\begin_inset Argument 1
status open
\end_inset
-\backslash
-colorbox{cyan}{
-\backslash
-parbox[c][4
-\backslash
-totalheight]{5cm}{
-\backslash
-centering Send your data via mail}}
+\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"
+has_inner_box 1
+inner_pos "c"
+use_parbox 1
+use_makebox 0
+width "4.5cm"
+special "none"
+height "4in"
+height_special "totalheight"
+thickness "0.4pt"
+separation "3pt"
+shadowsize "4pt"
+framecolor "black"
+backgroundcolor "none"
+status open
+
+\begin_layout Plain Layout
+Send your data via mail
+\end_layout
+
+\end_inset
+
+
+\end_layout
+
+\end_inset
+
+
\end_layout
\end_inset
status open
\begin_layout Plain Layout
-
\begin_inset Argument 1
status open
\end_inset
-\backslash
-makebox[7cm]{Reset the form}
+\begin_inset Box Frameless
+position "t"
+hor_pos "c"
+has_inner_box 1
+inner_pos "t"
+use_parbox 0
+use_makebox 1
+width "7cm"
+special "none"
+height "1in"
+height_special "totalheight"
+thickness "0.4pt"
+separation "3pt"
+shadowsize "4pt"
+framecolor "black"
+backgroundcolor "none"
+status open
+
+\begin_layout Plain Layout
+Reset the form
\end_layout
\end_inset
+\end_layout
+
+\end_inset
+
+
+\end_layout
+
+\begin_layout Standard
+\begin_inset Newpage newpage
+\end_inset
+
+
\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
PDFAction
\family default
.
- The PDF viewer programs
+ The PDF viewers
\emph on
Acrobat
\emph default
\emph default
can handle all possible actions while other PDF viewers might only support
some of them.
- However, all PDF viewer programs support the basic things like printing,
- save
+ However, all PDF viewers support the basic things like printing, save
\begin_inset space ~
\end_inset
Action
\family default
inset.
- A list with possible actions can be found in sec.
+ A list with possible action names can be found in sec.
\begin_inset space \thinspace{}
\end_inset
\begin_inset Quotes erd
\end_inset
- of the documentation of the LaTeX package
+ of the documentation of the \SpecialChar LaTeX
+ package
\series bold
hyperref
\series default
\begin_inset CommandInset citation
LatexCommand cite
key "hyperref"
+literal "true"
\end_inset
status open
\begin_layout Plain Layout
-
\begin_inset Argument 1
status open
status open
\begin_layout Plain Layout
-
\begin_inset Argument 1
status open
status open
\begin_layout Plain Layout
-
\begin_inset Argument 1
status open
Action button customization
\begin_inset CommandInset label
LatexCommand label
-name "sub:Action-button-customization"
+name "subsec:Action-button-customization"
\end_inset
\end_layout
\begin_layout Standard
-Customizing the action buttons requires some complicated LaTeX code because
- things like the width, height and border separation cannot be specified
- as button parameters.
+Customizing the action buttons requires the usage of boxes because things
+ like the width, height and border separation cannot be specified as button
+ parameters.
\end_layout
\begin_layout Standard
-The easiest way to customize the buttons is to fill it with a custom box:
+The easiest way to customize the buttons is to fill it with a custom box.
+ For example the button should be 5
+\begin_inset space \thinspace{}
+\end_inset
+
+cm wide and have the height of 2
+\begin_inset space ~
+\end_inset
+
+lines.
+ Then create this parbox:
\end_layout
-\begin_layout Enumerate
-Create a normal LyX box of your choice
+\begin_layout Standard
+\begin_inset Box Frameless
+position "c"
+hor_pos "c"
+has_inner_box 1
+inner_pos "c"
+use_parbox 1
+use_makebox 0
+width "5cm"
+special "none"
+height "2in"
+height_special "totalheight"
+thickness "0.4pt"
+separation "3pt"
+shadowsize "4pt"
+framecolor "black"
+backgroundcolor "none"
+status open
+
+\begin_layout Plain Layout
+\noindent
+Save form as
\end_layout
-\begin_layout Enumerate
-Use the menu
-\family sans
-View\SpecialChar \menuseparator
-Source
-\begin_inset space ~
\end_inset
-Pane
-\family default
- to show the source code window (if not already shown)
-\end_layout
-\begin_layout Enumerate
-set the cursor into the box and copy the corresponding LaTeX code from the
- source window
\end_layout
-\begin_layout Enumerate
-paste it t the content of the
+\begin_layout Standard
+inside a
\family sans
PDFAction
\family default
inset.
+ This is the result:
\end_layout
\begin_layout Standard
-For example the button should be 4
-\begin_inset space \thinspace{}
-\end_inset
+\begin_inset Flex PDFAction
+status open
+
+\begin_layout Plain Layout
+\begin_inset Argument 1
+status open
+
+\begin_layout Plain Layout
+SaveAs
+\end_layout
-cm wide and have the height of 2 lines.
- Then create this parbox:
-\begin_inset Newline newline
\end_inset
inner_pos "c"
use_parbox 1
use_makebox 0
-width "4cm"
+width "5cm"
special "none"
height "2in"
height_special "totalheight"
+thickness "0.4pt"
+separation "3pt"
+shadowsize "4pt"
+framecolor "black"
+backgroundcolor "none"
+status open
+
+\begin_layout Plain Layout
+Save form as
+\end_layout
+
+\end_inset
+
+
+\end_layout
+
+\end_inset
+
+
+\end_layout
+
+\begin_layout PDF Link Setup
+pdfborder={0 0 0}
+\begin_inset Note Note
status open
\begin_layout Plain Layout
-\noindent
-Save form as
+Sets the thickness of the predefined link border to zero as described below.
+\end_layout
+
+\end_inset
+
+
\end_layout
+\begin_layout Standard
+To customize the border color, border thickness and the distance to the
+ border one changes the border settings of the box.
+ An example with a 4
+\begin_inset space \thinspace{}
+\end_inset
+
+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
-and copy its LaTeX code to the button
-\family sans
-PDFAction
-\family default
- inset.
- To center the text in the button add
-\backslash
-centering right before the button text.
- This is the result:
-\end_layout
-\begin_layout Standard
\begin_inset Flex PDFAction
status open
\begin_layout Plain Layout
-
\begin_inset Argument 1
status open
\end_inset
-\backslash
-parbox[c][2
-\backslash
-totalheight]{4cm}{
-\backslash
-centering Save form as}
+\begin_inset Box Boxed
+position "c"
+hor_pos "c"
+has_inner_box 1
+inner_pos "c"
+use_parbox 1
+use_makebox 0
+width "5cm"
+special "none"
+height "2in"
+height_special "totalheight"
+thickness "4pt"
+separation "3pt"
+shadowsize "4pt"
+framecolor "teal"
+backgroundcolor "white"
+status open
+
+\begin_layout Plain Layout
+\noindent
+Save form as
+\end_layout
+
+\end_inset
+
+
\end_layout
\end_inset
\end_layout
\begin_layout Standard
-To customize the border color, add the command
+To customize the border thickness, add the command
\series bold
-menubordercolor={r g b}
+pdfborder={0 0 t}
\series default
to the additional options in the document settings under
\family sans
\family default
and replace
\series bold
-r
-\series default
-,
-\series bold
-g
-\series default
- and
-\series bold
-b
+t
\series default
- with a number between 0 and 1 for the colors red, green and blue.
- If you want to change the border color only for certain buttons, use the
- layout
+ with a number that is the thickness in pixels.
+ If you want to change the border thickness only for certain buttons, use
+ the environment
\family sans
PDF
\begin_inset space ~
\family default
before the button and insert there the command
\series bold
-menubordercolor
+pdfborder
\series default
.
The default value of
\series bold
-menubordercolor
+pdfborder
\series default
is
\series bold
-{1 0 0}
+{0 0 1}
\series default
.
\end_layout
+\begin_layout Standard
+\begin_inset Note Greyedout
+status open
+
+\begin_layout Plain Layout
+
+\series bold
+Note:
+\series default
+
+\series bold
+pdfborder
+\series default
+ affects all link types, not only the action links.
+\end_layout
+
+\end_inset
+
+
+\end_layout
+
\begin_layout PDF Link Setup
-menubordercolor={0.1 0.9 0.5}
+pdfborder={0 0 4}
\end_layout
\begin_layout Standard
-An example with
-\series bold
-menubordercolor={0.1 0.9 0.5}
-\series default
-:
+An example with a 4
+\begin_inset space ~
+\end_inset
+
+pixel thick border:
\begin_inset Newline newline
\end_inset
status open
\begin_layout Plain Layout
-
\begin_inset Argument 1
status open
\end_inset
-\backslash
-parbox[c][2
-\backslash
-totalheight]{4cm}{
-\backslash
-centering Save form as}
+\begin_inset Box Frameless
+position "c"
+hor_pos "c"
+has_inner_box 1
+inner_pos "c"
+use_parbox 1
+use_makebox 0
+width "5cm"
+special "none"
+height "2in"
+height_special "totalheight"
+thickness "0.4pt"
+separation "3pt"
+shadowsize "4pt"
+framecolor "black"
+backgroundcolor "none"
+status open
+
+\begin_layout Plain Layout
+\noindent
+Save form as
+\end_layout
+
+\end_inset
+
+
\end_layout
\end_inset
\end_layout
\begin_layout Standard
-To change the border width use the command
+To change the border color use the command
\series bold
-pdfborder={0 0 w}
+menubordercolor={r g b}
\series default
where
\series bold
-w
+r
\series default
- is the width in pixels.
- The default value of
+,
\series bold
-pdfborder
+g
\series default
- is
+ and
\series bold
-{0 0 1}
+b
\series default
-.
-\end_layout
-
-\begin_layout Standard
-\begin_inset Note Greyedout
-status open
-
-\begin_layout Plain Layout
-
+ are numbers between 0 and 1 for the colors red, green and blue.
+ The default value of
\series bold
-Note:
+menubordercolor
\series default
-
+ is
\series bold
-pdfborder
+{1 0 0}
\series default
- affects all link types, not only the menu links.
-\end_layout
-
-\end_inset
-
-
+.
\end_layout
\begin_layout PDF Link Setup
-pdfborder={0 0 4}, menubordercolor={1 1 0}
+pdfborder={0 0 1}, menubordercolor={0.1 0.9 0.5}
\end_layout
\begin_layout Standard
-An example with a 4
-\begin_inset space ~
-\end_inset
-
-pixel thick yellow border:
+An example with
+\series bold
+menubordercolor={0.1 0.9 0.5}
+\series default
+:
\begin_inset Newline newline
\end_inset
status open
\begin_layout Plain Layout
-
\begin_inset Argument 1
status open
\end_inset
-\backslash
-parbox[c][2
-\backslash
-totalheight]{4cm}{
-\backslash
-centering Save form as}
+\begin_inset Box Frameless
+position "c"
+hor_pos "c"
+has_inner_box 1
+inner_pos "c"
+use_parbox 1
+use_makebox 0
+width "5cm"
+special "none"
+height "2in"
+height_special "totalheight"
+thickness "0.4pt"
+separation "3pt"
+shadowsize "4pt"
+framecolor "black"
+backgroundcolor "none"
+status open
+
+\begin_layout Plain Layout
+\noindent
+Save form as
\end_layout
\end_inset
\end_layout
-\begin_layout Standard
-To change the background color insert the command
-\series bold
-
-\backslash
-colorbox{color}{
-\series default
- at the beginning of the button inset and a
-\series bold
-}
-\series default
- at the end.
-
-\series bold
-color
-\series default
- is hereby the name of the color as described in sec.
-\begin_inset space \thinspace{}
\end_inset
-5.7
-\begin_inset Quotes eld
-\end_inset
-Colored Boxes
-\begin_inset Quotes erd
-\end_inset
+\end_layout
- of LyX's
-\emph on
-EmbeddedObjects
-\emph default
- manual.
+\begin_layout Standard
+To change the background color use a colored box.
\end_layout
\begin_layout PDF Link Setup
\end_layout
\begin_layout Standard
-An example without a border and with a background color:
+An example without a border and with lime background color:
\begin_inset Newline newline
\end_inset
status open
\begin_layout Plain Layout
-
\begin_inset Argument 1
status open
\end_inset
-\backslash
-colorbox{lime}{
-\backslash
-parbox[c][2
-\backslash
-totalheight]{4cm}{
-\backslash
-centering Save form as}}
+\begin_inset Box Frameless
+position "c"
+hor_pos "c"
+has_inner_box 1
+inner_pos "c"
+use_parbox 1
+use_makebox 0
+width "5cm"
+special "none"
+height "2in"
+height_special "totalheight"
+thickness "0.4pt"
+separation "3pt"
+shadowsize "4pt"
+framecolor "black"
+backgroundcolor "lime"
+status open
+
+\begin_layout Plain Layout
+\noindent
+Save form as
+\end_layout
+
+\end_inset
+
+
\end_layout
\end_inset
\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 document preamble:
+ To use this feature, add these lines to your LaTeX preamble:
\end_layout
\begin_layout Standard
\begin_layout Standard
Then add the necessary JavaScript code to your document LaTeX preamble or
- as TeX code to your document.
+ as \SpecialChar TeX
+ code to your document.
For info about JavaScript, see its documentation,
\begin_inset CommandInset citation
LatexCommand cite
key "JavaScript"
+literal "true"
\end_inset
status open
\begin_layout Plain Layout
-The following section will only be displayed when the LaTeX package
+The following section will only be displayed when the \SpecialChar LaTeX
+ package
\series bold
insdljs
\series default
\begin_layout Plain Layout
- this.getField("to").display = display.hidden;
+ this.getField("until").display = display.hidden;
\end_layout
\begin_layout Plain Layout
\begin_layout Plain Layout
- this.getField("to").display = display.visible;
+ this.getField("until").display = display.visible;
\end_layout
\begin_layout Plain Layout
\emph on
All
\emph default
- JavaScript funtions must be inserted into the same
+ JavaScript functions must be inserted into the same
\family sans
insDLJS
\family default
\begin_layout Standard
The
\family sans
-PDF
-\begin_inset space ~
-\end_inset
-
-form
-\begin_inset space ~
-\end_inset
-
-parameters
+Parameters
\family default
of the following choice menu are
\begin_inset Newline newline
status open
\begin_layout Plain Layout
-
\begin_inset Argument 1
status open
\begin_layout Standard
\begin_inset Tabular
<lyxtabular version="3" rows="3" columns="2">
-<features rotate="0" tabularvalignment="middle">
+<features tabularvalignment="middle">
<column alignment="left" valignment="top">
<column alignment="center" valignment="top">
<row>
status open
\begin_layout Plain Layout
-
\begin_inset Argument 1
status open
\begin_inset Text
\begin_layout Plain Layout
-To:
+Until:
\end_layout
\end_inset
status open
\begin_layout Plain Layout
-
\begin_inset Argument 1
status open
\begin_layout Plain Layout
-name=to,width=10em
+name=until,width=10em
\end_layout
\end_inset
status open
\begin_layout Plain Layout
-
\begin_inset Argument 1
status open
status open
\begin_layout Plain Layout
-The following will be displayed when the LaTeX package
+The following will be displayed when the \SpecialChar LaTeX
+ package
\series bold
insdljs
\series default
status open
\begin_layout Plain Layout
-keep this emtpy
+keep this empty
\end_layout
\end_inset
\end_layout
\begin_layout Section
-General notes and hints
-\end_layout
-
-\begin_layout Itemize
-Submitting and applying data requires that all form fields have a name.
+General notes
\end_layout
\begin_layout Itemize
-All braces and brackets in form parameters must be inserted as TeX code!
+Submitting and applying data requires that all form elements have a name.
\end_layout
\begin_layout Itemize
-It is not possible to create a PDF form using XeTeX.
- Use either the LyX export formats
+Creating a PDF form requires pdf\SpecialChar TeX
+ or Lua\SpecialChar TeX
+.
+ Use therefore either the \SpecialChar LyX
+ export formats
\family sans
PDF (pdflatex)
\family default
.
\end_layout
-\begin_layout Itemize
-To be able to use all kinds of colors and color definitions you must load
- the LaTeX package
-\series bold
-xcolor
-\series default
- in the document preamble this way:
-\begin_inset Newline newline
-\end_inset
-
-
-\series bold
-
-\backslash
-usepackage[svgnames,rgb]{xcolor}
-\end_layout
-
\begin_layout Itemize
To see in
\emph on
\emph on
Acrobat
\emph default
- custom background colors you must disable in these programs to highlight
- the available form fields in the PDF.
+ custom background colors you must disable in these programs the highlighting
+ of form fields.
+ (Option
+\begin_inset Quotes eld
+\end_inset
+
+Show border hover color for fields
+\begin_inset Quotes erd
+\end_inset
+
+)
\end_layout
\begin_layout Bibliography
\begin_inset CommandInset bibitem
LatexCommand bibitem
key "JavaScript"
+literal "true"
\end_inset
LatexCommand href
name "JavaScript reference"
target "https://developer.mozilla.org/en/docs/Web/JavaScript/Reference"
+literal "false"
\end_inset
\begin_inset CommandInset bibitem
LatexCommand bibitem
key "hyperref"
+literal "true"
\end_inset
\begin_inset CommandInset href
LatexCommand href
name "Documentation"
-target "http://mirrors.ctan.org/macros/latex/contrib/hyperref/doc/manual.pdf"
+target "https://ctan.org/tex-archive/macros/latex/contrib/hyperref/doc/manual.pdf"
+literal "false"
\end_inset
- of the LaTeX package
+ of the \SpecialChar LaTeX
+ package
\series bold
hyperref
\end_layout
\begin_inset CommandInset bibitem
LatexCommand bibitem
key "pifont"
+literal "true"
\end_inset
\begin_inset CommandInset href
LatexCommand href
name "Documentation"
-target "http://mirrors.ctan.org/macros/latex/required/psnfss/psnfss2e.pdf"
+target "https://ctan.org/tex-archive/macros/latex/required/psnfss/psnfss2e.pdf"
+literal "false"
\end_inset
- of the LaTeX package
+ of the \SpecialChar LaTeX
+ package
\series bold
pifont
\end_layout
projects / lyx.git / blobdiff