From 742418daebd1274358a90387c35402a3d809cfab Mon Sep 17 00:00:00 2001 From: Nathan Byrd Date: Wed, 26 Jan 2022 16:21:40 -0600 Subject: [PATCH] Added BT, PL, and TL --- docs/art/views/button_view.md | 57 ++++++++++++++++++ docs/art/views/predefined_label_view.md | 49 +++++++++++++++ docs/art/views/text_view.md | 49 +++++++++++++++ docs/assets/images/button_view_example1.gif | Bin 0 -> 5255 bytes .../images/predefined_label_view_example1.png | Bin 0 -> 3342 bytes .../images/text_label_view_example1.png | Bin 0 -> 1479 bytes 6 files changed, 155 insertions(+) create mode 100644 docs/art/views/button_view.md create mode 100644 docs/art/views/predefined_label_view.md create mode 100644 docs/art/views/text_view.md create mode 100644 docs/assets/images/button_view_example1.gif create mode 100644 docs/assets/images/predefined_label_view_example1.png create mode 100644 docs/assets/images/text_label_view_example1.png diff --git a/docs/art/views/button_view.md b/docs/art/views/button_view.md new file mode 100644 index 00000000..23f52229 --- /dev/null +++ b/docs/art/views/button_view.md @@ -0,0 +1,57 @@ +--- +layout: page +title: Full Menu View +--- +## Full Menu View +A button view supports displaying a button on a screen. + +## General Information + +:information_source: A button view is defined with a percent (%) and the characters BT, followed by the view number. For example: `%BT1` + +:information_source: See [Art](../general.md) for general information on how to use views and common configuration properties available for them. + +### Properties + +| Property | Description | +|-------------|--------------| +| `text` | Sets the text to display on the button | +| `textStyle` | Sets the standard (non-focus) text style. See **Text Styles** in [Art](../general.md) | +| `focusTextStyle` | Sets focus text style. See **Text Styles** in [Art](../general.md)| +| `width` | Sets the width of a view to display one or more columns horizontally (default 15)| +| `focus` | If set to `true`, establishes initial focus | +| `submit` | If set to `true` any `accept` action upon this view will submit the encompassing **form** | +| `argName` | Sets the argument name for this selection in the form | +| `justify` | Sets the justification of each item in the list. Options: left (default), right, center | +| `fillChar` | Specifies a character to fill extra space in the menu with. Defaults to an empty space | +| `textOverflow` | If a single column cannot be displayed due to `width`, set overflow characters. See **Text Overflow** below | + +### Text Overflow + +The `textOverflow` option is used to specify what happens when a text string is too long to fit in the `width` defined. + +:information_source: If `textOverflow` is not specified at all, a button can become wider than the `width` if needed to display the text value. + +:information_source: Setting `textOverflow` to an empty string `textOverflow: ""` will cause the item to be truncated if necessary without any characters displayed + +:information_source: Otherwise, setting `textOverflow` to one or more characters will truncate the value if necessary and display those characters at the end. i.e. `textOverflow: ...` + +## Example + +![Example](../../assets/images/button_view_example1.gif "Button") + +
+Configuration fragment (expand to view) +
+``` +BT1: { + submit: true + justify: center + argName: btnSelect + width: 17 + focusTextStyle: upper + text: Centered button +} +``` +
+
diff --git a/docs/art/views/predefined_label_view.md b/docs/art/views/predefined_label_view.md new file mode 100644 index 00000000..45d2d1cd --- /dev/null +++ b/docs/art/views/predefined_label_view.md @@ -0,0 +1,49 @@ +--- +layout: page +title: Full Menu View +--- +## Full Menu View +A predefined label view supports displaying a predefined MCI label on a screen. + +## General Information + +:information_source: A predefined label view is defined with a percent (%) and the characters PL, followed by the view number and then the predefined MCI value in parenthesis. For example: `%PL1(VL)` to display the Version Label. *NOTE*: this is an alternate way of placing MCI codes, as the MCI can also be placed on the art page directly with the code. For example `%VL`. The difference between these is that the PL version can have additional formatting options applied to it. + +:information_source: See *Predefined Codes* in [MCI](../mci.md) for the list of available MCI codes. + +:information_source: See [Art](../general.md) for general information on how to use views and common configuration properties available for them. + +### Properties + +| Property | Description | +|-------------|--------------| +| `textStyle` | Sets the standard (non-focus) text style. See **Text Styles** in [Art](../general.md) | +| `justify` | Sets the justification of each item in the list. Options: left (default), right, center | +| `fillChar` | Specifies a character to fill extra space in the menu with. Defaults to an empty space | +| `width` | Specifies the width that the value should be displayed in (default 3) | +| `textOverflow` | If a single column cannot be displayed due to `width`, set overflow characters. See **Text Overflow** below | + +### Text Overflow + +The `textOverflow` option is used to specify what happens when a predefined MCI string is too long to fit in the `width` defined. + +:information_source: If `textOverflow` is not specified at all, a predefined label view can become wider than the `width` if needed to display the MCI value. + +:information_source: Setting `textOverflow` to an empty string `textOverflow: ""` will cause the item to be truncated if necessary without any characters displayed + +:information_source: Otherwise, setting `textOverflow` to one or more characters will truncate the value if necessary and display those characters at the end. i.e. `textOverflow: ...` + +## Example + +![Example](../../assets/images/predefined_label_view_example1.png "Predefined label") + +
+Configuration fragment (expand to view) +
+``` +PL1: { + textStyle: upper +} +``` +
+
diff --git a/docs/art/views/text_view.md b/docs/art/views/text_view.md new file mode 100644 index 00000000..ad2e0855 --- /dev/null +++ b/docs/art/views/text_view.md @@ -0,0 +1,49 @@ +--- +layout: page +title: Full Menu View +--- +## Full Menu View +A text label view supports displaying simple text on a screen. + +## General Information + +:information_source: A text label view is defined with a percent (%) and the characters TL, followed by the view number. For example: `%TL1` + +:information_source: See [Art](../general.md) for general information on how to use views and common configuration properties available for them. + +### Properties + +| Property | Description | +|-------------|--------------| +| `text` | Sets the text to display on the button | +| `textStyle` | Sets the standard (non-focus) text style. See **Text Styles** in [Art](../general.md) | +| `width` | Sets the width of a view to display one or more columns horizontally (default 15)| +| `argName` | Sets the argument name for this selection in the form - *Not normally used for text labels* | +| `justify` | Sets the justification of each item in the list. Options: left (default), right, center | +| `fillChar` | Specifies a character to fill extra space in the menu with. Defaults to an empty space | +| `textOverflow` | If a single column cannot be displayed due to `width`, set overflow characters. See **Text Overflow** below | + +### Text Overflow + +The `textOverflow` option is used to specify what happens when a text string is too long to fit in the `width` defined. + +:information_source: If `textOverflow` is not specified at all, a text label can become wider than the `width` if needed to display the text value. + +:information_source: Setting `textOverflow` to an empty string `textOverflow: ""` will cause the item to be truncated if necessary without any characters displayed + +:information_source: Otherwise, setting `textOverflow` to one or more characters will truncate the value if necessary and display those characters at the end. i.e. `textOverflow: ...` + +## Example + +![Example](../../assets/images/text_label_view_example1.png "Text label") + +
+Configuration fragment (expand to view) +
+``` +TL1: { + text: Text label +} +``` +
+
diff --git a/docs/assets/images/button_view_example1.gif b/docs/assets/images/button_view_example1.gif new file mode 100644 index 0000000000000000000000000000000000000000..c7e36d02faa31f4a053121c4a8edf9a6337fbd72 GIT binary patch literal 5255 zcmeH~S634XvxXB|=!7O6=?EK;sx&2_ks3t^0TiT22Lb82VH1RC1Vt$U6;Ke78WLLQ zNa&$OI-y9DUL{Bq$fp-)o%0*MvuAE*t+|?+^{n?DW78YjIxZmK1;7DF4e&b{83AB0 zKu8Fnt`4xV0TdMhXaHbgF|eqJuAqdjxR^d4%ka6Bp}3ea564(i!t@ExR8j)UEd!O5 zFn=s(#$s7=Dp;^s*6d1FESBv<6lmHAiVFXJ!p24#$;I%Z0;%-_?O} zIPSOg+;}|Cn+6^{o;SUb7mw#lYvRXz;V&yYm)d-;tV|$*UM`f>DpX!B z{JKrJqC(_VyJ%vEXhntC%TBS%O7Rz6;+2)>6G-PPDi$dnK!?q|m)m zRaMf@`lJa285CLOX}@e7Sr$c>B@pCe2jr`(FFYAkh#69-sZop`Rzwaf*3|qJJ)-o_ zs8VgMa@3e|ZLLb=xJqs9#lI;R>*`b=PpCbbRI95~kC;-guh$5l)~K)74Ev@PI-}Ll za4BT=QbWV#;5qG}dF{qVoreoLjg7j2-}M3(^_rUW{g1K(AM&l=>* z7enuL!{%lquZ?S-o7b9~q3+vIBJqaX&J7~b`2G(Q*IiQ=s+seiS!=7g(@*o(R*QT4 z7Okx?#{*bf+f9eVn{92k?jBj*Iks$Xzit1^%I?Ifz1`aO)ViYsjyQvNblBL??7O-g zNF+xR=^lyX(%tRa)8p3Dkug!TfyT{Cv^E0`~iN{NiHS;$r2}5@C6{ zc4eh*Wu;+t^~>5?^V(X=`g+^?di%yk$Hqq2<|b)#vwL&1XKSl>Ym2@*RTDPlY^6!!_(8_)6bZko*hD|5r$uf9nCWs0lus7|YD7=+K4FX?+HkHp?_A``Df!sNpl! zRhHZNO5$3)sA>5pQpyGEA_r1=UQfE}{q9WDiqCx++QDm6q>6m<2Z-Z2L9@z&fn1Xm zMaS;S!l8W2T(c}Q%qsFdQ@PJ{cUAEi&bc*S%$!g{sqh*q;x`AZPgDmkbZ41YZ;cc5 zd!A5w($S7sO{tSB>!^TN*!8$6* z7A~D3yX@z-Zc;4kmgg^zFBT+I$gEL=>OhEW;gdNf&ojH+LbYnf^8z6z1R$COouo&e4 zJ>lo#o=j(j&PmD&@3_jV39H_h*AiBBPtUR_8u^q4tG$NcLXVq@T89Zr&T+z6o>W+7V#9Twate;OGP84 z4o7z`mS?fw_2ab%miT4-Onhs|_Q(T@4IK60U-pZ?x_;s1Y^nKr-Mm!^rZy|Pcng=b z$Uj<-UqVYa)#!>ieNkj{5F#?AI>&PGD`hOSaER>egma6i5^MN16s0>vQl@Nbu180f zzLbgng-O1o_BKeqBC#__{@9~^8`1PsE6}#*(mH=@R>7J^;0TYr=D>tFhj)kBP@hfb zcU>{{;e%1ymC$;}oCba#6G4f9Q76j8ZWAR2`vY-5*k<3>tN4@}Wyl44I3+;NsvHen zaNHVNE#0WLg^w|0%Vv0>HhrE2RCR7dd17!qS!!jS_g#GRS~pOB z)Ve^VFzzi)#TgbZ&5Us$TNq^y3N-NnH?y+a09An*@(#`F0fG`=Rft!6P9*}39 zusE;~Ki(ME6^O(`66}Ec=m>%4s6~c|UTNHJS0}5V?5jJ(g%Cmu;A+@9Fp|Ly!E=;T z8iGtxK9&~O%QY!i-DS|wgh*1+fa~v(wnhuNwwGQTpZ8g$e{q785qU1F|72T>`aDm` z)6`tFKQ67NH&12V)%@+oZhAAj2gzBX*Ht(;z3~M}EuGYBC&w#ChyJXYZ`$W`hx%^3 z_w%J{QlI~0YQ`*kzIK%mGW!iRbHyTGcZ}2@R!7a+d6BQbY)XDSL4AMNn}79y#BeK( zf#H9R0TWOj0Q{W*W(EM)zl}d$>A!v@k^nY9836qI<}?5o^Dq>jeIdq+RZ%G-n}>Lb zj!Q|xZXHmBVl@}*LX~BIq!(jh4FM-h#7l{B2%@{n^B}h*W0?J*U$3_*G8o1vkvu)S zWa(^N^kuF9$73TcGF29B|^MT?9 z096G;4eJ#9=k?Tgj&}2EmlnQ4$G=mtW=rRvtNMrY&AfcthnvPQDo6YZ{MxtZWlK@7 z5uAcMnXd6s$3!LA7U%razG5jv%b*;js--Lk9%_vC=9=<}Uu%9B4%1@E9EB%BTpu#_ z`?AKoYKR`xoM{xX&nA3c;oLhtuyvk|j-}PoD#A{knnq~sw7)!I4nq;6_*1I2^e&M; zzxRw6SnFLvrojhNbsev3vU)v(#u;hS9H1lKv`9>!E=bUM1i0HQH)&AGBE#ZOx4C~S z0K~^T71$2F-eX{Np)(WMuc<`|QLzb!u#bB$3phV1)anIlXoe<2Rtuqg(lCW!0Ejwr z@JdIiYKSkIi-(emq=gJ6gTw({$qbIkqkQV15dJx!V4&q3O4QkM(ogA;gdw_t#ckf8 zMGP`!(7{rP1hLc{axpO3IZMA(qM#QHC=bS_fioOSM1-NM+-ne66uAmCIm>mU6IYs* zN#!=Jb&7@&@4F*m-a1(*m=JBY+dvU3vt%&&-FeBjs>Q6>jQfGz3se)}ZVtLYaK}hX zUKpP*YJ5_GDg!B9E-(|2I<~*67}b)NIK|=y`NUrYU)32NohVfANSr7xgkSxM!r9fW z@ep9Ly!|)=qMcN_INyV-5h+UPHE5^vMWSbAS|<#q4zmZ}4@0CMV4v`;6%(GH4c$@) z(KOhc^bjWg*yYc~gLRvi-23aTKTg0^_Xx*DxU)kIRqx!DR#6}B2ffKak+a<3mayk0 z7=y;Gx72plyTuO)qIy5~3<6(^mXfaA2-yl*FW2-*Ra^G`VGyZpv)y--R2OWWD>yU^ z_hf>FqFQ(o%KTwbv|OhPFad$h%0@F~)y_#)z6FEZI*KZ__t;p%l3nX9_6v_n2UC@O zCL`0EnUv<3JM@3CR@Q{`UdaF^g5PTfptKpyv1FfFX68m==bEqRzux68IK*}ij)kMd z2FCN!PH(Ayc3M4ZY^Z=g9th1%lpqFvLu~+KRG%)lDG)vlZiP#)>E+IbUG^WN%agvQo4Lzh@5mKE;YBM*v{Z9b6trg-tgqWSvvR%I zhL-&@)&zUzMKZhHeyK<~juX%^=YJK{S>dp&TCGoSIV%h&@?6#CPP+1w%Mfa39BUSi z^Z*BXA&76*XxcKRPRN27nYt7?sd0Jw$XKXA!|1%nupTvXCtNDd;g?MH<(N1uVpk7v zx?7cOrH|Ht9T{;N-Qdz(Y*x@g=h{R>yrJ`1dkG@}LC8>gD@~Np!&IpCU~=re9S>PE z3kaw4A(u&8lIX)E2U-~<>%0WGZQ>H%8N%p@ u%~0NK(+hh;bjmE(3&P&wjWt9l4$11P7 z2|-BMUEPvc{hRmu`(58$bIx2d*PNMWo@eg+xlf#tffns$w#yI%(dua5HvugPJbYA_ zz`Ipw00$a!e>EL5Dp10yTw_6>H9*5Ez!do?AlS(d0l9f2y%1vlE`A7vx4%0wVEbaH zG6c~S=-gK|3(48c3DbLnWgqCIh^IC&h4uK|lt}Ux9@Yrpmlu?JBweQ7r@+D<_%8B0 zhbyWD!QL{w@%P*{grp~4*hW*%@$Z)Bh>Q9bR{FPbh!?HHuv*{84}CM7ZticSoGmnb z-kej@O+U%n(=nJhP#QbV!F^xwU)WRTxp1$`Q6la^nHIe6~ zzRxATSSQ9DG?nvzhu_x{f_|KHrfHLB>Rp0rt*dISL?<`sV|KYcDe`YLxQ)I1;u`(M zRSkhy325(e+}U{&U0PDo?I~;c-ad4N2`a!YK0B_;7BdJU{?f63hD6q6ckJQDU`Ivc z?&KJ(yR@0x_CklWL!r^m)*=eYo&IITPwto@j{H#r>-hM%GHTjPB2#Zl+%jjKFigoE z&hwSoR6tnx!9QF5N$jPb+3Gdeu;0O(vrSwBS=Lp5D)l~?+*y)eO~tIdVLJ#r*rJHi zA*=-`sCKfkvyacrtXk&U@_sJq?Y;lEMP=M=kEX1$X^)Aisr!3F7z{O(XRoSCHpVU%eEj4|5iui!nRs@*-F`@12-`O1%r(%O@{k!P1W0es2QLah+6aWeNZ8pS zj&N#H{D!`XO|6o z%1-W+zti@_T3@$pT`YPq?=bsjvp0jvP0vhVb118Yjx)Ynf`r6>Vs zF0D?!;(n&RGCe(Q>Sc3|WL`_nyzTb-4cw4H?KzyZ-FdEDPJJax>2!b6EbrYroZ$Id zWlh#XH1YILR(}UL#SH&rn%jUfaafG$QMV zocH&g%A)YhACz=l#n_^vB7R=pzaSp*j(vuaPQR7-G3Dao;#4$R)q_t&Bmv?{U=~|W zFEuGY;nEtVb2a?k;kR-*UCjQ|`&G<}-^AkL_O7zS0I{nJ8W9l}FFgcB`aD1K%vVHQ zNhxP)YU-*QiSbio<6BXi=EU&bzU%vWN$hg35txj$=4M$G^|KR_FRGce^oskW+OlgA z{p!`LwCrqHl|{nVmbcvD_f~)3#fSrn;*W3NUOTcWG;(xwgdhnC3Fw6yS(OEtCla!a zb%>;eT6~tG3zTGJm~wM-W0RBnNhJA3YcWq*c2_CZ(R`H@0o@Ee{9?`>|9e!buCB#3 z=6jhGFy?<2mzI|B1Ogef@vVWf)FAf)#1Drbdj_u#XYOCE`}i?&R*HpYaCn#;itTgm z?e9NY3D(h}2FrrQH8nMr)(F3!x;I&iI(+8nJR!nHw%6Bt@c1$ZgkkS=r6s&dQ9&Vo zfGdoq)G)t)1@n#!vaVuw8_oI4zD6rDQf0csXX(QJ)4Q{CbGws*A&D2hqMqM)SY5-?O5%Ue*2M}9sO?C$Q~0pVW;7yqCvc)6E)IP*3 z@(S!y)ZA=gl#!R0%m_F5=g9|?xR)<4{aRTWr&QO~g%OFwkeHFoi3t-|1cD4Q6J}CS zP&oOh;nNU#{%m8hlN<6OOb86;t2h`TF&SdfhwQSR1#|_3<-Y3<_x=2&@*@5`oW(^Q z>{3GFpLQ;s+S%B^KA2E*{uPoTDJN>>exk_!*qA)pk73 z?+K@0nvz9{JnVQHcyIGa-P!pDU>SOP`oFT}kT>}FT!v)T)zo<2VR+wRe18qnL&+Cw z+S(LUBU){fH#R)mh(|EFR)0ATIQ-Qr@@p;Ht)0vU9TpZwCZDIAhhJNZ z{^r^LT0l4T&6}9JVSmUgNRM6I-3PtGhMF`YBRdyuu;o0=3A_F5NC>*Zt;}IG*Lij% z0u{8jW_pj8Uc}8`gOrZ&Meayse*Jt|nb2(HC?Yg^a&v7h%kLX1I;!diLtO9AG?f8B zcw{kX2(oJR6L>WIp1y4PCcv_fZnY=?6*czu0+ zvWm=@xc(Y(a?fZRQD$jb*=5r1Py633Vz;2S548MjNtZwkYUfN#ON*wo?djoa_|)9oq`^ULGfT@JM+wJ}5P6AoB7OV3fdlpD^Rwfq z+3NCgvL9cY4Je;rt6!iUqpU>#1@PMk0`ulR!|x?y{&b-D8REWgFseD$S%F&XH75&o ztxZ>^<>!mzQ~I1${rzu?uR2%Ar=ZGbY4N;sbI8uSH#)nS;4ewGwgF{2z zA0IX-t(jX`+rbCP#m6+3mQoT3gy;jdBu$ni&3sG_4Q@2IT_C6<4Uoaij0Kd;Y31ZpI55}`*cENq zh>D@)3V}L0I!K$S#gY%DjNVr)tbep>s8dJxQ!Vs*05}y7H60h8XEe^5?xVI5%pHm z9I%tMjg7IjwL;Z1`JdR!x0n;=KfA#B`5|bl700y!POrvZ(|M+l7q)dLWe!gwg|w|u zaFk}()zy7s9DM=1-t8`ZLqUPmmJ(QY}v3kIGN?gIjrlgeqCg-rx#Wj<0Y{vmF0o`IGoK9M=>8uSq@IE2^Oo5>6 zk(bNM&Sw2rmCtW zx6yY=D9s&cdG3>)>d@^i%YW5M6Xy{T2A_?;f$t>i}~}CDk_A96A}{mKnmZV zl_75^D2N&Y&{b+S_VN;&PDo7LSDZ@K1wn=r@OU20qBK#vHZvo*uyA}M3I%I^fijwC zY?Q7*J;B~m&8@GOQf-%!k$H2OY~=_ob7#N~CMhes%3QHV>oC_;R_3mj{e97}x35os zi1L=1c^R#IR#ukayn$(XK0Z<ZgXgFbngSdJ^%m(SxH1eRCt{2 znomd@TNK8>G08+Ug|Vw57qqP)1QbgHBGs*e3lZE{K}uIHT(*mLVR0daZtSv9h^3^9 zC{Z!3iVGDLErmjfNU(I{pF&!+gs2Iv`E%alF}In_B${!W=PUOIcQNOj`R3f4&zU=k z5&(igkVV;l-GJcoAxt6AAxt6AAxt6AAxt6AAxt6AAxt6AVagN@4GoA!qi2rCj~`pz z@0moSQOmR%8yj_Vx+uANPN&m?PJc5xI;zq4`Furdm@3TgKHr|l zCTZ< zWCV3}b%wQ%9zDX&&JF;;@Ava~Z*Q-rE;lziI*RJ*YMq{1_vzCoJbU)6V4qgu^?G%; z>R2p>fq{X7=lOg-q|<3UeE1Mwzkb!_J32aW|Nec$bLZ#h@%r^^^Gz4v!ndn$-@X;R zy$%iz@_aNJrAQ<~kw}CxnGBC#y?T`Z(D(1(dCceYk=<@5S(a&TZjQ$zkq7~xwY4>_ zm5mzn`FtgNd~9!T^XncS9`gF9PoI(`NqHY1*{rUvlGEwrb=R(4&r z5()VIe%!cm!?No%H8okLbrvNxMIw{dIKg&5;4Z;;NXC7Y#3uyQBk3(%l^i5aBz?qW5gJvH#2C|T>KJ1r%QCM~6oq23 z7|(Zhc2akDx8|Js`g*FWsxsVY-n@B}7-RJL^JgA=|NcDz;Bz1%T3%k}>oztv#^dVi zxjL$pVX{KTnLYV&`t&6fT#GjOg$0*VMV)Zra=1Gpr>ddj9;m;jX%)ql3qD z7dp2WMNw#NZB0`X4u=g5bl!36)-A(+TUuH)b-AV``u97Q;o)I^?DcvLO_9sk*qBCp zYHBKP?ds|(DT<=0fAQjlVQo==?5Z=&V)Ua|DwRSyoz}!;S->4OEQQD<2m&h2ZZ){F9A9hcJaehcJaehcJaehcJaehcJae hhcJaehcJae$3NjrTwS|vRDb{g002ovPDHLkV1hD?)F%J{ literal 0 HcmV?d00001