X-Git-Url: https://git.lyx.org/gitweb/?a=blobdiff_plain;f=lib%2Fexamples%2FPDF-form.lyx;h=c6438704a263173296145a5eb2c3bd766aeecdbc;hb=3e7dee32edeb1cf3cd72be56cf021d3a64fc235c;hp=f7c3317506fb4c081a5e74c4764cd9edf7d0dedc;hpb=f7b152581c0a00d2b2c92610325105e7ae0b599f;p=lyx.git diff --git a/lib/examples/PDF-form.lyx b/lib/examples/PDF-form.lyx index f7c3317506..c6438704a2 100644 --- a/lib/examples/PDF-form.lyx +++ b/lib/examples/PDF-form.lyx @@ -1,13 +1,11 @@ -#LyX 2.1 created this file. For more info see http://www.lyx.org/ -\lyxformat 474 +#LyX 2.2 created this file. For more info see http://www.lyx.org/ +\lyxformat 508 \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} @@ -21,8 +19,9 @@ \pdfcatalog{/AA \the\pdflastobj\space 0 R} -\ifinsdljs -\begin{insDLJS}[exaaae]{exaaae}{JavaScript} +\ifinsdljs % only execute if package insdljs is installed + + \begin{insDLJS}[exaaae]{exaaae}{JavaScript} function validateTime(){ this.delay = true; @@ -49,8 +48,9 @@ } -\end{insDLJS} -\fi + \end{insDLJS} + +\fi % end \ifinsdljs % if pdflatex is used \usepackage{ifpdf} @@ -72,18 +72,18 @@ pdfform \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 \graphics default -\default_output_format default +\default_output_format pdf2 \output_sync 0 \bibtex_command bibtex \index_command default @@ -173,7 +173,8 @@ Uwe Stöhr 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 @@ -226,7 +227,8 @@ PDF 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 @@ -276,7 +278,7 @@ Form environment. This is done by using the menu \family sans -Insert\SpecialChar \menuseparator +Insert\SpecialChar menuseparator PDF \begin_inset space ~ \end_inset @@ -332,7 +334,7 @@ get \begin_inset CommandInset ref LatexCommand ref -reference "sub:Submit-button" +reference "subsec:Submit-button" \end_inset @@ -369,7 +371,7 @@ TextField \family default using the menu \family sans -Insert\SpecialChar \menuseparator +Insert\SpecialChar menuseparator Custom \begin_inset space ~ \end_inset @@ -423,23 +425,6 @@ customer 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. @@ -643,7 +628,7 @@ ChoiceMenu . A label for the inset is added by using the menu \family sans -Insert\SpecialChar \menuseparator +Insert\SpecialChar menuseparator Label \family default . @@ -925,7 +910,8 @@ status open \series bold Note: \series default - Due to a bug in the LaTeX package + Due to a bug in the \SpecialChar LaTeX + package \series bold hyperref \series default @@ -988,6 +974,44 @@ The action that is triggered by pressing the button is specified by JavaScript 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" + +\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. + Congratulations. +\begin_inset ERT +status collapsed + +\begin_layout Plain Layout + +" +\end_layout + +\end_inset + +) \end_layout \begin_layout Standard @@ -999,67 +1023,64 @@ status open status open \begin_layout Plain Layout -onclick={app.alert("What the hell? Now you destroyed your fridge. - Congratulations.")} -\end_layout +onclick={app.alert( +\begin_inset ERT +status collapsed -\end_inset +\begin_layout Plain Layout -Don't click on this button or your fridge will be destroyed!!! +" \end_layout \end_inset +What the hell? Now you destroyed your fridge. + Congratulations. +\begin_inset ERT +status collapsed -\end_layout +\begin_layout Plain Layout -\begin_layout Standard -For info about JavaScript, see its documentation, -\begin_inset CommandInset citation -LatexCommand cite -key "JavaScript" +" +\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 + All quote characters in form parameters must 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 pus buttons is to open a weblink. + Such a button is created by inserting a hyperlink into the button inset. + Here is an example: \end_layout \begin_layout Standard @@ -1077,8 +1098,14 @@ 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 "http://wiki.lyx.org" + +\end_inset + + \end_layout \end_inset @@ -1114,7 +1141,7 @@ if your push button border color is red (the default), otherwise use the Submit button \begin_inset CommandInset label LatexCommand label -name "sub:Submit-button" +name "subsec:Submit-button" \end_inset @@ -1184,7 +1211,8 @@ reference "sec:Preparation" \end_inset for the description. - If there are no specifications you will get LaTeX errors! + If there are no specifications you will get \SpecialChar LaTeX + errors! \end_layout \end_inset @@ -1202,7 +1230,8 @@ status open 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 + a name for each of them to avoid \SpecialChar LaTeX + errors! For example add \series bold name=submit1 \series default @@ -1265,7 +1294,8 @@ status open 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 + a name for each of them to avoid \SpecialChar LaTeX + errors! For example add \series bold name=reset1 \series default @@ -1423,7 +1453,8 @@ Forms optional parameters \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 @@ -1820,16 +1851,61 @@ status open status open \begin_layout Plain Layout -onclick={app.alert("Why do you click this?")} +onclick={app.alert( +\begin_inset ERT +status collapsed + +\begin_layout Plain Layout + +" +\end_layout + +\end_inset + +Why do you click this? +\begin_inset ERT +status collapsed + +\begin_layout Plain Layout + +" +\end_layout + +\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 + +\color red +Don't click on this button!!! \end_layout \end_inset -\backslash -colorbox{lime}{ -\backslash -textcolor{red}{Don't click on this button!!!}} \end_layout \end_inset @@ -1867,59 +1943,7 @@ backgroundcolor \end_layout \begin_layout Standard -As workaround use the command -\series bold - -\backslash -colorbox -\series default - 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 - - 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 - - -\series bold - -\backslash -textcolor{color}{characters to color} -\series default - -\begin_inset Newline newline -\end_inset - -In the button above this code was used: -\begin_inset Newline newline -\end_inset - - -\family sans - -\backslash -colorbox{lime}{ -\backslash -textcolor{red}{Don't click on this button!!!}} +As workaround use a colored box and/or color the box text. \end_layout \begin_layout Standard @@ -1948,18 +1972,7 @@ width \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" - -\end_inset - - +As workaround a box. \end_layout \begin_layout Itemize @@ -1986,14 +1999,31 @@ name=submit2 \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 1 +use_makebox 0 +width "5cm" +special "none" +height "4in" +height_special "totalheight" +thickness "0.4pt" +separation "3pt" +shadowsize "4pt" +framecolor "black" +backgroundcolor "cyan" +status open + +\begin_layout Plain Layout +Send your data via mail +\end_layout + +\end_inset + + \end_layout \end_inset @@ -2033,8 +2063,31 @@ name=reset2 \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 @@ -2091,7 +2144,8 @@ Acrobat-specific behavior \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 @@ -2194,7 +2248,7 @@ View the form in fullscreen Action button customization \begin_inset CommandInset label LatexCommand label -name "sub:Action-button-customization" +name "subsec:Action-button-customization" \end_inset @@ -2202,56 +2256,22 @@ name "sub:Action-button-customization" \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: -\end_layout - -\begin_layout Enumerate -Create a normal LyX box of your choice -\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 -\family sans -PDFAction -\family default - inset. -\end_layout - -\begin_layout Standard -For example the button should be 4 +The easiest way to customize the buttons is to fill it with a custom box. + For example the button should be 4 \begin_inset space \thinspace{} \end_inset cm wide and have the height of 2 lines. Then create this parbox: -\begin_inset Newline newline -\end_inset - +\end_layout +\begin_layout Standard \begin_inset Box Frameless position "c" hor_pos "c" @@ -2263,6 +2283,11 @@ width "4cm" special "none" height "2in" height_special "totalheight" +thickness "0.4pt" +separation "3pt" +shadowsize "4pt" +framecolor "black" +backgroundcolor "none" status open \begin_layout Plain Layout @@ -2273,17 +2298,14 @@ Save form as \end_inset -\begin_inset Newline newline -\end_inset +\end_layout -and copy its LaTeX code to the button +\begin_layout Standard +inside a \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 @@ -2302,12 +2324,31 @@ SaveAs \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 "4cm" +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 @@ -2398,12 +2439,32 @@ SaveAs \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 "4cm" +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 @@ -2481,12 +2542,27 @@ SaveAs \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 "4cm" +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 @@ -2494,39 +2570,13 @@ centering Save form as} \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 @@ -2534,7 +2584,7 @@ pdfborder={0 0 0} \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 @@ -2553,14 +2603,32 @@ SaveAs \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 "4cm" +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 @@ -2604,8 +2672,10 @@ space 0 R} \end_layout \begin_layout Standard -Then add the necessary JavaScript code to your document LaTeX preamble or - as TeX code to your document. +Then add the necessary JavaScript code to your document \SpecialChar LaTeX + preamble or as + \SpecialChar TeX + code to your document. For info about JavaScript, see its documentation, \begin_inset CommandInset citation LatexCommand cite @@ -2634,7 +2704,8 @@ ifinsdljs 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 @@ -2821,7 +2892,7 @@ Job contract: \begin_layout Standard \begin_inset Tabular - + @@ -3034,7 +3105,8 @@ else 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 @@ -3092,39 +3164,26 @@ Submitting and applying data requires that all form fields have a name. \end_layout \begin_layout Itemize -All braces and brackets in form parameters must be inserted as TeX code! +All braces, brackets, backslashes and quote characters in form parameters + must be inserted as \SpecialChar TeX + code! \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 pdflatex or lualatex. + Use either the \SpecialChar LyX + export formats \family sans PDF (pdflatex) \family default or \family sans -PDF (LuaTeX) +PDF (Lua\SpecialChar TeX +) \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 @@ -3171,7 +3230,8 @@ target "http://mirrors.ctan.org/macros/latex/contrib/hyperref/doc/manual.pdf" \end_inset - of the LaTeX package + of the \SpecialChar LaTeX + package \series bold hyperref \end_layout @@ -3191,7 +3251,8 @@ target "http://mirrors.ctan.org/macros/latex/required/psnfss/psnfss2e.pdf" \end_inset - of the LaTeX package + of the \SpecialChar LaTeX + package \series bold pifont \end_layout