From 5fa85eb05a0b9db2cf65fd489c26086df0ca70f1 Mon Sep 17 00:00:00 2001 From: Eric Date: Fri, 18 Jun 2021 18:00:14 +0200 Subject: [PATCH] FAF: Documentation UI Twig Blocks --- .../generated/Layout/UIContentBlock.rst.txt | 33 ++++++++++-- .../html/generated/Layout/UIContentBlock.html | 47 +++++++++++++++++- .doc/UI/build/html/objects.inv | Bin 5115 -> 5142 bytes .doc/UI/build/html/searchindex.js | 2 +- .../generated/Layout/UIContentBlock.rst | 33 ++++++++++-- 5 files changed, 102 insertions(+), 13 deletions(-) diff --git a/.doc/UI/build/html/_sources/generated/Layout/UIContentBlock.rst.txt b/.doc/UI/build/html/_sources/generated/Layout/UIContentBlock.rst.txt index 018c15add..64fa91c98 100644 --- a/.doc/UI/build/html/_sources/generated/Layout/UIContentBlock.rst.txt +++ b/.doc/UI/build/html/_sources/generated/Layout/UIContentBlock.rst.txt @@ -30,11 +30,13 @@ Twig Tag :Type: -+------------------------------------------+-------------------------------------------------------------------+ -| :ref:`Standard ` | No comment | -+------------------------------------------+-------------------------------------------------------------------+ -| :ref:`ForCode ` | Used to display a block of code like 
 but allows line break. |
-+------------------------------------------+-------------------------------------------------------------------+
++--------------------------------------------------------+-------------------------------------------------------------------+
+| :ref:`Standard `               | No comment                                                        |
++--------------------------------------------------------+-------------------------------------------------------------------+
+| :ref:`ForCode `                 | Used to display a block of code like 
 but allows line break. |
++--------------------------------------------------------+-------------------------------------------------------------------+
+| :ref:`ForPreformatted ` | No comment                                                        |
++--------------------------------------------------------+-------------------------------------------------------------------+
 
 .. _UIContentBlockStandard:
 
@@ -78,6 +80,27 @@ UIContentBlock ForCode
 | sId   | string | optional  | NULL |  |
 +-------+--------+-----------+------+--+
 
+.. _UIContentBlockForPreformatted:
+
+UIContentBlock ForPreformatted
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+:syntax:
+
+.. code-block:: twig
+
+    {% UIContentBlock ForPreformatted {sCode:'value', sId:'value'} %}
+        Content Goes Here
+    {% EndUIContentBlock %}
+
+:parameters:
+
++-------+--------+-----------+------+--+
+| sCode | string | mandatory |      |  |
++-------+--------+-----------+------+--+
+| sId   | string | optional  | NULL |  |
++-------+--------+-----------+------+--+
+
 UIContentBlock common parameters
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
diff --git a/.doc/UI/build/html/generated/Layout/UIContentBlock.html b/.doc/UI/build/html/generated/Layout/UIContentBlock.html
index bafaf3f92..ff58c0a5a 100644
--- a/.doc/UI/build/html/generated/Layout/UIContentBlock.html
+++ b/.doc/UI/build/html/generated/Layout/UIContentBlock.html
@@ -102,6 +102,7 @@
 
  • Twig Tag
 
    • 
@@ -207,8 +208,8 @@ Base block containing sub-blocks
    
 
 --++
@@ -217,6 +218,9 @@ Base block containing sub-blocks
    
+
+
+
    
 




 
 
 
    Standard
    		
 
    ForCode
    		
 
    Used to display a block of code like <pre> but allows line break.
    		
 
    ForPreformatted
    No comment
    
     
 
    
 
    
@@ -297,6 +301,45 @@ Base block containing sub-blocks
    
 
 
 
    
+
    
+
    UIContentBlock ForPreformatted
    
+
    
+
    syntax
    
+
    
+
    
+
    {% UIContentBlock ForPreformatted {sCode:'value', sId:'value'} %}
+    Content Goes Here
+{% EndUIContentBlock %}
+
    
+
    
+
    
+
    parameters
    
+
    
+
    
+
+++++++
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
    






    sCode
    string
    mandatory
    sId
    string
    optional
    NULL
    
+
    
 
    
 
    UIContentBlock common parameters
    
 
