From 84adb9fe59d6adf7816336ec6ba2f8bb4326cf1f Mon Sep 17 00:00:00 2001 From: Nathan Byrd Date: Tue, 25 Jan 2022 12:28:58 -0600 Subject: [PATCH 01/12] Added documentation for other menu views --- docs/art/views/horizontal_menu_view.md | 91 +++++++++++++++ docs/art/views/spinner_menu_view.md | 98 ++++++++++++++++ docs/art/views/vertical_menu_view.md | 106 ++++++++++++++++++ .../images/horizontal_menu_view_example1.gif | Bin 0 -> 7832 bytes .../images/spinner_menu_view_example1.gif | Bin 0 -> 3982 bytes .../images/vertical_menu_view_example1.gif | Bin 0 -> 7198 bytes 6 files changed, 295 insertions(+) create mode 100644 docs/art/views/horizontal_menu_view.md create mode 100644 docs/art/views/spinner_menu_view.md create mode 100644 docs/art/views/vertical_menu_view.md create mode 100644 docs/assets/images/horizontal_menu_view_example1.gif create mode 100644 docs/assets/images/spinner_menu_view_example1.gif create mode 100644 docs/assets/images/vertical_menu_view_example1.gif diff --git a/docs/art/views/horizontal_menu_view.md b/docs/art/views/horizontal_menu_view.md new file mode 100644 index 00000000..d0b13144 --- /dev/null +++ b/docs/art/views/horizontal_menu_view.md @@ -0,0 +1,91 @@ +--- +layout: page +title: Horizontal Menu View +--- +## Horizontal Menu View +A horizontal menu view supports displaying a list of times on a screen horizontally (side to side, in a single row) similar to a lightbox. + +## General Information + +Items can be selected on a menu via the cursor keys, Page Up, Page Down, Home, and End, or by selecting them via a `hotKey` - see ***Hot Keys*** below. + +:information_source: A horizontal menu view is defined with a percent (%) and the characters HM, followed by the view number (if used.) For example: `%HM1` + +: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) | +| `focusTextStyle` | Sets focus text style. See **Text Styles** in [Art](../general.md)| +| `itemSpacing` | Used to separate items horizontally in the menu | +| `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** | +| `hotKeys` | Sets hot keys to activate specific items. See **Hot Keys** below | +| `hotKeySubmit` | Set to submit a form on hotkey selection | +| `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 | +| `itemFormat` | Sets the format for a list entry. See **Entry Formatting** in [Art](../general.md) | +| `fillChar` | Specifies a character to fill extra space in the menu with. Defaults to an empty space | +| `items` | List of items to show in the menu. See **Items** below. +| `focusItemFormat` | Sets the format for a focused list entry. See **Entry Formatting** in [Art](../general.md) | + + +### Hot Keys + +A set of `hotKeys` are used to allow the user to press a character on the keyboard to select that item, and optionally submit the form. + +Example: + +``` +hotKeys: { A: 0, B: 1, C: 2, D: 3 } +hotKeySubmit: true +``` +This would select and submit the first item if `A` is typed, second if `B`, etc. + +### Items + +A horizontal menu, similar to other menus, take a list of items to display in the menu. For example: + + +``` +items: [ + { + text: First Item + data: first + } + { + text: Second Item + data: second + } +] +``` + +If the list is for display only (there is no form action associated with it) you can omit the data element, and include the items as a simple list: + +``` +["First item", "Second item", "Third Item"] +``` + +## Example + +![Example](../../assets/images/horizontal_menu_view_example1.gif "Horizontal menu") + +
+Configuration fragment (expand to view) +
+``` +HM2: { + focus: true + width: 60 // set as desired + submit: true + argName: navSelect + items: [ + "prev", "next", "details", "toggle queue", "rate", "help", "quit" + ] +} +``` +
+
diff --git a/docs/art/views/spinner_menu_view.md b/docs/art/views/spinner_menu_view.md new file mode 100644 index 00000000..81acb6ed --- /dev/null +++ b/docs/art/views/spinner_menu_view.md @@ -0,0 +1,98 @@ +--- +layout: page +title: Spinner Menu View +--- +## Spinner Menu View +A spinner menu view supports displaying a list of times on a screen as a list, with one item displayed at a time. This is generally used to pick one option from a list. Some examples could include selecting from a list of states, themes, etc. + +## General Information + +Items can be selected on a menu via the cursor keys or by selecting them via a `hotKey` - see ***Hot Keys*** below. + +:information_source: A spinner menu view is defined with a percent (%) and the characters SM, followed by the view number (if used.) For example: `%SM1` + +: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) | +| `focusTextStyle` | Sets focus text style. See **Text Styles** in [Art](../general.md)| +| `focus` | If set to `true`, establishes initial focus | +| `width` | Sets the width of a view on the display (default 15)| +| `submit` | If set to `true` any `accept` action upon this view will submit the encompassing **form** | +| `hotKeys` | Sets hot keys to activate specific items. See **Hot Keys** below | +| `hotKeySubmit` | Set to submit a form on hotkey selection | +| `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 | +| `itemFormat` | Sets the format for a list entry. See **Entry Formatting** in [Art](../general.md) | +| `fillChar` | Specifies a character to fill extra space in the menu with. Defaults to an empty space | +| `items` | List of items to show in the menu. See **Items** below. +| `focusItemFormat` | Sets the format for a focused list entry. See **Entry Formatting** in [Art](../general.md) | + + +### Hot Keys + +A set of `hotKeys` are used to allow the user to press a character on the keyboard to select that item, and optionally submit the form. + +Example: + +``` +hotKeys: { A: 0, B: 1, C: 2, D: 3 } +hotKeySubmit: true +``` +This would select and submit the first item if `A` is typed, second if `B`, etc. + +### Items + +A full menu, similar to other menus, take a list of items to display in the menu. For example: + + +``` +items: [ + { + text: First Item + data: first + } + { + text: Second Item + data: second + } +] +``` + +## Example + +![Example](../../assets/images/spinner_menu_view_example1.gif "Spinner menu") + +
+Configuration fragment (expand to view) +
+``` +SM1: { + submit: true + argName: themeSelect + items: [ + { + text: Light + data: light + } + { + text: Dark + data: dark + } + { + text: Rainbow + data: rainbow + } + { + text: Gruvbox + data: gruvbox + } + ] +} + +``` +
+
diff --git a/docs/art/views/vertical_menu_view.md b/docs/art/views/vertical_menu_view.md new file mode 100644 index 00000000..61654746 --- /dev/null +++ b/docs/art/views/vertical_menu_view.md @@ -0,0 +1,106 @@ +--- +layout: page +title: Vertical Menu View +--- +## Vertical Menu View +A vertical menu view supports displaying a list of times on a screen vertically in a single column, similar to a lightbar. This type of control is often useful for lists of items or menu controls. + +## General Information + +Items can be selected on a menu via the cursor keys, Page Up, Page Down, Home, and End, or by selecting them via a `hotKey` - see ***Hot Keys*** below. + +:information_source: A vertical menu view is defined with a percent (%) and the characters VM, followed by the view number (if used.) For example: `%VM1`. + +: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) | +| `focusTextStyle` | Sets focus text style. See **Text Styles** in [Art](../general.md)| +| `itemSpacing` | Used to separate items vertically in the menu | +| `height` | Sets the height of views to display multiple items vertically (default 1) | +| `focus` | If set to `true`, establishes initial focus | +| `submit` | If set to `true` any `accept` action upon this view will submit the encompassing **form** | +| `hotKeys` | Sets hot keys to activate specific items. See **Hot Keys** below | +| `hotKeySubmit` | Set to submit a form on hotkey selection | +| `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 | +| `itemFormat` | Sets the format for a list entry. See **Entry Formatting** in [Art](../general.md) | +| `fillChar` | Specifies a character to fill extra space in the menu with. Defaults to an empty space | +| `items` | List of items to show in the menu. See **Items** below. +| `focusItemFormat` | Sets the format for a focused list entry. See **Entry Formatting** in [Art](../general.md) | + + +### Hot Keys + +A set of `hotKeys` are used to allow the user to press a character on the keyboard to select that item, and optionally submit the form. + +Example: + +``` +hotKeys: { A: 0, B: 1, C: 2, D: 3 } +hotKeySubmit: true +``` +This would select and submit the first item if `A` is typed, second if `B`, etc. + +### Items + +A vertical menu, similar to other menus, take a list of items to display in the menu. For example: + + +``` +items: [ + { + text: First Item + data: first + } + { + text: Second Item + data: second + } +] +``` + +If the list is for display only (there is no form action associated with it) you can omit the data element, and include the items as a simple list: + +``` +["First item", "Second item", "Third Item"] +``` + + +## Example + +![Example](../../assets/images/vertical_menu_view_example1.gif "Vertical menu") + +
+Configuration fragment (expand to view) +
+``` +VM1: { + submit: true + argName: navSelect + items: [ + { + text: login + data: login + } + { + text: apply + data: new user + } + { + text: about + data: about + } + { + text: log off + data: logoff + } + ] +} + +``` +
+
diff --git a/docs/assets/images/horizontal_menu_view_example1.gif b/docs/assets/images/horizontal_menu_view_example1.gif new file mode 100644 index 0000000000000000000000000000000000000000..e02c60a44af7e108ac7c5834030d7bdccb0b4863 GIT binary patch literal 7832 zcmeI0XHb)CzwYle5<D>jAWeF4 z0fGcj45&*$Q9!z72@4S{FNbyZocFxveA}~T&+I+(-t&BW<|#AxbzS%M`&(IC>Kk~P zK()YES1qu=AOJuCfB^sp0096O07w8(0B{4q0{{j9UI2suzyW{jBLGYRFay9604o5j0k8$Y z4uB&7I0E1Vz%c-v0dN7p6##btyaDh9zz+a_00IFB1|SrGZ~!g+%a66cE%G6fzbP{#96*EQ~Y7;mmM& zbG!&uM3g2fc34czPE6chT*660(pgf9Aw~2i5`Bm={xUKFGO|Ik@?r7{5ef?D6_l?i zD_>PsiBVBus;I`PswSwar>JYBYiML>Xy<9`6zS;R)YZMMt5>3@SE{F9rLSMDZ%|`k zP-|d#&(NsV$hh6uxWkzI8=2fkrVLOhgA~(YQ?pSs^C#vO;}#Yi3(E;h%SlVC=T=s~ zTUpOo(`IS3H#D0$8=D0i+jq8yR}R~)+u6OhJM!_!kxxhH8}y@_M~`kDwf|yozin^- z)!yNogX4Ec#~+SPdrto&F5(`KorR-=8HH}4t*!~%w*nyU!V&0w`R%J1fWK_Auc?2V z`htfoJ&b($fl?`7bn59Zs zHVFWcv7BXUZleH_lm)HzU~IMWY5eZwc3xR80f92wOks| z3~Dq8Pkmzr-8-q?({8z>`Y|LWr=ED zi52-!i)m84K(oGFia2VqB=OQ3m2}NGh!W3JxS_aw9on=~l5Ky{aVeP*eM3f2j&D)M z`YQwm6u(ZF%v~NVhhXBqu92{1Z2c~RHm?c$XgZ_A3BjVH%3-IeCd_G=W1uGj0(-GH z%nvOb0hLKcnY7|Ms3&U(cUJ71H)WMOO%7B^?Pg!>K$q9%Rv3ne*W-VP1r|SybgsH@ zAQoTS(C4MH8u|qKxvs#)uKQl+>}j|%4sB$U)pFR-K(eiZlvZOUbcV8;y)>HkF@u#l z^U31v36-F(FE|@)gY;}w3OU0h^|3h6XRlpmVjMRrZ->tCS3`RvD;lX{Eae0~qd+O@ zWMyAtQU489`elBJk}%wSSHZ`8cx$7DAk4*s2^o7}t8+oV?9%(Q_FJlfky3o#I;KuA zY{X5w+A&?$JN2_)`teLO1n9kwHW!$E;Hx_NBdGtOTlMLT$jm>pqtEw>`0Vw58SsF* zVF#tGZ9^(?JhD{TY!E!hEHbHXvby-oN12?dppbz%+OT9>Thg1?yIh4oKgSB&AGqb( zuH~_93L|MTbf$FT)H!cW96rjth40RWyL~ zNPKc&NdA!-b3-D2@an0uxBuvg?0#-weZI$r{S^$886hJ+pBnfbaP;R4=0St(s<3PdDqM_LRC-WN_R#leew@mw}#L z&Db~ZNjv%?m681QGKmaxjD=;^_jFUjMe|!^dXuziwD%Re1t!_Pv0-dqZPft-;6zjc z5>Q+uI@3u3bFI1%f^PSWsazcUky_v!H3uHW5v)6>)J&*n>A~?d~>7}O%OP> zx17k-EO3Uul|Q6}WpoLETktZCd1roJbU@*k0b5>6P<>omAosaL*_W7I>z<#s=h|d* zmEuy={PeQV^@z&p$!zP>cUH&&gk)){B+PjMIF5~lQ?Vm^Onm2%nJgA16xsquQ%=j6 z_1WU$8#QFI{Lr})REm}vKFKQ)1#`2@P&9|d{!r2XDLX+i(4L@k50(nWDgx7@(%c+H zXYnChE4LbAo-(|m&|lC7Kf_6~3$4O9;q2Nyo@IDEjU&&#B<**otB(%fG`{C=eyS_s z1{65jeqqxiXvAW#&9Z2fHR?t(=1ARq9aQO|%hQ>J*t&>&To5y(p93*#1XextZmoM& z80bMS)=R0zxKjjTy3`3an8HP{JsLB>@oR*-1iHb1GgIhT1Co#o-KJq5UF68beo+Ck zwa14^`4D~-pMMphb?oRPx&?eQy&o8I4_>BiAisTUC*Xd9)5%;h0v^j;s(l!Y`6lzI@VxV$g*Ci> z7vh{z-p`0?Ji<4ahO*KJvZ;zdlSLGYX{?aa8#(&Sxmu`uXGk-%Dc#rho!G0LNBZMU zndcwBlls0hOy+COO0r!fiSM$hcFj2jj~C?+?T*kho3B^dE-5p1N1ex;^V=UUsbAV1 z^WeK*IBdJDeRKD*pWXeUmyehAx_3pM1ZUpAwPL$s_-c1NYW#lj*T*X+?XrY_DT~HX z&3%yC?~f=r=!C=nZ;Slzd4mt2_o)iI|GRsj^Zz;9i33OY{`c9w&}Y}9x_`E7k(9he z52Z>dZJwes8EvnpvP09j)ivzv{qCBB0&X?NgGDc51zFt0Iy5C7<5E`2K7CwV( zZkG0jzoSMGUqwY$)(u!#(Rhp;ypGa`d})f%-XO@Uu(78s(~m-kAw=Pe(k^(c@|h%? z`qH3iq9E=xYa~|bEX!3qk_WC%o~``B$_shb9+VK8oo36b>}ErG7snDFpDaI%l9Dfs z(t5=rxcAKE=&ZbdoPF?I+vrl5ZyohJ+PtWGZhbV>pOMJ8(cIs5?SiKC$h3~%1S&-w znG$8Q*^t3&S8GC@8^NjC+S_s5dcQ`*S7&{ixf0s6AT+0Oeuaqr^%RrRA{!gj9kKl8 z96O!FA(cniJIeGEPL1Ici8|@xRfK29&oWklgB=Dt2uYF>2p_}|u+FTA+q)16H*?~t zWOCPMd8`_BqQaFAv!%#^7;lS^DHJY$4j|U-42cDx!ntyxT1q~-uGb+IxyRAEiPzb8 zSC5Y{g7=Um>VJt zD6&rbZH{SB9xY)&zoy{LHi}$0C{R%xo99&`YyGFkH8oPe6<3}6`>Ig=b#ozac&?(@ zFyhVQ8!e=#*G-sul2Jlu9^x5ob?h#S6re8H5qhv6@jjmin&Q1g%75<|?|!<({6xej zRSnnWbxA*~bBeKE%MVnY^X4Ra75TYavYb5gT3t#|&$C}Z3lvC;{beSH<@_=_nn zYj^voDF~?9H=SyV(QsCX?CPZAWDgt44NsWl!#`rcXJUGm9`=p8Vmy}DV+gApu5(1j z;E*o<`LTmd`83V(+CLt7x9!Xj|GcDDFyH?wv{g0heM;=pl4s*?y$X?o z$6771(uy|(QZyGn{vtw2;5X-{Wj9i=!2|rh5~kbpNx4_vZTLz?@^I^8lU+aO%#jzh zqF#|3Sc@ZMp$EQ1Q%bOKLZWR*^35RWdTLg3)fexDKtvJNq9%sVb+_7rngDhLx+N>(EI z3kUgay7*q|9}$s2ZYp`>xS^E!VzNzeMOJ1F%h6W3H)I0s)f+>>s)aF0oJz%er8Y;H zPZGE(tsmsFq(Q3L=n%kY60p!#wB!5ww$KoAeLGZz4(VRk=ZFPVADtCD8N7jL=9C`g zh;aC}RGZyyF+VhMiYRn3PCbR*@hX%b`*-p!cVCH|e`e1Xr;OFN&lTwBC5^;^SRsK0 z#i@rS`&=P;Wt2TZ60s+&h3|94q6M!(TcGF-Gn#dtn7}Bxbh7+#((S0(4?7lu+TIr< z(ULP+l*5_EZ5^^o7BsE|-AsXl*617Kckx%bhDKjhPUKPZyfV;j0mC)NpU6M2X}f0u zp*hmzRF3b9H1toYmaOy00chwcdD*mJQ};ai=l^j1@#mb}qrbw8$`u-detz3JGJDa| zoE}LKIxOYwdHsoGcs$L(#}T}yYLJhOJM&@z=yGYURxc3b%@ z0ejdYC}apm3G`&fiW>!6+=2c~ITNNVeDhw5G~c^NO6)1(8!70}z^r0$eoFnlYxPk< zUB2?V4flR+y2*WQHMAtC;M=B+MzmS=^#tr>i07cE115$e5UN$)=xR<55%LI~h`|b8 z(cZl={T9-vrNXsOeF-6Qohs}|Zyv?>_Bda@qI%3$`9?^|pGTA$ zKIm|k(3kI%F`A8iOpLw}`I)0a79HX!tsC(SLf~vs9Cd<$DLOubK6Ubx!6UIi=`F;o z;Ia_x>yVypy;r^ZGh(k#cewKY@+$OH_*bzD!q8Q&3Op7P&a z67es!mi)+9dZA3K8=;SHCw>gf1!U% zA#z$Q&A2VvRVlmNx@aH$%ab3=+1@xLID?_J_>C89DCD@(LJ7Q;jO(a5lIPt#VOh1{ z3$#f@b|oyyFhSXg^is|JX3mek1jy7q@2dK<-?vpqnhj;X1U?s>R@H!h-(HlVH+XoL z!^aKMF%x}-I*11Ze^U?PRt76L1RA-C6U4U!u7%K5@lW$QUEc`sALN=S?|d9F_D$Dk ztZ;fVKbrC7)vd^j0yeO^m43z}UXoL$Z2_5X{1Fu&$oaD`yUzDKmx@pLS`O?U&)(ph zqVDt4jPP>}PZD~zXBJ-VJrb3e7FRFI`E5o+Ww&o>k0?lunGB)0MV;#`kaGKc1J7`t z+u(W;jZAsz7Wjv?KJnuEL4D$-J~@SbYz!vSj$}J8ob)h3u$`GmT9jK5W|TdY@OIW) zJXz2s%02NAx^*syA|^+_jQXNGC#Dh#A*8|Ng-&H}`uwtZ5jyXe<-c)sQ6};DMMdu< zJ+YKU3N5r>R@<))Rbi^-wgIsFpP%M}5}Be04t`3m%Ezup`4$Tuvzol~Yf!&0@B8_Y zgyLiBGm0ffli~7VWx?6jxyC;B$sxu*qeG+#-j+doM2IKc(E-zkK#HS>Ta+CR;QEAk zVNbdoYX#P5_JNH#`)+c%J6coQAEXu7^dP7|z&%!O|7f`^oJ+e4&7N`4@Cc@S^kj)R z0@xy-F6dm9*Ti=5_e7|7I^0sgc3~tu)O#`2Diht9!S94Fo|d7Q+8;UlvjPmXw6OfO(H49%)^dSQHTLnKdZEE!#AxIPGDExSU7`&ELc!s6%oyu4)+mb$QN7G+=?a67{Z_EwDRh>wj`z9w&`YG-KqXrZXv#le&?d7GPp zCp%o{L(>Ex(6p}C1bX$Pnlaois%r>-BvIx#MJ$CnSCQ@Edx3~@^eE5H7|3j$6G)3y zR_8HHv7!6Us?p)=!T$5>l*ZvR87*Nrm*eVvmN|#5Ipb7%vhe*`C^L<>%Sv0Jla4wqGEa+&jIt!ol5dB8{S;3iXBYDyGC|IYsH047Tmd;DR0bCD0uFXJFGq) zMF^bExxB~sgxs~VHYhG;^&r}F`ekb8%f-f8}N;20ImJI`AJOQ+|FWd+e{0EloaYys1cJ@as~@Un5g~chkfVo(k@$ zLsx94o4iMF>J#l25Q0P{Z)4uk9v7Xei8B7HTxwI<$!VGL=*d;8Q%X#n1WE;IDEF9IkzRdQLIfyX)ed>sFHcnc9y{w*&SCZXy4t*6`4ghaF6` zb|l?L3UB#AZwMfSS>n80d6q8{ABsLtbwzD&9Mihn=xs#_>dnKdonsClVEQCFHdBHx z=G`@Ji7gozGJc9bOHOQSNX&LSmUY6m2C{@lRP@W{a%Y72S6ut$4 mcu5JdHQ0?g$BL+H5wf>tN1VO>UQqn!1@rGG{?EYV(EkEIMc7{e literal 0 HcmV?d00001 diff --git a/docs/assets/images/spinner_menu_view_example1.gif b/docs/assets/images/spinner_menu_view_example1.gif new file mode 100644 index 0000000000000000000000000000000000000000..8b7fb1a86030ce7706a51e1dfb578f355b7cc938 GIT binary patch literal 3982 zcmeH}X;2ep8pjhL2jPYwXD|VTaEK6;ORx!Nz(6Aq5{_^aF2gOCqJcn=ge%-vI0FfX z1r!jg>#7_HVhgNx3k5Ayr4e0(T9kUR*x8w#{m_rQ)9&;?^Ul08&!_i!{=fh8dU(3q z*+)QtR)9DAXJ2~&AP@)wfxuue3HAP@%+9z>x~`uh3?1_p+PhKCLvGBPqkqtRw&W*7{{+S=O2#>Upx*2&2Ui^V!S zJLB+9?9?@uC;0s;caWHN<92@DJj3JMAi4h{(kp;D=#p`l@6 zVd3H75fKrQk&#hRQPI)SF)=YT8Z9<9HZCqMAt50#G4b^2({wsLDJdyAIXNXIB{elQ zEiElQJv}2MeI>6_u5hTrRh&s;auWx~8V4wzjseuCBhm zzM-L^v9YnKsj0cSxuvCr$K$oOwzjpkwYRr-baZrfc6N1j@%jAj?(UwR9)Un06bgHL zd;9*>@2mr;JvkpYe?J!-(G6o^DGl7m0riUv2nGNG%s;X52@}?*%b$?^4t7RDpD1>v~@1&s3xR`a)(dchA;a zM%``kywdYkvt9be%FGqPTpN}NLwJn{#XwkwwBFV5f+9UL7snBakvN$*gE6-Em}(F9`Ie)>dq@zya+)#k@1>J#%oGsR0KJ(Zn4K6bQI^q zZLA&@RXvRk#XWn5f*|O<9Ugib03-uJFMA5k%YA?%LaFvRE+eWWGhCS$G0cLQjI7pX znT!t=q>2$2*SM!^i>bMKnn>r1xrJ6lC6f)SBD!8fhlow(S`tgGea5L}Gi$;oMW>I8 zjT*UzyHqZIx{=R1NqcQb*Jn?4D*p_epQ3y7k&4i|varS_QfETn-g*x?#XX^)Z%4;hb_2pq zJ8Qsari|$wmnAXId)sw=WFN+&dVlD(KF9#4)h3ZV`l#;`*~|BC|6pznj)C>?w;yO@ zWbPDT!3=xiWqEZ|S6E6mh)$*z;4kTwjy;QmCEwuQkz0P$RILz^K>|rjO#xUu`l)%6 z2FZV+7Sa~U*kl`_L#8yTI9p{Y&A5A&GL9K6X(f~U%ipLT%b1?fp^h$SDL9T)_UPfn z;g?d=<(H)7OxjNkU9#sQTT|M*LKc3|Gz&u@ZgY@kT4 z=%9r?rDS$wH^`2No_NyY7iv$a?>__4@3C(et5l-_431; z)#4)`cc0WJfBZ!v82q>m1pYf9!9dIXoZQb$s0=__M&=J&AOqz0(_Ur&9eaS_aVU1E zy_E_26g2bUcl1rpqaB5UjwudQtp~qmfSTeUjcMi$Ms9NUC_l{m2IV<-JK!oGjb|#} zMp|EzSsd>y6C-q_iMl~nj9Iv)tX_zUzp$QX`d}z7XiLbp1$(GE!qOGFgGZY-a+)Gb zTh07sHx?;9LgFR&u(2hyfmnVxx`-vK>bmBB*dQ<hyv9H3!dA zT|R4Yh}vAnmz0#-$8=&B{rg70b~ntm5G_cjzFPb`MRr|F!WFg-ol=}$f-*&4!*B8y zDJw>qF3ak*=lIoy?TxmcO=0mq%H^pX7gCkQM&R|VY1hAUVBbH=yWzFGE(`wMPcvYD zXgGkvuS1iTiCb{~v>l}FP}#%^7bjU+3;{plXLi@kA6gLRdW(krsp^nD_n z63k3#=J3&tnY`H%{Ov=T0G{J#k8eKnQ+n2Go5!qKxjL#+iH&@YJAeFYk{Im$eLyc) ze{|d7?7JlOWi2J~6FA}{rKzA8=R`CIKOMFQHPs`xZ%Hd4hgAUaxR!0WZnA{yq3W5! z*Hx3kWq+@6AP~653e|it$x{AEj!>1Nb0>9ye_)({GnRb!E#vkt%h*ctRog#VMr9+g z;nxp^LQ=M>$`8&?>edO45~LdgrTOZ{Vs>iR3>zVB`9Ru3p|#pFN}q7;r$~53fWHi$ zdxyY4I%;g-7dlsOwdYoD)x@WG-nIhAhem4x6zAYU>|B{9XY@j$9M|$NI!3^C&>4FpYvTf<#|HL>^E@R7Xv%vmiS6u3T1P$OHj6Uox1bn;Vk)cr3x;j zKV%o<7HP*h>HNB{9z&UJIO0WuI)I}3LOgZM{gjKq~W+I^07bTlX1*}TE6m}+@wd5h1D62SD_cLvsEixLQ0 zpobC_Uu6#V2+$CP)CT2qCvlzKso|t(sAiiU%@7qtfQ&`>Gs6BK?eUww`7aiZ{}Zt+ B#RdQX literal 0 HcmV?d00001 diff --git a/docs/assets/images/vertical_menu_view_example1.gif b/docs/assets/images/vertical_menu_view_example1.gif new file mode 100644 index 0000000000000000000000000000000000000000..7366d8130dbada70680437908d58f1ad98b2c0aa GIT binary patch literal 7198 zcmeI0XHZj%w#OGFga83Tl~5#hyjQLNCIpDzyU}D$Nz(s%{fM9@7fJ*>Z0m1;n z0ipn+0b&4R0pbA?0ImZh1Ed150B!(e0AvAV1LOeY0^|YY0~7)j0Tct20F(lh0oNTs zlmN0Acy0r#2zUztT>yOfz@G;Kxq!(5!E6xD1d&@Hb`!+YK#~PpQb8&OaLFKZ9pn;W zYXZo}gF-AQ#(+{Zs6+xW9MrCYS{P_t0a6HP1p_$Jm1tMy$ga8Ff0N|imt|gC{3KKF-2523w&ZCpdU+AUF>ccWT-v2GjX-6*2<9d9j1C|iRh-j z9H!RYiLnSM*WGsXUYODqeo3pBDn(ThHUV+H;*)>)#D#?XoI65t^y_sgu#$R4)n+iV zZFSZ~CoK#Ozih}fZWxlU-&nO>WC>3eMhc1$26_TXPiZ^H-^yuVZQixp3Ohf1QNI>d z#kg!M?fK324Lfm06kNK2it^-?X{nnO56DQ- zk11|XFz%LXrAb>}@T8TQ$6r6r`AlS{IjKp=HqOMAO7gYE-4;1uq|;7xeOvcJ)p_p5LEfX67_F#rkMAj;HiLZ(2N(S=qeYt-jQ< z{_@SRh^Ze5`$%ljhw%{pG8&;6dXbXEX;s+e4sDSa3<{6fh;awz=%T2N1I3EjjtC~P zy71-p_WWREl_W`%txm!i)>B5rxxuB~Mitt~IK;-Xzrikn$eKQIq|{RMqL&am@D*Kb!)R1y z@9F1MMa;DSxM~R}VPo)A`Jv_R{ifBF36IR|&jK_Dtt6DR6lo{K2pdOs%f1;W;S}?z z_A>{5Jfyy)^X9Nn`%{Nu3Z0m}6Lc^H1`;uTiPbIqMxzsv@jPAI*ulFkT!-xsbx?6q@)Ic+cSC93X)~{P)B_YQQp{ig!*HCNC!(rxa>rHO zZ*mYw)g=e&a|tQPPai-<6#5DR6>lg3E=aPkD+riRQZul+SvQ7=sw@Q?C-gqDCl^D< zi-O>wNmzvrDqaxs4N-WbaC}}YU<<@$NLUqVh~;xZi$zI=soHAA+5J?6`@}Ad2%8uT z6iC17?cUkElIWLEC_8J`v*-2j5d}S0{cFqj;wKi+>Jw*O^L~TR&6XrO|<|JAz#~7MUuIi<3IoB!-qI1wqhB1G8N$ z1#A&<&(}6e#+RD(UzJ>YYvpX-_E>~(6F$e2JZ+#yLd^+w2^^KOK+c;o8*c50`}}-V zE#AvY-Doni%6>*)ZTSf?rv28S428dw8qU6D9o(k#X5v2k$tNCt)K^T&I(C&4o{!f@ zIa547Vbg1Uy0t@dDoV7TM(Yd--V0JU%%o_|S~KWkUhDQBW~8L|*{M+P>z7#W zIBW5$`SnI+(35h@-(P$7tJEkQ{IFm_$2&y))Ix^bMGM!xVw9fJPl&%{CKynbA}&tg zGafLo!Dc$dVs(RVT{2rcQm`MDwdOBh*l}R*LekUKL-?(ydOeMq2L(AnP)}b2l!J`O zs|d}s@+=cZc(54JR^BMh|^y zM)Fi%xarZ_cQOe-BH`z=`&HODYAL_lr#F1Jw_TEEW6Nq_RUjAEl}{UamMDeb-P7k7 z>8ls<`4{nuzekd2=GTWbyaDP!gDu4E%&e^N3Oc{d8oMA`VtJW#=Imlpsi^UF!rn5& z@4HChdbe0aoxW&+sgd%})Q7L!cckJJyZFD>;ax8Gau<)jBptD##+^vop+EQx+ueY#h8IV+3y@_QFuOXXHP}hYLC-p^;#5PG7oV*vT)WCS!#`4R zn?a4;Ef%6TC-z~uL@ZTh#9$_-GgqJYxE|lS{4FtV|0FKy!dN@tX-TQxM(t)xs@m{} z?V+j}lpT?AyKRn&rzoiEHvZ~!9cXPi|4MYkk6gH=IFM^}f6SNpW8tdC%95BSvh#gz zTtCt!Kxdqd+OIv9>7Y#~XPK5?5tN3%DsC%TsuYS%a%s{69R|O@-uN_XST0%76jaeR zmi+NZ6UFb&+>4tRWrX+X?RIlsDv!+r<9akVXu*PlHo z&(W#8x}JVMzs>OQ*IigNCplRJs6V3}xPDKPlCBi3T(n0>(PJh7p-Y-D6!0`lVoC|= zP?#r(s#K8P>f#m)cqlxhLpCxHe(2@zkhsr;&P_eg2qT#NlHbI6PyR}cNVeKJ_uhxk zWZN{${)pG~4Ts~q9nu^x%uU}s*_ULYcJ;9?U5-wVASk(a6U;N+yKx?JzQt4YOuLuC zCE2vzSdZ*0uW`g&GSc1Ck+~|eMWdY>Fil_{33#R&Z7ZFik?YXMTh#ve)V3R0At9xz zOnQhVsj)3QX4~y6ik7#TZk!PBvZ%BW+k)RK&q{A(U9jjbp^aLgl-qqnJ{0v>;M8ie zrM=MwT`BFRH4ne4`4-fp&h_6N?v^mCvHRS|zSqNVX@d9Gu&lh-r}E=Y?U34@?GMf( zJ3gw8ttOu)B_ZFOc5Fg+dNeXohL+N8Y5b-n?>hp%4;HV)S&;ISaj#l9?^n$nIjrwb z6-T8*<~2Ph=AGLRh85-VxfdKsola5G7+GP{x#fJ$(3BaB?C8Ze)4estqzT$mjuDua$Nq-`mB7gXdk`KB#X|ZSEiPekeOYbRzuf?T^dR zAdN7a9hV($7ymdnVpq%YseQoyJ%)bjZ+4=Aa0PqPTZL&Iq0{2`qoiB2Jwd>G+{#W4 z^XT_R+2?5y`95BG--PL!7RPs%OriqsT7^7M&t=i)EiV&M(;4TiQQL!qev>~G>|6+G zVb-dnx0n4W-_hbV}@J>8Czi9>y0WIZljF3u9?t6a+|GHc45 z&0IIn+9!|MaeCkJFXkou_b${uw~+Sjvki!P9q5W8W8JRa?tT4R=rC!}RY1s3&(IO? z(3aYkf90qx0{K@BQ_x_UA+M2#n@B@(j&)B|>N4|2=*GqS`bm_|% zx|mLoU0sf*{LB{?VwgQv{5%w6X61H+hQzG%?Tinz;7bhEgO6686Vt>+z`3S*^ybXqwOQQyoqsS)r z!*&~Q-k?m`KlgIs)oz9FXDY6%Rn6JK7L(s69vsFC)hm^Ae>Lsy!8X$x)d-9z%uQ}f z-i%YFu0>dIGJE!skJ5WwkjBIOl|fpaXrdXR1Ahvynmu%S`CWO<2>m2k(S-lkvE`bM z4wkC>OO0i%KZydgqgzA1bsbbk=z5Z{IEwIaXzajZ%TZ)pA%$lzq2h4ORK`lqV5R@G3o3d!t_A zBq3@=dQ9iBB(dI?^)&>yt+N|yE(QF}tI3{*yO(Otkdl&C?kbQj_xBLqp=6iu-!maZ zw`E^q3pCYbxW>2jTwDLBD$2XI)G+VXa<)~{d6gfR;o@sXLOxJKD7?!F=xu1ue}a5RYv=HZ6*&t>%^;!22Xx z)(qzUtTiLG^t$SvIB>Q?V#Fs(cHp|Xe0?B^vM^veV%P6|zWam#W^G*Q#uvec36bv8$t&{F0K5rbZNuv_`;YDZqCqIhwY;!{Aldg>NC_` z_vh0MZ?}h@Z1XiivAD1*by%r26UEIDoy3s*C!UyaNBC1Ro zMH7@r$0YI0@&tEgLx*H@mCKFdiG#2aDNlg@dDL+=^UgyOTG)o43R)VmL_*4p2rX{sH+#{T;0ap05DGe6Ic^gr7?9wF|{oqL&E=Fd0We|)N^ zf3V}PeBM7b%l^hno?y*u)gIr)G5>P5UW-8aH_dF)LGA&0^6VSE%$))TmQ%h@eF8GC zm;7L7q&_`%Z(AsOT+<>ps5!dcOTDJzCDB-PJ3gl-;@KUw{*QC`R`rU?_nFTvV-|AK z05O|%QzhrQO6F#C=BSiP@*l6V_F1))(=;nd qQn Date: Tue, 25 Jan 2022 12:37:40 -0600 Subject: [PATCH 02/12] Minor changes on spinner and full menu --- docs/art/views/full_menu_view.md | 6 ++++++ docs/art/views/spinner_menu_view.md | 10 ++++++++-- 2 files changed, 14 insertions(+), 2 deletions(-) diff --git a/docs/art/views/full_menu_view.md b/docs/art/views/full_menu_view.md index a513117e..55f9b4cc 100644 --- a/docs/art/views/full_menu_view.md +++ b/docs/art/views/full_menu_view.md @@ -66,6 +66,12 @@ items: [ ] ``` +If the list is for display only (there is no form action associated with it) you can omit the data element, and include the items as a simple list: + +``` +["First item", "Second item", "Third Item"] +``` + ### Text Overflow The `textOverflow` option is used to specify what happens when a text string is too long to fit in the `width` defined. Note, because columns are automatically calculated, this can only occur when the text is too long to fit the `width` using a single column. diff --git a/docs/art/views/spinner_menu_view.md b/docs/art/views/spinner_menu_view.md index 81acb6ed..42c88e14 100644 --- a/docs/art/views/spinner_menu_view.md +++ b/docs/art/views/spinner_menu_view.md @@ -3,7 +3,7 @@ layout: page title: Spinner Menu View --- ## Spinner Menu View -A spinner menu view supports displaying a list of times on a screen as a list, with one item displayed at a time. This is generally used to pick one option from a list. Some examples could include selecting from a list of states, themes, etc. +A spinner menu view supports displaying a set of times on a screen as a list, with one item displayed at a time. This is generally used to pick one option from a list. Some examples could include selecting from a list of states, themes, etc. ## General Information @@ -46,7 +46,7 @@ This would select and submit the first item if `A` is typed, second if `B`, etc. ### Items -A full menu, similar to other menus, take a list of items to display in the menu. For example: +A spinner menu, similar to other menus, take a list of items to display in the menu. For example: ``` @@ -62,6 +62,12 @@ items: [ ] ``` +If the list is for display only (there is no form action associated with it) you can omit the data element, and include the items as a simple list: + +``` +["First item", "Second item", "Third Item"] +``` + ## Example ![Example](../../assets/images/spinner_menu_view_example1.gif "Spinner menu") From ac13a437c34483c50dc3c8484b7727dad2f1e8b8 Mon Sep 17 00:00:00 2001 From: Nathan Byrd Date: Tue, 25 Jan 2022 12:41:20 -0600 Subject: [PATCH 03/12] Added menu views to navigation --- docs/_includes/nav.md | 3 +++ docs/art/mci.md | 6 +++--- 2 files changed, 6 insertions(+), 3 deletions(-) diff --git a/docs/_includes/nav.md b/docs/_includes/nav.md index cd635928..a0788ddc 100644 --- a/docs/_includes/nav.md +++ b/docs/_includes/nav.md @@ -51,6 +51,9 @@ - [MCI Codes]({{ site.baseurl }}{% link art/mci.md %}) - Views - [Full Menu]({{ site.baseurl }}{% link art/views/full_menu_view.md %}) + - [Horizontal Menu]({{ site.baseurl }}{% link art/views/horizontal_menu_view.md %}) + - [Spinner Menu]({{ site.baseurl }}{% link art/views/spinner_menu_view.md %}) + - [Vertical Menu]({{ site.baseurl }}{% link art/views/vertical_menu_view.md %}) - Servers - Login Servers diff --git a/docs/art/mci.md b/docs/art/mci.md index 79135554..2e218200 100644 --- a/docs/art/mci.md +++ b/docs/art/mci.md @@ -121,10 +121,10 @@ a Vertical Menu (`%VM`): Old-school BBSers may recognize this as a lightbar menu | `ME` | Masked Edit Text | Collect user input using a *mask* | See **Mask Edits** below | | `MT` | Multi Line Text Edit | Multi line edit control | Used for FSE, display of FILE_ID.DIZ, etc. | | `BT` | Button | A button | ...it's a button | -| `VM` | Vertical Menu | A vertical menu | AKA a vertical lightbar; Useful for lists | -| `HM` | Horizontal Menu | A horizontal menu | AKA a horizontal lightbar | +| `VM` | Vertical Menu | A vertical menu | AKA a vertical lightbar; Useful for lists. See [Vertical Menu](views/vertical_menu_view.md) | +| `HM` | Horizontal Menu | A horizontal menu | AKA a horizontal lightbar. See [Horizontal Menu](views/horizontal_menu_view.md) | | `FM` | Full Menu | A menu that can go both vertical and horizontal. See [Full Menu](views/full_menu_view.md) | -| `SM` | Spinner Menu | A spinner input control | Select *one* from multiple options | +| `SM` | Spinner Menu | A spinner input control | Select *one* from multiple options. See [Spinner Menu](views/spinner_menu_view.md) | | `TM` | Toggle Menu | A toggle menu | Commonly used for Yes/No style input | | `KE` | Key Entry | A *single* key input control | Think hotkeys | From 16eceab05b010835f7677c87a225bbf625397b00 Mon Sep 17 00:00:00 2001 From: Nathan Byrd Date: Tue, 25 Jan 2022 12:44:15 -0600 Subject: [PATCH 04/12] Tweak to full menu listing --- docs/art/mci.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/art/mci.md b/docs/art/mci.md index 2e218200..bdd69056 100644 --- a/docs/art/mci.md +++ b/docs/art/mci.md @@ -123,7 +123,7 @@ a Vertical Menu (`%VM`): Old-school BBSers may recognize this as a lightbar menu | `BT` | Button | A button | ...it's a button | | `VM` | Vertical Menu | A vertical menu | AKA a vertical lightbar; Useful for lists. See [Vertical Menu](views/vertical_menu_view.md) | | `HM` | Horizontal Menu | A horizontal menu | AKA a horizontal lightbar. See [Horizontal Menu](views/horizontal_menu_view.md) | -| `FM` | Full Menu | A menu that can go both vertical and horizontal. See [Full Menu](views/full_menu_view.md) | +| `FM` | Full Menu | A menu that can go both vertical and horizontal. | See [Full Menu](views/full_menu_view.md) | | `SM` | Spinner Menu | A spinner input control | Select *one* from multiple options. See [Spinner Menu](views/spinner_menu_view.md) | | `TM` | Toggle Menu | A toggle menu | Commonly used for Yes/No style input | | `KE` | Key Entry | A *single* key input control | Think hotkeys | From 742418daebd1274358a90387c35402a3d809cfab Mon Sep 17 00:00:00 2001 From: Nathan Byrd Date: Wed, 26 Jan 2022 16:21:40 -0600 Subject: [PATCH 05/12] 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 From 19a708c2483d71483836720179d2eff6a638fa9e Mon Sep 17 00:00:00 2001 From: Nathan Byrd Date: Wed, 26 Jan 2022 17:22:13 -0600 Subject: [PATCH 06/12] Added ME and ET, additional cleanup --- docs/art/views/button_view.md | 4 +- docs/art/views/edit_text_view.md | 41 ++++++++++++++++++ docs/art/views/mask_edit_text_view.md | 40 +++++++++++++++++ docs/art/views/predefined_label_view.md | 10 ++--- docs/art/views/text_view.md | 15 +++---- .../assets/images/edit_text_view_example1.gif | Bin 0 -> 4346 bytes .../images/mask_edit_text_view_example1.gif | Bin 0 -> 7117 bytes 7 files changed, 95 insertions(+), 15 deletions(-) create mode 100644 docs/art/views/edit_text_view.md create mode 100644 docs/art/views/mask_edit_text_view.md create mode 100644 docs/assets/images/edit_text_view_example1.gif create mode 100644 docs/assets/images/mask_edit_text_view_example1.gif diff --git a/docs/art/views/button_view.md b/docs/art/views/button_view.md index 23f52229..b9b9a128 100644 --- a/docs/art/views/button_view.md +++ b/docs/art/views/button_view.md @@ -23,8 +23,8 @@ A button view supports displaying a button on a screen. | `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 | +| `fillChar` | Specifies a character to fill extra space longer than the text length. Defaults to an empty space | +| `textOverflow` | If the button text cannot be displayed due to `width`, set overflow characters. See **Text Overflow** below | ### Text Overflow diff --git a/docs/art/views/edit_text_view.md b/docs/art/views/edit_text_view.md new file mode 100644 index 00000000..e8eb779d --- /dev/null +++ b/docs/art/views/edit_text_view.md @@ -0,0 +1,41 @@ +--- +layout: page +title: Edit Text View +--- +## Edit Text View +An edit text view supports editing form values on a screen. This can be for new entry as well as editing existing values defined by the module. + +## General Information + +:information_source: An edit text view is defined with a percent (%) and the characters ET, followed by the view number. For example: `%ET1`. This is generally used on a form in order to allow a user to enter or edit a text value. + +: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) | +| `width` | Sets the width of a view for the text edit (default 15)| +| `argName` | Sets the argument name for this value in the form | +| `maxLength` | Sets the maximum number of characters that can be entered | +| `focus` | Set to true to capture initial focus | +| `justify` | Sets the justification of the text entry. Options: left (default), right, center | +| `fillChar` | Specifies a character to fill extra space in the text entry with. Defaults to an empty space | + +## Example + +![Example](../../assets/images/edit_text_view_example1.png "Text label") + +
+Configuration fragment (expand to view) +
+``` +ET1: { + maxLength: @config:users.usernameMax + argName: username + focus: true +} +``` +
+
diff --git a/docs/art/views/mask_edit_text_view.md b/docs/art/views/mask_edit_text_view.md new file mode 100644 index 00000000..da1ca06e --- /dev/null +++ b/docs/art/views/mask_edit_text_view.md @@ -0,0 +1,40 @@ +--- +layout: page +title: Mask Edit Text View +--- +## Mask Edit Text View +A mask edit text view supports editing form values on a screen. This can be for new entry as well as editing existing values defined by the module. Unlike a edit text view, the mask edit text view does not show the current value until the field is focused. + +## General Information + +:information_source: A mask edit text view is defined with a percent (%) and the characters ME, followed by the view number. For example: `%ME1`. This is generally used on a form in order to allow a user to enter or edit a text value. + +: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) | +| `width` | Sets the width of a view for the text edit (default 15)| +| `argName` | Sets the argument name for this value in the form | +| `maxLength` | Sets the maximum number of characters that can be entered | +| `focus` | Set to true to capture initial focus | +| `justify` | Sets the justification of the text entry. Options: left (default), right, center | +| `fillChar` | Specifies a character to fill extra space in the text entry with. Defaults to an empty space | + +## Example + +![Example](../../assets/images/mask_edit_text_view_example1.gif "Masked Text Edit View") + +
+Configuration fragment (expand to view) +
+``` +ME1: { + maxLength: @config:users.webMax + argName: web +} +``` +
+
diff --git a/docs/art/views/predefined_label_view.md b/docs/art/views/predefined_label_view.md index 45d2d1cd..c17275f6 100644 --- a/docs/art/views/predefined_label_view.md +++ b/docs/art/views/predefined_label_view.md @@ -1,8 +1,8 @@ --- layout: page -title: Full Menu View +title: Predefined Label View --- -## Full Menu View +## Predefined Label View A predefined label view supports displaying a predefined MCI label on a screen. ## General Information @@ -18,10 +18,10 @@ A predefined label view supports displaying a predefined MCI label on a screen. | 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 | +| `justify` | Sets the justification of the MCI value text. Options: left (default), right, center | +| `fillChar` | Specifies a character to fill extra space in the view. 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 | +| `textOverflow` | If the MCI is wider than width, set overflow characters. See **Text Overflow** below | ### Text Overflow diff --git a/docs/art/views/text_view.md b/docs/art/views/text_view.md index ad2e0855..6f7f36b8 100644 --- a/docs/art/views/text_view.md +++ b/docs/art/views/text_view.md @@ -1,8 +1,8 @@ --- layout: page -title: Full Menu View +title: Text View --- -## Full Menu View +## Text View A text label view supports displaying simple text on a screen. ## General Information @@ -15,13 +15,12 @@ A text label view supports displaying simple text on a screen. | Property | Description | |-------------|--------------| -| `text` | Sets the text to display on the button | +| `text` | Sets the text to display on the label | | `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 | +| `width` | Sets the width of a view to display horizontally (default 15)| +| `justify` | Sets the justification of the text in the view. Options: left (default), right, center | +| `fillChar` | Specifies a character to fill extra space in the view with. Defaults to an empty space | +| `textOverflow` | Set overflow characters to display in case the text length is less than the width. See **Text Overflow** below | ### Text Overflow diff --git a/docs/assets/images/edit_text_view_example1.gif b/docs/assets/images/edit_text_view_example1.gif new file mode 100644 index 0000000000000000000000000000000000000000..1917d297214ff0a9cf969288000ed5b8b2f4b0d2 GIT binary patch literal 4346 zcmeH}YfzI{8plr(E(r-GG75?;4!8xRilr(zQQsht z2oz#M5D_o|qY<^-1JkZbATA+Lbx|uW;9{xR^$O^))LF-Uad)9#n6Yc^_JilsJ9Fke z=ehiU|L3d`MsfqT+9Eu_KM=kEUatTGfj}aWC=|-d%F5c>+Q!Dl*47q{Mq@A-EEbEy z;T#+s@OV6dKp>GwWHQ;w$%#UtP^nZJjkb94VrOS(7Z(>-S64STH#(ipU@+X>-B~P_ zhlhu!r>B>fm$$dKkB<+B!}0a?UAb~4m&*+Z2nY-e3=R$s2?<%fdNq&7b7xjo*6!WA_w3oTckkYu zoE(WnvVZ^ng9i^n5G0jKb8~a^^YaS|3S=^wTrNL+_;68CQE_o`Nl8g*Y3Y$8N0dsX zN~J0*D^si0<>lp-m6cUhRn^tiH8nL_t+uwdwyv&Dr_<^6`uh6%^XJbuG&D3dH8nRk zx3;#nwY3=xhK`Po3l}b2ym--QG@48%v)OF1So-?6l)trm z(0YJCI|~{$#zSZ#JHgzj?Uv!0qAEdC?d2lMiu7S~Q(aFfonPoIY(CkmVy&-F=xx^Z z9pxljs)Q}4zB$g#dNADEa{B6t&_i}EqE`K1>I5qG7E9}y>!)MtMAf3U`kQCtTGB@> zZD(&aBy|_ML>bQAZb`jfzopM`eyBZj%u*fI{^iKm+0Pz~^tCtq?Gl8-x~}bLyxT1& zE>G<5Xd3HLFr!XU@$>N7AXqTNFwbZ!0FSk|*$4nsfCDJ_C=&38sDeg1MQUT8sOf6d z^4SQ)+Z_E1M!Dco^Wo#>+lWH`_QOU4CqRO$UI6(2qzV*C3IMAwykcvgR<_wtmJ^qv zy`1OZz(`0MkGWj5XazeZ8I@v|Axf6|V*JLe{CCDB_Rnxm_2*NmtxY*ZriISm$0m7@ z+%0*YAE7^_L9(9XHr^?J%4FDFKE5&S-BI9!A7e__kZXaw(?%mhwuK zvJ%V+Eg@L8WcoI7odqhOkZE$t8orgkvQ< z-@qyR%?2-u7grc_EUMjG1^wj3vY-d-0{?|64R%BP;E1iLzSE$g$BoyukFN@6j}dl4unRw6gaFBDVguj>}0ix8=Gwa-463=i$l%iK4Ar2e*2F>uPY1sxT;B-u1@lnNi8~9R z&^R!D^~9{Wao4_Abm!x33wF(LzU!i949=WMb*!b9xR4J7kp`G%C2CDADd#htMUDPL z7l}pu@DSE%fNRP@Z2O=vR9Lj2KlpsNwS9p^X;{;S;6@IPl5^j7YA|2g#Z8m literal 0 HcmV?d00001 diff --git a/docs/assets/images/mask_edit_text_view_example1.gif b/docs/assets/images/mask_edit_text_view_example1.gif new file mode 100644 index 0000000000000000000000000000000000000000..443d2868de13424a671d70e892d89da35a8fe789 GIT binary patch literal 7117 zcmeHLXH=8vx_wiCfFJ=vH5md@BPzX@1f&;3l_t^z1e6jo2qF*y0R$uz1*M771Rbe5 z*oGh-K}3j%41$OvNLQ(vn>p*=GxOulTKC6Y>)f-h@3;RwKfZVEZ$JCl-(zlRrmf?{ zfGC0uvI<}y2n0X@fCIq60k{A_uz>))0PF>T9{@o?AOwI20HUHm3;;1PAPxW;01O65 zN&+kZSS*kRKw28?-w)&fkdp(7iU0=y4hIe#07?KHJO~aS2JBasE-v60 z0IsgU9RPQC-~qsKHjaZ60Qdsn=LZ4-2x21$gaUB-G&lo57y#knAQFJ6C_n}vnvH01 z4uEs#Ks*46Y$O5-1tbALWrGTmlR*jqsQ{#>gA4#J0+5{z=yZ?+z$E~#0B{w6A~uRZ zNeL(e;2HoG0900jY5;BmP|HRwU;!xmz@TtAoP&ddlarH+iwl83aC39>@bK{R^78TV z?cKYVpPyeyNC<^O2@4C0h=_=aii(MeNk~ZS+qVyc!CBeM3V-JRVOV5KK%=%*@OzEG(?7tZZy- zY;A3cM52R(gR`@oD5)u*;6B8*E3YAJtPEMxLXzA(c z85tQ_Sy|cH*>pNRCnqN_FYof@%LN4mSFT(sE-o%DExmT_T6uYSMMXt*b#+Zm&CQ!P zYin!o+_}@#)O7dm-CuwGwY9bN!Gi~nA3yHs=;-R|>hA9D>FMe3?;jW#7#tjY{`~py z@bJjU2$RWt`SRtfSFc{bemyxkIW;vkJ3IUS{rkDOx%v6|rKP3i<>i%?mG$-Yjg5`X z&CRW?t?ljY-QC@9-@bkS{+-2QNwN0WnL0U|5QwI#hm>Iu0D#mMoP&q05Vmpw_@hnO z68O<1KbqwKZ<8Qc0D?eU)L&yz5kff6p8E19smT3S#TE_MJ2S-8f+ueWp@7_lhWqs1Q{J`Z5BMo=Q*VCm#zCW_JoQ>rYi#zprQ|HgaNg zr8wW7U8J-xNWxSeEXsBtS}dd} zLomzF1B&7vo%WWDfBmJ)B!Po3vPTL5X`IGzEjIW_a&gp`V-cra5yrI8G&=TBBnnGW zf9sEpsy|6EN39ra!i1utRLXz$dg{^znG}HYoIp6Yzm(*XZ9lf3YnpLP4zX&=V_c;i zGbHDAM%^#Ve=zDs?45=c2{b`_b6gEwCT<9 z@-xyG6jCn8waP~bJ{J@_l;l#I%TK%MJsg|mvf*8wsaY%U6laIB_O5ZQ#aZf!RY9x_ z9$u<~0rQ7nlkmaA<#3?+P$U^Iev6PQ4CsIhbCmwd+PhA3CkH}ny(S3Hf*?T)+ z00Isc;P5{!{72zmLP-oeQu6+hC=qBNZYg0=KZW%j6U2GC@=Uj}g6gv*f$2_VJC8AK|wawVmE; zs*wRL^Y2bFUl8yUpM*bi41Q`(OMkqj=Am-w)iJ;RQsLT+MTS*G^zgU9ms9r=V)yJ_ z(`%6Qxj$oEQf8 zvq#-7y?!S9J7b==-?rX$?F7>HgkD$vwcvkYGZEidwQ1rlJ<{^oS|y#F+wA2O_3>>@8i1dPR2H5NcU-G?}$xLe~PqLc5OPg`i_tbx=4hIr;S1zJu{G*-O<0QS75wT- zkch^{?`hYK9*wAExK$zYp9Mlk11=jjXuX5n60mRS%jV7j1f(>iy=#^vRn%;HGg`=}3b{%wtHHmks$0^8UisSl z)62rn!5cY?kpYzZUeMN$pKCrlK|=;G~)*hFK_l;F61ohX*FZ zLafr{ks$omZD<5fV?(0cLY3Q~*PcZ@*)HUA%h>iQCN5=H$U=#-)G%i>eRh4e90$`4 z!z>ww)CEVTP-koE$j}@&_)DJ^qe{W3+V;ZRec~O0{Z@6IWdvUl)rUzsL*4N73A)={ z=G(8Ye^)75D^{}BL$)Zh@)pa~U$ZjTjjCm!8d$PF=?o@Je(COuBYGn0kLtK9)O#{A zRm(KbYs1M5E{~FW!k#C0$sP5v$5(qqUrK#7@+XCUz0+BHu>Jy~_uDNR`S8yh{m+&R zNCR42xJ@HNk$7zrQzI`wf3nS)A=TFJjy>ZrlAT6-zK`t<{3iF2?T)5WJK}uZy-8ws zV7FJOarfSQ8`YNLiBF5q=i}vqeA=vM!?7K6P6U5fMuJ#iuyg;^ zhpHeEpSX|I##JvwSx}}-z(+L!)w1VKoA-6&Y<_}nz3vfIRgzUXMf)s-NHso!lv%S# zs1xhqU%>OkTUhKH4stf}m63`>KqIAc&8zxqWOl;s-Jq}F2Ko7&*BS<}8N}4&F-Dp$ z(ZslEYckAuB(s0lM2S3Wo~)oDZ_Sqa(J>bD>2pEE?X+eJ3yIBg>I0xF2IZK(Rt%X_co(rGm!z( zcdG3Is+zDgWL3-Fa_UhER=V(KBti{_O!M|7m2g=G5F{8+?bfD?H{Nl}9+A3W@QJQ2 zRUTATpZ5GBE!iDsY<9?CT%hSGOej6gOWv~2A-$ezz8ZAO+?^uLy=7d5^Wo6^x$i}( zZ=h^UeF`zfU9s4uLfAyO*52{@i&EV$)z(?HPUhEnLR`Ppx_&YJYt~4Hh_PoIjP1+3 zf2Lv>^#6M1`19Jrz|ChLdn6yGa0q>OIC+~L<{v}zxQxzeJuOqEI;vfIC+&HHi##C;)3iQZCPlWfL6j5}fB71;mUxbR= zps0;gh!k1(J{bj{L9~<_$*{w>OAbLbZ5z|S>G*-KjEm1H!ZEyCq{!MG*CyRvHHgym zK%I75f6u%F%O2c1Ro_mmSMAI_n09jSizM!AgST`)1iLh!T{m+&H}na8J@(#soVD^& zagFLn&iJ!_X*1nCaKm5nW+FN%D#_YE*@w5yNRgei4-uzVEhR5xDw8MO`s7Ll-G?~iPqkU)Fo-y!ZSK4qLP?_T*99X;M5ZSFb{QG`DMSEO?W zkEC)CbeIh@=o8G<8T@f>H?ADgk${hAb7syvK8dFhjJ?)8aGJPZ<}_zMw1tIRxaEwf zU;^TpzuD!$^b|7;_rq8-lAwh${)h`t@(emm5EV!uwQE$u$xb?{rEyG(G~t3u_+(o0 zT+PvQi=~@5?@9>S0uq8bEWg-~_&NOzGECjOMB@lS*P}qO`1s z_`#gpDszFPy01MPQenD;8h+FUzV4YoY(+zp_0D9G7w+&g(q`P@=?~6Bj2Pfp{GPtj z+%;NGBy$T5aK42V6)HPd>M z?~tT65r%Hilr#Ulds}FGZjy4M&;3|Op+Rb4qkWa3Sx`UPH}@`=c)4$oP+G>47TwdJ z#*FOU2K(C6?H3W24Q6KWC?v#CFc1q-mcj7Vn_uTn&fyRDhi$q7$ft-%0YakGVI4Xo zbPX~j)FaRDMmL~2VDlzs1Z6bowxyBuxX<}eUq!l`;Zz#!7EGo|vyX~s#NM2^A!6{c zuk&fw$@q#JDh0g)1?Q`io@Q35+qWySY;aC5p2~5)4u^2)bCbq-tF^g?^R{<`i^n|) x$kW3TQTIt#p=lKTS+|?fRwRz~{Az Date: Wed, 26 Jan 2022 17:27:38 -0600 Subject: [PATCH 07/12] Fixed image for edit text view --- docs/art/views/edit_text_view.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/art/views/edit_text_view.md b/docs/art/views/edit_text_view.md index e8eb779d..d8f37171 100644 --- a/docs/art/views/edit_text_view.md +++ b/docs/art/views/edit_text_view.md @@ -25,7 +25,7 @@ An edit text view supports editing form values on a screen. This can be for new ## Example -![Example](../../assets/images/edit_text_view_example1.png "Text label") +![Example](../../assets/images/edit_text_view_example1.gif "Edit Text View")
Configuration fragment (expand to view) From 823fc14154a2fd673ecde9e5fc44c6c63e2a362a Mon Sep 17 00:00:00 2001 From: Nathan Byrd Date: Fri, 28 Jan 2022 16:34:52 -0600 Subject: [PATCH 08/12] Additional fixes to docs --- docs/art/views/button_view.md | 6 +-- docs/art/views/edit_text_view.md | 5 ++- docs/art/views/full_menu_view.md | 10 ++--- docs/art/views/horizontal_menu_view.md | 10 ++--- docs/art/views/mask_edit_text_view.md | 40 ++++++++++++++---- docs/art/views/predefined_label_view.md | 4 +- docs/art/views/spinner_menu_view.md | 10 ++--- docs/art/views/text_view.md | 4 +- docs/art/views/vertical_menu_view.md | 10 ++--- .../images/mask_edit_text_view_example1.gif | Bin 7117 -> 7222 bytes 10 files changed, 62 insertions(+), 37 deletions(-) diff --git a/docs/art/views/button_view.md b/docs/art/views/button_view.md index b9b9a128..97dc97e8 100644 --- a/docs/art/views/button_view.md +++ b/docs/art/views/button_view.md @@ -9,15 +9,15 @@ A button view supports displaying a button on a screen. :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. +:information_source: See [MCI](../mci.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)| +| `textStyle` | Sets the standard (non-focus) text style. See **Text Styles** in [MCI](../mci.md) | +| `focusTextStyle` | Sets focus text style. See **Text Styles** in [MCI](../mci.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** | diff --git a/docs/art/views/edit_text_view.md b/docs/art/views/edit_text_view.md index d8f37171..c372246d 100644 --- a/docs/art/views/edit_text_view.md +++ b/docs/art/views/edit_text_view.md @@ -9,13 +9,14 @@ An edit text view supports editing form values on a screen. This can be for new :information_source: An edit text view is defined with a percent (%) and the characters ET, followed by the view number. For example: `%ET1`. This is generally used on a form in order to allow a user to enter or edit a text value. -:information_source: See [Art](../general.md) for general information on how to use views and common configuration properties available for them. +:information_source: See [MCI](../mci.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) | +| `textStyle` | Sets the standard (non-focus) text style. See **Text Styles** in [MCI](../mci.md) | +| `focusTextStyle` | Sets the focus text style. See **Text Styles** in [MCI](../mci.md) | | `width` | Sets the width of a view for the text edit (default 15)| | `argName` | Sets the argument name for this value in the form | | `maxLength` | Sets the maximum number of characters that can be entered | diff --git a/docs/art/views/full_menu_view.md b/docs/art/views/full_menu_view.md index 55f9b4cc..19ff365a 100644 --- a/docs/art/views/full_menu_view.md +++ b/docs/art/views/full_menu_view.md @@ -11,14 +11,14 @@ Items can be selected on a menu via the cursor keys, Page Up, Page Down, Home, a :information_source: A full menu view is defined with a percent (%) and the characters FM, followed by the view number. For example: `%FM1` -:information_source: See [Art](../general.md) for general information on how to use views and common configuration properties available for them. +:information_source: See [MCI](../mci.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) | -| `focusTextStyle` | Sets focus text style. See **Text Styles** in [Art](../general.md)| +| `textStyle` | Sets the standard (non-focus) text style. See **Text Styles** in [MCI](../mci.md) | +| `focusTextStyle` | Sets focus text style. See **Text Styles** in [MCI](../mci.md)| | `itemSpacing` | Used to separate items vertically in the menu | | `itemHorizSpacing` | Used to separate items horizontally in the menu | | `height` | Sets the height of views to display multiple items vertically (default 1) | @@ -29,11 +29,11 @@ Items can be selected on a menu via the cursor keys, Page Up, Page Down, Home, a | `hotKeySubmit` | Set to submit a form on hotkey selection | | `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 | -| `itemFormat` | Sets the format for a list entry. See **Entry Formatting** in [Art](../general.md) | +| `itemFormat` | Sets the format for a list entry. See **Entry Formatting** in [MCI](../mci.md) | | `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 | | `items` | List of items to show in the menu. See **Items** below. -| `focusItemFormat` | Sets the format for a focused list entry. See **Entry Formatting** in [Art](../general.md) | +| `focusItemFormat` | Sets the format for a focused list entry. See **Entry Formatting** in [MCI](../mci.md) | ### Hot Keys diff --git a/docs/art/views/horizontal_menu_view.md b/docs/art/views/horizontal_menu_view.md index d0b13144..90dc4438 100644 --- a/docs/art/views/horizontal_menu_view.md +++ b/docs/art/views/horizontal_menu_view.md @@ -11,14 +11,14 @@ Items can be selected on a menu via the cursor keys, Page Up, Page Down, Home, a :information_source: A horizontal menu view is defined with a percent (%) and the characters HM, followed by the view number (if used.) For example: `%HM1` -:information_source: See [Art](../general.md) for general information on how to use views and common configuration properties available for them. +:information_source: See [MCI](../mci.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) | -| `focusTextStyle` | Sets focus text style. See **Text Styles** in [Art](../general.md)| +| `textStyle` | Sets the standard (non-focus) text style. See **Text Styles** in [MCI](../mci.md) | +| `focusTextStyle` | Sets focus text style. See **Text Styles** in [MCI](../mci.md)| | `itemSpacing` | Used to separate items horizontally in the menu | | `width` | Sets the width of a view to display one or more columns horizontally (default 15)| | `focus` | If set to `true`, establishes initial focus | @@ -27,10 +27,10 @@ Items can be selected on a menu via the cursor keys, Page Up, Page Down, Home, a | `hotKeySubmit` | Set to submit a form on hotkey selection | | `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 | -| `itemFormat` | Sets the format for a list entry. See **Entry Formatting** in [Art](../general.md) | +| `itemFormat` | Sets the format for a list entry. See **Entry Formatting** in [MCI](../mci.md) | | `fillChar` | Specifies a character to fill extra space in the menu with. Defaults to an empty space | | `items` | List of items to show in the menu. See **Items** below. -| `focusItemFormat` | Sets the format for a focused list entry. See **Entry Formatting** in [Art](../general.md) | +| `focusItemFormat` | Sets the format for a focused list entry. See **Entry Formatting** in [MCI](../mci.md) | ### Hot Keys diff --git a/docs/art/views/mask_edit_text_view.md b/docs/art/views/mask_edit_text_view.md index da1ca06e..a03e83c5 100644 --- a/docs/art/views/mask_edit_text_view.md +++ b/docs/art/views/mask_edit_text_view.md @@ -3,26 +3,49 @@ layout: page title: Mask Edit Text View --- ## Mask Edit Text View -A mask edit text view supports editing form values on a screen. This can be for new entry as well as editing existing values defined by the module. Unlike a edit text view, the mask edit text view does not show the current value until the field is focused. +A mask edit text view supports editing form values on a screen. This can be for new entry as well as editing existing values. Unlike a edit text view, the mask edit text view uses a mask pattern to specify what format the values should be entered in. ## General Information :information_source: A mask edit text view is defined with a percent (%) and the characters ME, followed by the view number. For example: `%ME1`. This is generally used on a form in order to allow a user to enter or edit a text value. -:information_source: See [Art](../general.md) for general information on how to use views and common configuration properties available for them. +:information_source: See [MCI](../mci.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) | -| `width` | Sets the width of a view for the text edit (default 15)| +| `textStyle` | Sets the standard (non-focus) text style. See **Text Styles** in [MCI](../mci.md) | +| `focusTextStyle` | Sets the focus text style. See **Text Styles** in [MCI](../mci.md) | | `argName` | Sets the argument name for this value in the form | -| `maxLength` | Sets the maximum number of characters that can be entered | +| `maxLength` | Sets the maximum number of characters that can be entered. *Not normally useful, set the mask pattern as needed instead* | | `focus` | Set to true to capture initial focus | -| `justify` | Sets the justification of the text entry. Options: left (default), right, center | +| `maskPattern` | Sets the mask pattern. See **Mask Pattern** below | | `fillChar` | Specifies a character to fill extra space in the text entry with. Defaults to an empty space | +### Mask Pattern + +A `maskPattern` must be set on a mask edit text view (not doing so will cause the view to be focusable, but no text can be input). The `maskPattern` is a set of characters used to define input, as well as optional literal characters that can be entered into the pattern that will always be entered into the input. The following mask characters are supported: + +| Mask Character | Description | +|----------------|--------------| +| # | Numeric input, one of 0 through 9 | +| A | Alphabetic, one of a through z or A through Z | +| @ | Alphanumeric, matches one of either Numeric or Alphabetic above | +| & | Printable, matches one printable character including spaces | + +Any value other than the entries above is treated like a literal value to be displayed in the patter. Multiple pattern characters are combined for longer inputs. Some examples could include: + +| Pattern | Description | +|---------|--------------| +| `AA` | Matches up to two alphabetic characters, for example a state name (i.e. "CA") | +| `###` | Matches up to three numeric characters, for example an age (i.e. 25) | +| `###-###-####` | A pattern matching a phone number with area code | +| `##/##/####` | Matches a date of type month/day/year or day/month/year (i.e. 01/01/2000) | +| `##-AAA-####` | Matches a date of type day-month-year (i.e. 01-MAR-2010) | +| `# foot ## inches`| Matches a height in feet and inches (i.e. 6 foot 2 inches) | + + ## Example ![Example](../../assets/images/mask_edit_text_view_example1.gif "Masked Text Edit View") @@ -32,8 +55,9 @@ A mask edit text view supports editing form values on a screen. This can be for
``` ME1: { - maxLength: @config:users.webMax - argName: web + argName: height + fillChar: "#" + maskPattern: "# ft. ## in." } ```
diff --git a/docs/art/views/predefined_label_view.md b/docs/art/views/predefined_label_view.md index c17275f6..cae23f55 100644 --- a/docs/art/views/predefined_label_view.md +++ b/docs/art/views/predefined_label_view.md @@ -11,13 +11,13 @@ A predefined label view supports displaying a predefined MCI label on a screen. :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. +:information_source: See [MCI](../mci.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) | +| `textStyle` | Sets the standard (non-focus) text style. See **Text Styles** in [MCI](../mci.md) | | `justify` | Sets the justification of the MCI value text. Options: left (default), right, center | | `fillChar` | Specifies a character to fill extra space in the view. Defaults to an empty space | | `width` | Specifies the width that the value should be displayed in (default 3) | diff --git a/docs/art/views/spinner_menu_view.md b/docs/art/views/spinner_menu_view.md index 42c88e14..0f7139f8 100644 --- a/docs/art/views/spinner_menu_view.md +++ b/docs/art/views/spinner_menu_view.md @@ -11,14 +11,14 @@ Items can be selected on a menu via the cursor keys or by selecting them via a ` :information_source: A spinner menu view is defined with a percent (%) and the characters SM, followed by the view number (if used.) For example: `%SM1` -:information_source: See [Art](../general.md) for general information on how to use views and common configuration properties available for them. +:information_source: See [MCI](../mci.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) | -| `focusTextStyle` | Sets focus text style. See **Text Styles** in [Art](../general.md)| +| `textStyle` | Sets the standard (non-focus) text style. See **Text Styles** in [MCI](../mci.md) | +| `focusTextStyle` | Sets focus text style. See **Text Styles** in [MCI](../mci.md)| | `focus` | If set to `true`, establishes initial focus | | `width` | Sets the width of a view on the display (default 15)| | `submit` | If set to `true` any `accept` action upon this view will submit the encompassing **form** | @@ -26,10 +26,10 @@ Items can be selected on a menu via the cursor keys or by selecting them via a ` | `hotKeySubmit` | Set to submit a form on hotkey selection | | `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 | -| `itemFormat` | Sets the format for a list entry. See **Entry Formatting** in [Art](../general.md) | +| `itemFormat` | Sets the format for a list entry. See **Entry Formatting** in [MCI](../mci.md) | | `fillChar` | Specifies a character to fill extra space in the menu with. Defaults to an empty space | | `items` | List of items to show in the menu. See **Items** below. -| `focusItemFormat` | Sets the format for a focused list entry. See **Entry Formatting** in [Art](../general.md) | +| `focusItemFormat` | Sets the format for a focused list entry. See **Entry Formatting** in [MCI](../mci.md) | ### Hot Keys diff --git a/docs/art/views/text_view.md b/docs/art/views/text_view.md index 6f7f36b8..3bec8ed8 100644 --- a/docs/art/views/text_view.md +++ b/docs/art/views/text_view.md @@ -9,14 +9,14 @@ A text label view supports displaying simple text on a screen. :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. +:information_source: See [MCI](../mci.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 label | -| `textStyle` | Sets the standard (non-focus) text style. See **Text Styles** in [Art](../general.md) | +| `textStyle` | Sets the standard (non-focus) text style. See **Text Styles** in [MCI](../mci.md) | | `width` | Sets the width of a view to display horizontally (default 15)| | `justify` | Sets the justification of the text in the view. Options: left (default), right, center | | `fillChar` | Specifies a character to fill extra space in the view with. Defaults to an empty space | diff --git a/docs/art/views/vertical_menu_view.md b/docs/art/views/vertical_menu_view.md index 61654746..e46f92ae 100644 --- a/docs/art/views/vertical_menu_view.md +++ b/docs/art/views/vertical_menu_view.md @@ -11,14 +11,14 @@ Items can be selected on a menu via the cursor keys, Page Up, Page Down, Home, a :information_source: A vertical menu view is defined with a percent (%) and the characters VM, followed by the view number (if used.) For example: `%VM1`. -:information_source: See [Art](../general.md) for general information on how to use views and common configuration properties available for them. +:information_source: See [MCI](../mci.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) | -| `focusTextStyle` | Sets focus text style. See **Text Styles** in [Art](../general.md)| +| `textStyle` | Sets the standard (non-focus) text style. See **Text Styles** in [MCI](../mci.md) | +| `focusTextStyle` | Sets focus text style. See **Text Styles** in [MCI](../mci.md)| | `itemSpacing` | Used to separate items vertically in the menu | | `height` | Sets the height of views to display multiple items vertically (default 1) | | `focus` | If set to `true`, establishes initial focus | @@ -27,10 +27,10 @@ Items can be selected on a menu via the cursor keys, Page Up, Page Down, Home, a | `hotKeySubmit` | Set to submit a form on hotkey selection | | `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 | -| `itemFormat` | Sets the format for a list entry. See **Entry Formatting** in [Art](../general.md) | +| `itemFormat` | Sets the format for a list entry. See **Entry Formatting** in [MCI](../mci.md) | | `fillChar` | Specifies a character to fill extra space in the menu with. Defaults to an empty space | | `items` | List of items to show in the menu. See **Items** below. -| `focusItemFormat` | Sets the format for a focused list entry. See **Entry Formatting** in [Art](../general.md) | +| `focusItemFormat` | Sets the format for a focused list entry. See **Entry Formatting** in [MCI](../mci.md) | ### Hot Keys diff --git a/docs/assets/images/mask_edit_text_view_example1.gif b/docs/assets/images/mask_edit_text_view_example1.gif index 443d2868de13424a671d70e892d89da35a8fe789..b12ba5ab2b91c785886fb6e39b249c4a425f10ab 100644 GIT binary patch literal 7222 zcmeHLcTm%5yZt33lF$q#fJg~QFA-1#tO=nc6s7lIKv0^9bY$HPO^V7=B}fZBgt8$J z5JYbjq%KHTDJ#Vl0dWxpQ7m6@XFt4uII}bN+q=%a`}-?1?_}nEp68tNob#FxjP>;0 zxj`zx8;};j`91+45C{wgb8&G&AP^`N%FWFUgTdf%I1djGFE1}2A0IzIzkqJ&U z;c$kAhDJt4#>U1bCMI}1o@`{QI8jV(2SxKkUtE;PPYHDh0YZ(kiU0ofM$*ixh zZ)j*>u~^N`%`Gi0t*x!MZr!?l`!<`+zH{f!-Me?&+S=~jyVu#-+1=gU+uPgM*Ecvg zI6OQ&GBPqYHumVzqw(?aiHV8Fj~`D@PtVNE%+1X`dGcg_etuzLVR3PBX=&;C^XD&K zymgHzka>8wzj^${^re_jg5`BZ{NOq_il4@^ZonxA3l8e`0?YX|8t-0 zC*I>mwl+AdrI9vTlMBS5gX~)flm`F->Ra5{qDjKmkAFz=4@v&Nk_5&9KTHzOpx%jv z39GtxF^bv}5PMAX@O8!aE{pH;o$RVB>HHCeOO_-sOS?0aZRoDu%(C8W%~L&jg!=Nn zT)p7M$?p1!`-PZT9x2lXTDxR+x?6HFBYiMNCiAFx;s+oGdpcs4pu+1+0hyRa zc$hg&9;QhM_u}cZTxrwY;lv_24+s1A#w62*N5*5g_z2`l zgOb6G!N5dhg>z7~mTpcu*UP~yWj!D;!9naj%{n#0syUV4D#GZJFn&j;U`C}>(|Ayy zkw`WLaIEY_ah+dKNDYhE_Y7-R$$V01CNWlu?tsVT1=SGtD;3#=#aCc1yoeN{_@YaR z*Fyr@%QFHD;PaWOJf8EV31L1yguQ$RAtG*5pV(k(%d-xjN{Pro+=UkQ`B(?{Nr1dV z_h(8czsh3zB}NcE(zk$E*|Lbw5%;M|SlsW6Xo%Nuj4Cg`_M zG93cm{z^Gh`}S#G_=~sm)CBaqXQkNz?-pnkweJ?In_j$IVsr*XV!qfcJ3z{u1;bf3 zFbKf$T-z(>Z#_@|Bmn^c%DI&cu$G3A~ zIN%D1b1pmwthq|y8K_*~OMx<^5VFy(joQ8qq29$?0)?&?C-adrl#Mt7Wi3m{P(IO^ zM+lznrD*#tPUfsA_U9drWy-^q;s#4F@v2aQP|>|OlWV3>efi|ksz^jXQ=3)QUML8I z4wQ9OIVBte4eWARuXc&^8D(DFJn+J~C1hs5Z-e|(XJ*9x^y<*LQX!XMuH4bg6_vY$ zu!p+QIdnpwiA95beMRQYemv`io_VxD*hr*ouTGo73%TEAqb3@YV11=vZkYD)6?5D&tIA0xNUT zb5VqDTW*nbbQGzhJXQdVG=N(&RR;?_D?Iq8>lOQ1PNCha*7bnmPv-oHac@6UvV*KX zo1d**+HZ4ihR%mjO2MEmbDI^IKPryqrtI_Us3!aHVYk3ubMMu&;TTii4_BNU7W2U# zy#+@O{TX1AIi;WYT>2EJbV+f{P??!N><=R%1Ez?x(`qjhzG3af%a89B*3`vk*`N&HvKY-seaZ}XV!+; z@Wh*?u#%QXC&AtNRIC+y8QxsxrIf~+ah6}kj+KRLs*^WNmk!)IWQ8W)ih2M(elyJc z5i>Trc3Ds~hf}(f?BiY=HEzTTwSNA7f!3?h!>Q5KVVX^$fc!hOPjtCm@98P$ zm8FMFo8j7gr+V^Zb}ZLU*tgEnuR{K-2iueT?epXSG8TaRVIc+JBFdJ59v~26%R-*d zKody-dlt{JkkQiE`kP<=|E=#j*g4{LDG9y*l>cj?#%=*{^MEc=1K2lG{ zKm~%o9Kyw-8&}GB@tDU9&>uuwLw)(#YgJCsHuvdB+Ke&n$H)M2{?w-(<8-s5iyxFz zf19e<<=Z+MU(w;ZU+1H}Mb*RSBUzp|4+!um9?z2k#$o=lk<9t~R2=XA6>7u6a2YaD zF@nMJi`9a37g)G7UK=HyTuLF{d~)78K89WWnXcG7z&2pRS zL!7QbFbov%nd&eqxedfG#p8$+K=2;l<%B_LPe zD8%nhVEOanvm}wfj4IM1j#N1Sgya>^{2W!_AQX&hCI%5w2#w}M6|b%|g%jl=oTy@$ zCT~%!?!$>HoFMS4Elbr)_1LkDA@$cPN;FHABYjq;p$h%6N`hco&uB?krnXYRvZ<&X zm~n{9U%fYM<`Ko`L1X@Au}P1tWyCKet)_Eia}};Ur*cAaOXm zgcAsbwFea}Ey3vuHa&T}w1j&xqNI*eP9VhOg1Vl`FVxe_seuN{#DhaLn+y!p-Z0`x zrCo~Elwnf3$+WtfLz@BQV8xv-SRDA7wS1!nj%q*{vg#eHnJQGDOUb*rUVAe70_f)t zQDSKG+oA9TsPj?>USZd!s%RB_#x^=bar3IM$>%PMNts@#c$UB|O>^sWUh5q?c*0~v zme#mD!K!4ZXl%-!on(jprZ_$^b8fmRey1+cwTL`FP-60@l=&}O`(GW#|Hi>~P5+p( zzb&u*M~ASzT4)>!i%@t~%j*nG2TsPSjegGpG2flxe*gNJi(j>rtm}1uS!WA0$xC7DN^wY`P&a1{# zn@xeFJDPB@^(gT=6Hw|NvlL0h_QKe96K^<|=U8Br*cbYP6qqhG6GOWoLp1~uTMtrF z8mJ*8DJvbg0$J1sb9`W`nQFf;7zF@_K&rPVyEEL)iPgXeges@hU4W1L$fue~8!WXX zqKPZU4#~v_OMI7ah?p2xn=~b#eYmzXT<49vRs%aw;}UHKitx#zE>AR^&mF(Dbggor z_`9i(4R+;~W%bcbqBPv9eKtU|y^g;UmTH<$kFYd$*@wxy4@wF7#k_^%CZu!eZW1&) z1n)clPL0A}rbY;YRKzBK^RE`$x0eB+Tfq^9-4P?C>Ppc>7+gX~8C(&^Y`t3S{bpV* OzAD_?m3(`1IP@>56y!+& literal 7117 zcmeHLXH=8vx_wiCfFJ=vH5md@BPzX@1f&;3l_t^z1e6jo2qF*y0R$uz1*M771Rbe5 z*oGh-K}3j%41$OvNLQ(vn>p*=GxOulTKC6Y>)f-h@3;RwKfZVEZ$JCl-(zlRrmf?{ zfGC0uvI<}y2n0X@fCIq60k{A_uz>))0PF>T9{@o?AOwI20HUHm3;;1PAPxW;01O65 zN&+kZSS*kRKw28?-w)&fkdp(7iU0=y4hIe#07?KHJO~aS2JBasE-v60 z0IsgU9RPQC-~qsKHjaZ60Qdsn=LZ4-2x21$gaUB-G&lo57y#knAQFJ6C_n}vnvH01 z4uEs#Ks*46Y$O5-1tbALWrGTmlR*jqsQ{#>gA4#J0+5{z=yZ?+z$E~#0B{w6A~uRZ zNeL(e;2HoG0900jY5;BmP|HRwU;!xmz@TtAoP&ddlarH+iwl83aC39>@bK{R^78TV z?cKYVpPyeyNC<^O2@4C0h=_=aii(MeNk~ZS+qVyc!CBeM3V-JRVOV5KK%=%*@OzEG(?7tZZy- zY;A3cM52R(gR`@oD5)u*;6B8*E3YAJtPEMxLXzA(c z85tQ_Sy|cH*>pNRCnqN_FYof@%LN4mSFT(sE-o%DExmT_T6uYSMMXt*b#+Zm&CQ!P zYin!o+_}@#)O7dm-CuwGwY9bN!Gi~nA3yHs=;-R|>hA9D>FMe3?;jW#7#tjY{`~py z@bJjU2$RWt`SRtfSFc{bemyxkIW;vkJ3IUS{rkDOx%v6|rKP3i<>i%?mG$-Yjg5`X z&CRW?t?ljY-QC@9-@bkS{+-2QNwN0WnL0U|5QwI#hm>Iu0D#mMoP&q05Vmpw_@hnO z68O<1KbqwKZ<8Qc0D?eU)L&yz5kff6p8E19smT3S#TE_MJ2S-8f+ueWp@7_lhWqs1Q{J`Z5BMo=Q*VCm#zCW_JoQ>rYi#zprQ|HgaNg zr8wW7U8J-xNWxSeEXsBtS}dd} zLomzF1B&7vo%WWDfBmJ)B!Po3vPTL5X`IGzEjIW_a&gp`V-cra5yrI8G&=TBBnnGW zf9sEpsy|6EN39ra!i1utRLXz$dg{^znG}HYoIp6Yzm(*XZ9lf3YnpLP4zX&=V_c;i zGbHDAM%^#Ve=zDs?45=c2{b`_b6gEwCT<9 z@-xyG6jCn8waP~bJ{J@_l;l#I%TK%MJsg|mvf*8wsaY%U6laIB_O5ZQ#aZf!RY9x_ z9$u<~0rQ7nlkmaA<#3?+P$U^Iev6PQ4CsIhbCmwd+PhA3CkH}ny(S3Hf*?T)+ z00Isc;P5{!{72zmLP-oeQu6+hC=qBNZYg0=KZW%j6U2GC@=Uj}g6gv*f$2_VJC8AK|wawVmE; zs*wRL^Y2bFUl8yUpM*bi41Q`(OMkqj=Am-w)iJ;RQsLT+MTS*G^zgU9ms9r=V)yJ_ z(`%6Qxj$oEQf8 zvq#-7y?!S9J7b==-?rX$?F7>HgkD$vwcvkYGZEidwQ1rlJ<{^oS|y#F+wA2O_3>>@8i1dPR2H5NcU-G?}$xLe~PqLc5OPg`i_tbx=4hIr;S1zJu{G*-O<0QS75wT- zkch^{?`hYK9*wAExK$zYp9Mlk11=jjXuX5n60mRS%jV7j1f(>iy=#^vRn%;HGg`=}3b{%wtHHmks$0^8UisSl z)62rn!5cY?kpYzZUeMN$pKCrlK|=;G~)*hFK_l;F61ohX*FZ zLafr{ks$omZD<5fV?(0cLY3Q~*PcZ@*)HUA%h>iQCN5=H$U=#-)G%i>eRh4e90$`4 z!z>ww)CEVTP-koE$j}@&_)DJ^qe{W3+V;ZRec~O0{Z@6IWdvUl)rUzsL*4N73A)={ z=G(8Ye^)75D^{}BL$)Zh@)pa~U$ZjTjjCm!8d$PF=?o@Je(COuBYGn0kLtK9)O#{A zRm(KbYs1M5E{~FW!k#C0$sP5v$5(qqUrK#7@+XCUz0+BHu>Jy~_uDNR`S8yh{m+&R zNCR42xJ@HNk$7zrQzI`wf3nS)A=TFJjy>ZrlAT6-zK`t<{3iF2?T)5WJK}uZy-8ws zV7FJOarfSQ8`YNLiBF5q=i}vqeA=vM!?7K6P6U5fMuJ#iuyg;^ zhpHeEpSX|I##JvwSx}}-z(+L!)w1VKoA-6&Y<_}nz3vfIRgzUXMf)s-NHso!lv%S# zs1xhqU%>OkTUhKH4stf}m63`>KqIAc&8zxqWOl;s-Jq}F2Ko7&*BS<}8N}4&F-Dp$ z(ZslEYckAuB(s0lM2S3Wo~)oDZ_Sqa(J>bD>2pEE?X+eJ3yIBg>I0xF2IZK(Rt%X_co(rGm!z( zcdG3Is+zDgWL3-Fa_UhER=V(KBti{_O!M|7m2g=G5F{8+?bfD?H{Nl}9+A3W@QJQ2 zRUTATpZ5GBE!iDsY<9?CT%hSGOej6gOWv~2A-$ezz8ZAO+?^uLy=7d5^Wo6^x$i}( zZ=h^UeF`zfU9s4uLfAyO*52{@i&EV$)z(?HPUhEnLR`Ppx_&YJYt~4Hh_PoIjP1+3 zf2Lv>^#6M1`19Jrz|ChLdn6yGa0q>OIC+~L<{v}zxQxzeJuOqEI;vfIC+&HHi##C;)3iQZCPlWfL6j5}fB71;mUxbR= zps0;gh!k1(J{bj{L9~<_$*{w>OAbLbZ5z|S>G*-KjEm1H!ZEyCq{!MG*CyRvHHgym zK%I75f6u%F%O2c1Ro_mmSMAI_n09jSizM!AgST`)1iLh!T{m+&H}na8J@(#soVD^& zagFLn&iJ!_X*1nCaKm5nW+FN%D#_YE*@w5yNRgei4-uzVEhR5xDw8MO`s7Ll-G?~iPqkU)Fo-y!ZSK4qLP?_T*99X;M5ZSFb{QG`DMSEO?W zkEC)CbeIh@=o8G<8T@f>H?ADgk${hAb7syvK8dFhjJ?)8aGJPZ<}_zMw1tIRxaEwf zU;^TpzuD!$^b|7;_rq8-lAwh${)h`t@(emm5EV!uwQE$u$xb?{rEyG(G~t3u_+(o0 zT+PvQi=~@5?@9>S0uq8bEWg-~_&NOzGECjOMB@lS*P}qO`1s z_`#gpDszFPy01MPQenD;8h+FUzV4YoY(+zp_0D9G7w+&g(q`P@=?~6Bj2Pfp{GPtj z+%;NGBy$T5aK42V6)HPd>M z?~tT65r%Hilr#Ulds}FGZjy4M&;3|Op+Rb4qkWa3Sx`UPH}@`=c)4$oP+G>47TwdJ z#*FOU2K(C6?H3W24Q6KWC?v#CFc1q-mcj7Vn_uTn&fyRDhi$q7$ft-%0YakGVI4Xo zbPX~j)FaRDMmL~2VDlzs1Z6bowxyBuxX<}eUq!l`;Zz#!7EGo|vyX~s#NM2^A!6{c zuk&fw$@q#JDh0g)1?Q`io@Q35+qWySY;aC5p2~5)4u^2)bCbq-tF^g?^R{<`i^n|) x$kW3TQTIt#p=lKTS+|?fRwRz~{Az Date: Fri, 28 Jan 2022 17:53:20 -0600 Subject: [PATCH 09/12] Added MT and TM --- docs/art/views/multi_line_edit_text_view.md | 53 +++++++++++ docs/art/views/toggle_menu_view.md | 83 ++++++++++++++++++ .../multi_line_edit_text_view_example1.gif | Bin 0 -> 13256 bytes 3 files changed, 136 insertions(+) create mode 100644 docs/art/views/multi_line_edit_text_view.md create mode 100644 docs/art/views/toggle_menu_view.md create mode 100644 docs/assets/images/multi_line_edit_text_view_example1.gif diff --git a/docs/art/views/multi_line_edit_text_view.md b/docs/art/views/multi_line_edit_text_view.md new file mode 100644 index 00000000..870360ba --- /dev/null +++ b/docs/art/views/multi_line_edit_text_view.md @@ -0,0 +1,53 @@ +--- +layout: page +title: Multi Line Edit Text View +--- +## Multi Line Edit Text View +A text display / editor designed to edit or display a message. + +## General Information + +:information_source: A multi line edit text view is defined with a percent (%) and the characters MT, followed by the view number. For example: `%MT1` + +:information_source: See [MCI](../mci.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 - only useful for read-only and preview, otherwise use a specific module | +| `width` | Sets the width of a view to display horizontally (default 15) | +| `height` | Sets the height of a view to display vertically | +| `argName` | Sets the argument name for the form | +| `mode` | One of edit, preview, or read-only. See **Mode** below | + +### Mode + +The mode of a multi line edit text view controls how the view behaves. The following modes are allowed: + +| Mode | Description | +|-------------|--------------| +| edit | edit the contents of the view | +| preview | preview the text, including scrolling | +| read-only | No scrolling or editing the view | + +:information_source: If `mode` is not set, the default mode is "edit" + +:information_source: With mode preview, scrolling the contents is allowed, but is not with read-only. + +## Example + +![Example](../../assets/images/multi_line_edit_text_view_example1.gif "Multi Line Edit Text View") + +
+Configuration fragment (expand to view) +
+``` +ML1: { + width: 79 + argName: message + mode: edit +} +``` +
+
diff --git a/docs/art/views/toggle_menu_view.md b/docs/art/views/toggle_menu_view.md new file mode 100644 index 00000000..65c1eabd --- /dev/null +++ b/docs/art/views/toggle_menu_view.md @@ -0,0 +1,83 @@ +--- +layout: page +title: Toggle Menu View +--- +## Toggle Menu View +A toggle menu view supports displaying a list of options on a screen horizontally (side to side, in a single row) similar to a [Horizontal Menu](horizontal_menu_view.md). It is designed to present one of two choices easily. + +## General Information + +Items can be selected on a menu via the left and right cursor keys, or by selecting them via a `hotKey` - see ***Hot Keys*** below. + +:information_source: A toggle menu view is defined with a percent (%) and the characters TM, followed by the view number (if used.) For example: `%TM1` + +:information_source: See [MCI](../mci.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 [MCI](../mci.md) | +| `focusTextStyle` | Sets focus text style. See **Text Styles** in [MCI](../mci.md)| +| `focus` | If set to `true`, establishes initial focus | +| `submit` | If set to `true` any `accept` action upon this view will submit the encompassing **form** | +| `hotKeys` | Sets hot keys to activate specific items. See **Hot Keys** below | +| `hotKeySubmit` | Set to submit a form on hotkey selection | +| `argName` | Sets the argument name for this selection in the form | +| `items` | List of items to show in the menu. Must include exactly two (2) items. See **Items** below. | + + +### Hot Keys + +A set of `hotKeys` are used to allow the user to press a character on the keyboard to select that item, and optionally submit the form. + +Example: + +``` +hotKeys: { A: 0, B: 1, Q: 1 } +hotKeySubmit: true +``` +This would select and submit the first item if `A` is typed, second if `B`, etc. + +### Items + +A toggle menu, similar to other menus, take a list of items to display in the menu. Unlike other menus, however, there must be exactly two items in a toggle menu. For example: + + +``` +items: [ + { + text: First Item + data: first + } + { + text: Second Item + data: second + } +] +``` + +If the list is for display only (there is no form action associated with it) you can omit the data element, and include the items as a simple list: + +``` +["First item", "Second item"] +``` + +## Example + +![Example](../../assets/images/toggle_menu_view_example1.gif "Toggle menu") + +
+Configuration fragment (expand to view) +
+``` +TM2: { + focus: true + submit: true + argName: navSelect + focusTextStyle: upper + items: [ "yes", "no" ] +} +``` +
+
diff --git a/docs/assets/images/multi_line_edit_text_view_example1.gif b/docs/assets/images/multi_line_edit_text_view_example1.gif new file mode 100644 index 0000000000000000000000000000000000000000..acba094d96e0818938277fb1824b367dff3ef899 GIT binary patch literal 13256 zcmeHtXH=8vx^@TwlF&jDLa34uAcP`aR6sgO0O=hS5RoEElL15|)X+Ny1Pnbi301Mo zP?e@4U_nIz%P4kGM@MIS-o)7qGvCMhX0LVj{(hYE{$j0{B=`N??Ygh)v8GrVZ1+3H ztHSdOL<+;E|BwD6L5C}0bF(eX+LZQ%Tw79r927{51kicTGl9G~AQc}{=(lRnKva+&r za&lX?Y>}6j$Kh~zJYGRTfj}TADk>@|DJd%}6Ny9;iKMEks-~uwOr}sMR4UcR#>Upx*3Qmu_wL>H_Vx}A4vvnFPEJnF zCJ<+5XBQV2S65dzH#c{8cMlH_Pft%TFE4LzZyz6@J$v@--MiP<*VoU_&)?sF|Ni{} z0RaaN90&{yJb3V6P*6~CaBxUSNN8y2p+kql!om(8K78cJk?`>Fh=_>D$jGRusOaeE zqeqX%#KipY!w<2sv2k&6@$vD;jvY%#NH~7{cw%DWi4!N1l9FgNT5@u7N=iy%)Y6ciK|78Vs16&Dwm zl$4Z~mX?*3ojiGx!C;h^m!CRys4AO&0TZAAlr)$EMUi~Q*fql$2nA{-xwCdO8>T!yipl*__oF>5ExgS(rTA@$e^K z0Suq*Irh>p9d%)}^<3wpD+LNRW#h43PbL{Up=CaC-9KMvnrAEBi|ctl%W`hL>>1zt z;x>E#NxxEuu zOoCvbB}x2Bti@#7=*VIU!pZ=ZjC2cHN)vRXFQv;Ev-~pT(?31Tz?TL2ClIPx%UMee zW6Rl^yMOl2(Y@tyKS%#5>rt4&>t~Phn?FDw7g!wr2vx}PaeQ24`!pt?$j(ZoA=I9< z{Yj}uvfF_&pP0{k!}g}DDEXV^1wSo!FU@>faY&;f@KpHa=d-6GZv`vcML%f%xmx+j z_|K=4_6h_tQ!(%bX1Y?#GZ(tX%CkC!&#>q9NmT0dh9A7Lo;QYvOgwKo7!O}z?aiXD zG`m-1t+d#-Osuq;oc{)Y(YAep`l4O)Zq|!4$}1BuI^=(azhq0mZC-XFq_SUj!AO%Y zyFohyU-f*Z*u3gp^~`?N_ab=m)!F4Z!Pn;&^r)}i+qhwQD}lr`E0qpBH*RUGUlV z{S8~m-1jrqDp%jn?%FQ=VJ>6B_QTB#O74eS8o^gT+%|^^f4mbIXZLYlzC8EiUFqhl zAMauMg@3s(Hg5OJg3x^KFAoHsf4ln2gT!yge^^YuZWp_BWJ}(syIETkV;<$@3&%a) zXTSUNt+IWIN1s;MUyb|O{)EV{Gqw4N(a#%2bK_TbbzJ-P+L@mcqh5Ahw>|c1>%+V+ z6X)L~M!xwmUnt@27E$}JmoINQ5wSX9Kb5d1x=Zx8p&9!V;U8{^<{ba{?eO*AetdA^ z#F0?(P_Q;{^^G~xPVN9mc8Eo%EcfAX9`p6I*yvmtEwwi{}RpXrq#^B|L@Hsn`iRbyrAURMOwhx*C?qKJ@^NGZ^+9iYP** zJvICpKHI!oqN}?~D?!;Xn0P(z0lWI+9L{)ces%cxDvJJ(uRkMrNe&8L?aUHGqS@Bw z>9mlp8j)873kCQ@rc-nY<`PRqr{#uAWKUh&S0Z_z%1q%zSG`iZBGox-va~Duq{i{) zt@}x{zB4_IBNtV6=Qqz*k-D3V!;~CS;8$yqM=Pw1TJ(xr<_>B1Hs4Pmx%{MZvpK7~ z#Z6t=tvl;ld*sooy}z~W946h0E$VH1Z>Z|^rukOyN_YF=SIRz*;M4sxN0~8~T1^G& z+br^||(qE4L|)poO>A8$K?SM^+Q=Yw6tG_cus$DT4wE5kmLR~KK?!XI1|_>dt&)YnC>w;!h$I&) z<45z^&*Y=&DMZwUoJ7ul{7LP9?UavDQ#T+>A z2o`O&FHCglN3T#wzJpR0VExgn-9b0N9+Q3Q-e>?9{SxFOLI|m6c7wbkXLabD)0jFVZBAEdDvp9CC?DcBiXPt0tF8SfQ;N}!vw6@ z<0083w?bV?gyLkHxXq8Y*r-7BllpwOrkYU)uT|+wkU<{`vQjJY*2Ytr$yu{ahIQ0E zP$mFm+-#V4CVF4E@p%lpDK_-HB#ZbD7wLIp!tS<)&Q}XV|A>hykn_?YB#<}tAXrI~ zC0l-w4}t^$RzZ?raw&*1XW@XNr(;n?_*e^EjveGizz8%&UQrlsKgAI9CtOBBoR3FR zbo}xttL(qsQU;?`|LQ9pr~eG#b%T)!$!zouL6b&T2#WN<;oL1mVsU$ltXJ?2gxZRHxQ!veyR{0US!EMX+ zaHMm?q3lA`=7xhUs^)QMJshC~$}%?`e&54^OtRWM9HM0Cdxty-ufAno0(7X6pX5+S zU8MB3n1KLXc@+*$yWQb?$?Ogl^MctBWW7SP`FO~yCv-mK=oh!Jzf&bn>!GRx!8AFc zGUfjss)0;5wjoaiF>_HBEv%y?V=*|_fp$=pLZ3h)VHLAg-&*8`igR9*kh2%R~>At5MAg{5yEP+F2 zq@dYay~)0IPY@^P@A0H9T!?)|WlTzFRCgx%i9MhE<%n-e3T#p@fgxY`w;JZYzlLy; zpBqAQ4G_Y^+z{3lZw%oM*oF`uT0f3r5DdXNjtX8dP*LX)1?DCl&=|)7cC97Y6CQXj z_FcYpzSMTNR2Md(Ef+6-9v3@7A1F{kok{Ig#!WFGfwvMU2*ur1`p1^hL6=J{VD0cS zx@HMTsyLn~_I|DeRNCqet2}qUzU6j@IS*adCgu=78dwc1Lu=Z+I|FPd(i)z$1Bl+{ zR<8}_$lheHjg=qwe|X8q^^(Ey62kQoU%t`HqK#hu>yu#9Po%FOSRtr)Knf}d<4x9v z5`kR`$3ufCh*U1IYt86L1+O+}#H^4BJJ9$3Gej)`e8g95z_cL1yqM_PCG)HZH&vqQ zee0sZTf((+(htTjC3TeTYBaCrXiG&aPog>qUIwsc^^<*IpWBuK8-Pi2ewMV4d++%z#n z%HtsTrAAYg7R1m@6tu=M#fC+0Fq0piYx3w0fa&CMzWzQW+QaRI?Fr> zqhuk^h*Db^D@YU%^u6>D^PP=3 zuGOWkMh=8=leC3`%Z339^%Jn2%O+5Y zw%7f!!u={4=$)jIC}=%7Q^}rG3AK4LQKBKxm6I8+WJl9K@-#=qkB(T1D-Y zU5b>RM07XLrh;mzRisj$EMV#1t7zIAI)}6vPM&+*tLo9|H(pj1k9l=xV_IJMYZWuW z+$#2{1*%x)dlfhTsfytndex@Em|J%>8E_SiZt*1waGDq}e&y`gc;g^)=Tb7At>ku} z__o#}PsS(^((hPrRfN&1w&P_# z5zHEbofUT0Q5(L)0#ObuP<3zfZM8C?Vji`!eXo=$9>ctH?G3%UF_)JBvqZRP(wk!z zwnaXj1{E0cV&VLT(%4cvWEl0eDVbPhkz}k`9o7V)=r2@W2pZ2(w$@fFkMy_6*eYOL z0P3`WUaxH$NN_-k%SzwH5Xa=Rn9m)}SUnjPBF>ZX3LFNk-; z*6|gvN{Wk(@NjeVK$sCC|Kd?@mSn+3swvBet>=RN`Zu6 z@&_@Y@`@O?Z%sRD-9MK zxmO60-Yc7%Ff=7`R9}}tAtYfMHV#REk`!>P=V*4+fvK-{PtzpbKoCC)0ybO_Ry*{cqd?yiPjP6 z!8+Di=V6UVhDido;{|v=V=}MUbbU5}9cTvWpfLvcHRs$H5IfN15!5`XFUuCmRDd|G& z+Oj&W7N8Z6i$9Z1I9W12Oy7=>JB01rKbpO!ACtf^-w<@ob@RFC)q&_jBy!Pf0aDGw zV;#L7Cr~1}=r!{@dX-Fa*c`ozliBazW~YKV==I#dQz(F5<^Djg)bHq38$hqEjR1PB z_?OYE(Ynofz>&+`Imp@A#Qc-eh&ARJ%9>gUxsiBh`E&{Kaf6<45i9T+>vw{g%}My0oxpGCJoS*xz$Fg>-`iU`29 zw2*~(L=u3wf66j3?Q8Sw5*cdw01s~Q_Skx>CG3k^fKR{g^IM~z@bZ7molVn)x?W_z z?;7&ocMT{9!lir%s(Blm|H{T)!+qUz2IyU?6c)});{XF6tTL)CLkdH!jD3r1qoZ~3 zJ#@$YR(W!IUI~m0Q(A$bwO4eqQ;nteezm~hezDqQ4a}8k0%$d6}nSemKIaHWu z%Y~JrSq^l8QscA(W?-@G#1vu<5MOM`@O#Z|LHhsD( zRN@W!(y`f(AHEcjH>6g;dhM6~zGMu-zb_e}Oecss5BM=_F$>rSmvKaxrI|@4myKXJ4*xy^Sti;v4ANIS6hOuDJ3b%&3i@1#nU6`u?L`IcU+M2F|4W3WHr z|A=)T zw`)I5PGuH*X#Snmgto5D-6^_`@(6#jlNWVqt){Vr*VL0pWtuk9n%xk@QY|w_8r$rh z!5!MnP^~`8VgByh)H{l{vn{TIOyF1#>o6HMXJ7jWhOhN0ru1x8Q;%O;{cs8yzIZkT zCOU`QfNVC+u>Zyvf1FDIFcHw?qydv;J|Nv<3w#0eB&lzR?erhY&}c3W0KWy$Df=LQ=d z-J|j7m6?r0d{ZC($f<)M7zj&d%X13=?ZI9eNJEI~mjr1p4`rdZc)8FEYcA(Pcg8?e zisZ*q6?awJ!WIL_8K^yhsVXSNsWLr4#K~myW&tA3KT5*8adIAjh+|2u4;rkqsnb8Y z0}-3lmQp6$eGrI6sax_e1awuH{yApl-Wua!BhKYRR6!)Z(YK$8P zrL2>+M!=wO#xmlGBBX1=`g4bFa-r~GHG%4c?j_=?*&4VIlm8ktPp zb-AjV+3bMUl^@KtFhe4A6$kh+L>c})Lk(ICkhrW6&Y|44-2BlbLyPy$RDaaLY-tC& zoSm00-*wh@@AraddyD6q-Ot7dOZUE<-&*x=B78SJ%Refp5(HD@5-o_|IWed`M281l z!t%`qdf<5+{W+dTFcBKh>49xVf~Pn=Frd|0)4ttnJhEooxj1sA63uF~OC}!g(v@@x zvZ@tK^Br;-Bl75+fyNZd`7zgPtDk0%e%17pJYIpktmXifW` z-hgu}0L8!|7ll85m;}hhKT`~wdXl)_Bdb8;1Ie!RBvY_Cf9;Mj_7bo&ODd)IPS;q1 z5rT4+9`F2zb09rmO5MUmPe4pRfRDp07D0e!`kJ7u*$+ zHqjeO1p)X%*ro;$^aEizdj$Jh?tu^8KHm=CcIHk$;>BG)Zzh1e6aSL}7p-B=sg{tW#xGb_k&Xg`wo+{mMwYP@p`kV5a~F3v zD9(}EJ^>}CTWI#iW8V>mv()$K2dG5hrYdyQmt|t3ng*(kX|K_wwejIPcFYiYxTpDg zlY;~pprJ^vFmzYQLdDIbn;p&+ob0g@-a8%s<9T|=`a-;V58QK8H#vJ|;XGs`8>$LY z2I7wb;(rDNi^XzCY;OGN1-xn=HJTKe57S7#bgWoWd@P|x#6c9$8_19SaDuQfdD9tx zf|ZP@7A}&4@+)xekc)|Mm~D_U74=(sw%y4TVJv2eP6kKA#jfJK;KMxh_zB+Z5_ z11%iC8=LBP7e-oE722wGOU8g$TTW9ZS{kBD8i%CYeI2P<;e1GfK}Dbo5ntOx*}8Sd z9`dq_i$|Oc7HVU{GAEtD4@C~$QXf@|#)rT{e_&!wk{Cku;mWntqT_s+w3{tg2DEIf zhYD0BEQYK~RIKrzak)QV7e^<`Ri(EBH(MmZ9#_vF4b2uMj#b-v_knMp^Yk7m?%$?{ z?~i)(u}U&F{Pu9>q+X)W52N7eI-8Sn8+z0};3!47M~T?j4SmR(8`iQz>nQ^emIxqa z79}`zpbxzn*XYjnHQLVR5dDYnLlfceYAf=$=taIf7oLB)SeinLMs7t2z80jBG6E8FJ>er&S(sA1#fMUtK{4PDiS7gh+j3{ z@&JdHvHgL#`x-HB>M-l``M+YXvobBdU!Ge`pB7}9|bN-G+W&+7-LomyO-LfO*H= zwD)i~?Ni&ry}*1()xB*78`68zkT3ynh}>5B2=Io;^~MMSe;GB+6iY)Wm_?fiVA@<5 z+Fq&RDJH!7821AsJ&qY8#o$bjLwuGs)wz)9LnF1*BDN(+*P$JJj^LuxT1Vh>^5`bB zDnrMK9%v!axeigd>;rENc4Rq~Vvc%=uQ+B??45dlol~W?fwzOaqF~_BUv0AvW$6Vdy;<<=N8|l3B>rp%f^3IVW zgT@AE4!_fnXok~Z1r|PQ;b8_hxPPwTx`nL;Uh=>> z!k#Ke*i+P)sA_%A5%$);3w!;?KIf^M0C)a|Hrjh-ed39&l1H>bXJb9xK$ar|kxSJ$Jqiqp}A=$P%wVARFuQ1T8n$$TKn7h(j5Lx0}POIb-!fhlI zD+;iA5zCkJu)C7$p%Da1wvt4aZDzQl4OqkTvhDWSfUAYubVOP{y`8lo1}F3Xw%P@d z3<4^|JrmKvm%)a0s|loD(#;mfofwX8aeJc$uh&nVBNCy{v6va(MWR+*CPySn{Q$^V zw0+uM=f*k}tPSeS@{mgrI4N6{YMBco^2tz{hUAVMm14YIs^$^oSX{BP-D%Y|+e3_% zz#?68VbP88o@O%;py20HYd9AwnnH4S^t_mE_r8?H*Xr8l4i0F*a7gNV8*TauWUdsq zVhcgmu*V2frisb#*E&y(;9>pbf z_zovGaLF_O*~HwjzA*3J;Dw1?sQXKw{-eVfpowmMxY5c@8xD-;pV+Jl1bfUGv@8p* z`If#ABEu0CZ-hJ}r-w{^WadPf Date: Fri, 28 Jan 2022 17:56:16 -0600 Subject: [PATCH 10/12] Added missing image --- docs/assets/images/toggle_menu_view_example1.gif | Bin 0 -> 3639 bytes 1 file changed, 0 insertions(+), 0 deletions(-) create mode 100644 docs/assets/images/toggle_menu_view_example1.gif diff --git a/docs/assets/images/toggle_menu_view_example1.gif b/docs/assets/images/toggle_menu_view_example1.gif new file mode 100644 index 0000000000000000000000000000000000000000..3944f658ce9ea9a512c6a9c3946205719fa47ffd GIT binary patch literal 3639 zcmeI!`8(9_8VB%u#%#74VltL*)-WM!M(d0%q#9#s2n`AeDT-3j5MzsyWIJ{VX$XlD z!^uv=5Ti}#+n!2X<&^K|T<3@L51i{dKYV+x*Kf}+&+}Z*`@Zj;_O?_DA3RDImQY53 ztQ9~3pin3@fEYqd3XuS+GK8SPNh;e18mu{W!tuG z+W~g$*g*rJ)9ID~RshxrYinBoTU*_Y6?2m}ZW z3=9GY1_%iW2?YoZ4Lu4F1`r+|9sv*$5pe?GB;w@B$jHbjfYYZ>M@L7W1vrN|cP<7X zCMG5p;5)6+9DGBN=&Gc&UQt^#Bu zva@q@bMpZ5^YaS;3JMAe0g8%>iUCSWN=gCB0LlR>5ET{I0V)xdl{WyY0BUP%Z{51Z zKYmv?%cW4+}zyK($d=6djJ0YwzjtR_I5s>-__OC)6>)2+uPUIH#j&rG&D3k zJS-3hMn*iJ3Bi!H}~q* zt2b}nynFZV{rmSHK79D}>C^oD{O8Y~zkK~NThSRd#s-FBC?pPQ-!WJTBofFE1o(GMkeB}*lHVcu`-X&obO?g79j~Y( zjb}w2`fJ)fBCE@tgvFNO70JbN@i68-Jga8RLFs9SdYmNB(J4dyNQi)rS2&xo+u}() z%85LX>g-`Ucx7A+)--djnGck)a%ER^u^i14V_7)5QSBU?eq6KuD#hj+TcF3iWPHh# z`;)^#HC@5QlDSEl-LwXsNnfTmLsnxgcI<+Uy!0PJx-6QHwpS8&6k<&0Sbkj@+(|W} zjDvBK8r|H^LW`;BiR&jF8hP!7^->q2#O>zS3)XSXtYj|DHH$+&S3gO?JVJEpPp8tF z6Y=z3Gr6Y`tHpf|Tc>W8xN-P6b2Fphl6SI81uyttx#f}g9EO#&=4<~-E3w)069)2G zKm7AE-9%N@wjGq}LLOsN#@f8g*Q+ClWQGXW(PR-^c0=)qVtsE=pYBa`fm2??qYom6 z0avA-)|3{S5>!`xQ6iMlcX6tQ<~y4;=~2@|iKDzVcFC0|i7)Ha&1Gox)1FU6AKmLA zB=pk~SjscrKrAt8T>X>7(p;;1riykU)>+giNHwfuP<~+UOE+(;277BXY*siTaBZ2eU&KCj+nF zToeW0`LH+@)~&zvB;s+%($lCy67jzc0f*8-`U27;2pAB%g#L%eeoPf|u5+sS4kcqSQ4sxRG0v8wB${mY}Uda=H7cq(9rBxIH%s zub!I2Lla_6zRFh@Qn!@pxo7C~Wm;wOJzHE}Ia-pWp5>E^dIsG5R2}#^LQQ7Lfiz>4 z<&if7+RVEi7hEYN;A05jnms^#fRpWWrMuMJGD^Ihgj*eY3D)rBO!i9CUSu^YNa!g0( z9M}(Q$Zi3RMK&{fXE%R)3$2dY%SK^%dttyq3s5$6PA@yMkmaKFH8owTT2LzNrrJS7PBlH^b5PoF=jdwao4x$7N&j^x6igu z%N`MW$I+K*YTi{Oo$F7f) z2Q6NjPXC#+kn|Pnuy3Kc_+&-eZCk4g@pxTFFC5S>pK6QY~JQYRz)TZIx-tk}soh|(UliuxF+sS3j^P{q+yE}=?bg@pk Qbot+DL Date: Fri, 28 Jan 2022 18:05:48 -0600 Subject: [PATCH 11/12] Navigation for new items --- docs/_includes/nav.md | 6 ++++++ docs/art/mci.md | 13 +++++++------ 2 files changed, 13 insertions(+), 6 deletions(-) diff --git a/docs/_includes/nav.md b/docs/_includes/nav.md index a0788ddc..af7c2e2c 100644 --- a/docs/_includes/nav.md +++ b/docs/_includes/nav.md @@ -50,9 +50,15 @@ - [Themes]({{ site.baseurl }}{% link art/themes.md %}) - [MCI Codes]({{ site.baseurl }}{% link art/mci.md %}) - Views + - [Button]({{ site.baseurl }}{% link art/views/button_view.md %}) + - [Edit Text]({{ site.baseurl }}{% link art/views/edit_text_view.md %}) - [Full Menu]({{ site.baseurl }}{% link art/views/full_menu_view.md %}) - [Horizontal Menu]({{ site.baseurl }}{% link art/views/horizontal_menu_view.md %}) + - [Mask Edit Text]({{ site.baseurl }}{% link art/views/mask_edit_text_view.md %}) + - [Predefined Label]({{ site.baseurl }}{% link art/views/predefined_label_view.md %}) - [Spinner Menu]({{ site.baseurl }}{% link art/views/spinner_menu_view.md %}) + - [Text]({{ site.baseurl }}{% link art/views/text_view.md %}) + - [Toggle Menu]({{ site.baseurl }}{% link art/views/toggle_menu_view.md %}) - [Vertical Menu]({{ site.baseurl }}{% link art/views/vertical_menu_view.md %}) - Servers diff --git a/docs/art/mci.md b/docs/art/mci.md index bdd69056..d6dc4e9d 100644 --- a/docs/art/mci.md +++ b/docs/art/mci.md @@ -116,16 +116,17 @@ a Vertical Menu (`%VM`): Old-school BBSers may recognize this as a lightbar menu | Code | Name | Description | Notes | |------|----------------------|------------------|-------| -| `TL` | Text Label | Displays text | Static content | -| `ET` | Edit Text | Collect user input | Single line entry | -| `ME` | Masked Edit Text | Collect user input using a *mask* | See **Mask Edits** below | -| `MT` | Multi Line Text Edit | Multi line edit control | Used for FSE, display of FILE_ID.DIZ, etc. | -| `BT` | Button | A button | ...it's a button | +| `TL` | Text Label | Displays text | Static content. See [Text View](views/text_view.md) | +| `ET` | Edit Text | Collect user input | Single line entry. See [Edit Text](views/edit_text_view.md) | +| `ME` | Masked Edit Text | Collect user input using a *mask* | See [Masked Edit](views/mask_edit_text_view.md) and **Mask Edits** below. | +| `MT` | Multi Line Text Edit | Multi line edit control | Used for FSE, display of FILE_ID.DIZ, etc. See [Multiline Text Edit](views/multi_line_edit_text_view.md) | +| `BT` | Button | A button | ...it's a button. See [Button](views/button_view.md) | | `VM` | Vertical Menu | A vertical menu | AKA a vertical lightbar; Useful for lists. See [Vertical Menu](views/vertical_menu_view.md) | | `HM` | Horizontal Menu | A horizontal menu | AKA a horizontal lightbar. See [Horizontal Menu](views/horizontal_menu_view.md) | | `FM` | Full Menu | A menu that can go both vertical and horizontal. | See [Full Menu](views/full_menu_view.md) | | `SM` | Spinner Menu | A spinner input control | Select *one* from multiple options. See [Spinner Menu](views/spinner_menu_view.md) | -| `TM` | Toggle Menu | A toggle menu | Commonly used for Yes/No style input | +| `TM` | Toggle Menu | A toggle menu | Commonly used for Yes/No style input. See [Toggle Menu](views/toggle_menu_view.md)| +| `PL` | Predefined Label | Show environment information | See [Predefined Label](views/predefined_label_view.md)| | `KE` | Key Entry | A *single* key input control | Think hotkeys | :information_source: Peek at [/core/mci_view_factory.js](https://github.com/NuSkooler/enigma-bbs/blob/master/core/mci_view_factory.js) to see additional information. From 7292ffe752ddb602468650b6162c0d15e57a2e1b Mon Sep 17 00:00:00 2001 From: Nathan Byrd Date: Fri, 28 Jan 2022 18:08:22 -0600 Subject: [PATCH 12/12] Fixed header --- docs/art/views/button_view.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/art/views/button_view.md b/docs/art/views/button_view.md index 97dc97e8..65a753ca 100644 --- a/docs/art/views/button_view.md +++ b/docs/art/views/button_view.md @@ -1,8 +1,8 @@ --- layout: page -title: Full Menu View +title: Button View --- -## Full Menu View +## Button View A button view supports displaying a button on a screen. ## General Information