diff --git a/.doc/UI/build/html/objects.inv b/.doc/UI/build/html/objects.inv
index e64802972a85d3f6ccb46cfc5827ddecf6f4e864..23bfb8537bb4f82296949514b8f5562d74113fa0 100644
GIT binary patch
delta 1213
zcmV;u1Va1!CzdF%hYf!jvW`P5-|MnMtH`qeeVMn$pXoIZ6;Ba5HIgIH45s_TuKl-1
zCC<)21;cjFmdn%+J{VVgZ97(V+G^^n{e6F|F3*2qjQ{)3f5(ble0pKL;)VK866NZ<
zas8yOKkfhKUTuq7_+lz$3-G_GE4twvXfXIbq)m0r)
ztn|mepX}eENnb6&b$99&uo6wuZA%xATW6I=*auvXv(U@bmuo8y2xGN}gtk9WGUW+W
zS~0p`@?qm%Lg9ZRd`7@Yc@W4%L-!XJB<>vm1>uWesg&hL9t*m~slstfjnW7Uy{l1{
zxrqcaZA8H!taWj)cEjaR9xzvlXIh_xKv-^KV6FDcBrTqo9A{V>Et;@!E{n0uzBXl1
zWUVIMMk-j`>IfRb56RLv&xmcVC&Gm>mWwUgQsZizW!8Usfm{pIAQ($66tu-asSL~I
zN{LnMk3f;VAhGg%VU|sK#F*_$_d%*~+-jpV!cOn%lx5CbM!IzvfVhPY0>VnLM9NZQ
zo)z87RN=UVMrnj~-qlIV?03Q$)*%2A7TO3HE1?oZOQE;l#nz)iNgjbv>0Sz>z@AIJ
zN4=jJb{Mcx5yG0!MA}enw(RsBMlkzCE2j18r2N!{tb{?hmGdKnIBZnJP
z9WuS2%2$@+3+=&9BsfOpKR-
z%-jV&B@Jz+JP1gm`71uyiSdq+^S8h&sNv6)Hw-B>FTg?rqG;>g6s@Ixzz>n4JmSjB
z@J(dU6zwH5KWC|jaKor5@0hYOJQEmLMR{dT1X<#Z^iXTk3$qNO^}ygO#_CAky^~%L
zC4WJt*bB&EU7R;8X*pgA4fJMuN9NaA*GH+L-waPlnZ^F{27@tPGcqR>_z5*Uobrqz
zh2{%*z!+n_vwpt71Lz^-louRHG*5&Fl`-Bh*8UcF0yWH>@`53S<^g!%8D+h_#;L>u
z*rDj87i>vHPXq_2GrR$<_*&0HwBc%^*9;)(MV?FyV28b%TJMt%5lvzhRc)=EGCRG(EQYRwVw-5faa&VtDW?A0&d0Zb#*F1okv)lf38j^n3KH`96}#bah~gXP6$3f
zau2IP8o9C^@HJ9k*O64$tLE^n?L^7;1NZQXR9;TtvJ`r?PM)W53iHj?euBAiYL9Ph
zIKCk9lN%Cse<-e2N#fMwZEmKu+R3hF!WAS>s{@JB1bluTwA#siCg2KEo7HYMv$Dim
zwN9y}AGXV~P}M-zsRgYpUa)pz6iNnL;1|INMH7PavGtjceu
ze#6UeE;qky*p2+SvC5NV<;}FM)%C^krm@fPY=3JQEzIBc2nBuYNb
zuhfA|jF*8_*9AT$4Q-}82uP#(D?ZqX@s5#1x4yeLO=Qp%?IkneWvPd7!>B0ln6ffF6Bt-Ud1cP5SmKTJP;1f)vkap3z~C#!
z>PRBHlW-6vf0Cux3&>$zoHs0KIbI13^k#ZTCahW4N2#IT3{Od!#s2aJgE3w+QV|sR
z2{k;N@{A#c<_mbh7-PM&Aicl?=pp2k7aU16PlN}RG2Sp1(-wFFHO!pyf+2hn?`F`le0DXQ
zylw{1&rMhR$>?U#{9JRjpIlCW=I4&9oqTZuZpCzPbt>bVM_8QDtxjiblg|+xLcvgR
z;^=zLusuI=534~M$)_FgHF8SVk=)U%CdIAo%)|Br_wb5TUXtCioOHF$MyGHJ6S&oW
z#
    4k8f-^zQXU5EfRHqd97Ai*VN-}ZtAkyNmpjV6=Wl;1DVGJe12lF+DRrR;0khu
z)oyyQvP@OA&QYZww#(8w)j%4j1-d9hQw?NfdaWEewUZae;(3MSFLfx-%S>FBO{(_O
zNAcy%53KoL%sX;zG~cU^Lp$m` | No comment                                                        |
-+------------------------------------------+-------------------------------------------------------------------+
-| :ref:`ForCode `   | Used to display a block of code like 
     but allows line break. |
-+------------------------------------------+-------------------------------------------------------------------+
++--------------------------------------------------------+-------------------------------------------------------------------+
+| :ref:`Standard `               | No comment                                                        |
++--------------------------------------------------------+-------------------------------------------------------------------+
+| :ref:`ForCode `                 | Used to display a block of code like 
     but allows line break. |
++--------------------------------------------------------+-------------------------------------------------------------------+
+| :ref:`ForPreformatted ` | No comment                                                        |
++--------------------------------------------------------+-------------------------------------------------------------------+
 
 .. _UIContentBlockStandard:
 
@@ -78,6 +80,27 @@ UIContentBlock ForCode
 | sId   | string | optional  | NULL |  |
 +-------+--------+-----------+------+--+
 
+.. _UIContentBlockForPreformatted:
+
+UIContentBlock ForPreformatted
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+:syntax:
+
+.. code-block:: twig
+
+    {% UIContentBlock ForPreformatted {sCode:'value', sId:'value'} %}
+        Content Goes Here
+    {% EndUIContentBlock %}
+
+:parameters:
+
++-------+--------+-----------+------+--+
+| sCode | string | mandatory |      |  |
++-------+--------+-----------+------+--+
+| sId   | string | optional  | NULL |  |
++-------+--------+-----------+------+--+
+
 UIContentBlock common parameters
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^