From 5886415aa7ed49f6c933e7c9faa66401d22f83d2 Mon Sep 17 00:00:00 2001 From: Oliver Date: Sat, 6 May 2023 09:49:32 +1000 Subject: [PATCH] Extend docs for report filename generation (#4781) --- .../assets/images/report/filename_pattern.png | Bin 0 -> 9780 bytes docs/docs/report/report.md | 9 ++++++++- 2 files changed, 8 insertions(+), 1 deletion(-) create mode 100644 docs/docs/assets/images/report/filename_pattern.png diff --git a/docs/docs/assets/images/report/filename_pattern.png b/docs/docs/assets/images/report/filename_pattern.png new file mode 100644 index 0000000000000000000000000000000000000000..ab6d7590ab797d260f435f2105f794c4d85f7295 GIT binary patch literal 9780 zcmcI~XIN8B*Di?IP>`{(^*we~$L^re>aom&rXk&uwwQB_gUCLtjk zBVNbexI+AvyLlTyY)IX-mE}mv`k6O~H&<<6XucpJsfeb)z9uK$-*izibR!{Q3Ay}` zMz8E!6Mv*}S2S?ff!Mfvy>_)GQFgVqc6PIaxSQ$SAP(UwR#kYR>ut6(I~`50oIbyg zWAYZ=?c|3uP8Y>0IZRf9J5`*-nj$7XTGd_s;^$-oy+3L*RjGfEYPS3~$7qT51CHrD=gcEU39HHQeh2nPoT`_gD(oCnSK493)E zg$_Z{fCL_qLu3glagBrVbBntnmsdw0PML^}9pxd2*t}o83nL@8eGl>1h)s$-_71Um z8uITx`vBtIAoC)G*nE>{LlK+jZl96FdHx3mK6e{0GribrrII~g&xVnb{HXl=Lg6-- z{jo}~JagXy2tSMLiw+XuY=Y1HKDR9)cv*MNPQ)e z=f>6V;)&LJY~a)^a)o3n>;L*l13q{pgr(_^=`$oUn~_ebj#bKS=YnYoIY{W(^n+TW zj}tyBZ1&Fn=`LQ3m^Eh%W*d$n`?sJJlDvmKAUTAv&PhU3ur|2jD+TgGc9zd(_ zEcB?mM*T!)x|ETs^grtg5y)n}qphnPp~u*XTl@u|Oa|%myVxh(+12P54&^s!^xMfW z8}Etlug%tHteiSSZzEtujFvS{=R1k0o*2gs^osmI;>8vUpXmpxU0I9_1&FU(_t2pk zD)fr8s&>3=^Yi-g&eN4zbK34qh0~oyq!eu^ylDkY-41}15OAQx7;*hc+}#8`6HYWlf2;`oFnne_nvj| zwM$cPu63V=?@J7vK7M}w-mNE@Zh@s|JVFL@@cpI-LjNiQTa9gH5c1iES!%uD3E}vU zP0K&|zfb(kn?*mh`pQbr%VbX5+MmzzV7{a|k51DfHprzZyu$w!ja8m?jw$*K5Kb$7 zKd#Y*jXGJ4{qP1Iw5(O_`6W$df@QON9qvz^HWAgsXuCVp;IlI#-HxbjELMrU^PA*+ zWFTQ*<})(kPKZtAlbyL`trn|w%zfBaO0$n;s@cmyK69DJ5nf}Tk&2w&c1q(vhtFDk zUo2qaWIOd{qifg6rNi9AJBz*^z~%m`fo@lIZY>$fe}3N@tX{QW=RC$cwtTJ-Um|<0 z6lXjpdab*N|Mzf9lk3z*lr0l1kF5O2&HCwVQw6OVn@juBt{5E0SV__>{mwKa+r|4N zVAFdq80d9pQo;uW{?(h=4gaI5jOY=QP4hPuUVoLNkC|Kuj;T{vXpAg}N;&!ujszD2yINDo`@vSn z>1fi_*-+XeYq$l_pkuX=rslangZ{ylyXO7WgsF?#d6ztqDP6QCnI3Cmtph#XQU*Z$ z9kJa`hN|j-D9Drho^8JGwN&3O9{&_r!ru-{!Mk_7%}2-RKIq`{_`bj6XiHfTa+pT% zWjo;G=YLT6irzlUrHMOqdrqf2H>^hV9aHcR0Rhe}xb&Pt2% z(CN<^f)LIn14*9K>!Yoc>vwn%bO5|55)P1YWu4fRf~_Bzni~qFZesgAO5GJ#>mqQr z;A8)semo}QjkMOY8xz6KqvsUL5OVXX*Mzg?`EUx!i@>Tv87$ST^DB&qaLWk^d^m%< z1G0R*M=xD)=j{bA>g~o{pkxG=(6pv*oT8m^!pSeRJY8b-h+^$T5}-*7x`R-m4Vo5H zwK_S9-vZfk6w=5^XBn*MDp-OJ6M41kV)cYtHYONHbyB&UqiL}EDY?!7_4ehL8Rsja z$P*oy*pX;=$ydE_q>iLPPz}KqgujTExg!cLbx;3udhqjbJi*qG%EKTOD9B(&7LOsi zFs>K&%d0lhHgEYnSIwnUA+nhz#?t*f8${c7TwcqdE_Kxi1J$Y!7jOtZdL zM&vBV*;ef}L;%&N-9_RKLasvd~v?Lv^%y)N;ghz&f`!#l>C~t6cUe^gM^=+PL5s9W5ESj=;lV z4uAUCng6(ccj-rjEY2Inj_3(Uz*6Pg6!_4!VhzAWlFCRD8c^{n9Jj zP^J1Nl2SDX%Xo^(AbuTyQL_}qw0-rr@J7w(Ogeju~e`qn(xg)A@$wDPaiypKv+3CBGEv@F8xb~ zdPBO;T>lajT{koZco4h7(6}14L=m1Zajp0iZ;!tomKljG)eP5~H!X0VyNv)n`y-$<(K~HJM6+kM}B_QOn96&wC+H|j}geer*{Hm}3#rH!+^CHd* z8sS~W&)LarDMcYwaW#FBY?Ngcsnt@ze&A4r9re5RslARcXcf zVlbQ+G67#!4@2lORp*5g-R`F*=2kIFy8p(6h#yi2UFA3?a!tKdU)Nk(yG!}Jkoudg z`dNV3*mbwofv2&~)P^f6Qt%O?hb^b;5%r3S|Et%aLzCnU8-`Pd@zhoeDrU<|=wJE% z83|~9vXDx}<69w3QS|351bt`VsPn+I;77AYSGq*r0O>}^mi{4|n=1t)W%EjE$y)!I zx?h1PP0z~JNRPW0Q1@NG5RF6^Cv-l1)Qp6{Ed~lt`zpXp0tCop5 zv3BIol#&|UINyApfs$-mXDqw!{rA)UEw$)b_=;bfG`n))WD zIU`SX!?{R5XVkPN;-~g?ecgl1I*n&yatG$NdC>(vV&rbd4Sw1nYZbZ;hFCq;(0n&v zuB+2e8oO5}M^To4HKibuXZ|LM4GekEF#1g5wrBOj@d4f{BlO49Y1~T(!~L1e8n@@~ z6uSo?sS8CLU}a@OF^Qy0QI zIy$gT8^D7czggK(avehD$PB<*Z4R&jN)K3(VSNa48Yw`O;Q;L4Z=Y4N92jHwi;GqDWZ@2t5x>(0KR zCRQwe5U3}kn_l-vd(pNwj>0*@c@_|Wp6VMOGpZ0TDa=h7tDVow%hBowGS#ug$^xet zP5P!p3^wO)0oYdes4?wTp!>F4L;BHBYjoJ@gWo(ef|kWsw6)e)`5*p?TF_IK7X0&9 zUHqZTlhP&l{FBn)Ip*L>>E6q1rl+VK6`*KdDK04a!8SAb4`-+BZwv?DnKZ*s?70=2 z6wEo>+d;0I@NygpQEiWSjMIm8V9V?>7SHy9Ot3?rcR+pSonJ3nu%#pIt3KEyv#Y{D zirm9otiK}b{+6+o_7jg@>=?X4>oWdIQI&P^@EMJn%*@90QlVGS<@Jw&9IdB?RQPd2 z{RyLkV0`jq69ok^HIOnuoj8XElttua_yk{RTD$%X4nAtFi=G@Qv*Pr|Ki}x6)*1tr zj19GncNJ?5!Gny@cr)&Yu*PIp&!uEUFCsEWV62345(?IbaCOg#9NUVv2ni0V3DsM* zm|4AB=Ttp~n>~)f6&D zIKthXA9!7!eWxNoDS2%8_;eaO$o_1EH{6F&5?t#kgprq?&_3{73B3QE6Y9T3Cyc9q zBPdKhkiO%`OWe6u8Y|WYlrS-3Ku(}F(y^L4EB?u!Pq|mh(12^8eRhH}y7z#X^J&T+ z-X?EU=F;Fej)B3`N9vN**5ESpmA;AS8fUXU!My`I05os3k1XcOhT4k#J)4eVq}oxJ z=;;|xmajQ(&zI|7m%BLnj6M9>4rB8tPDYbK*l9R&yeB&Ozv7y}+PQd-_DRm+OVGbI zZ2j5#*67Q?vpW;+EiQGROV#FqaKD02Dsg_`+>`3(;fkB$mEF``RrekHUUQ_LyWQKi zlP}45Wm8ivjjy#~{Z#1G!gs3?qBe)OFXX14l1Q>MSKO^T@}(S2g_<=>)?HE$}Y*Zsi!lPvOvKgk)d zk(<0%T5NSA9r@Jy*s5K(>EvYZ%TZtmA+1o{PLuXzkSs8DlU}jE^{2&u04Ubi;c8HZ zX@nFYP0n^~LY|}eZP&kGXQ-|yBz+Z9p)#ukZusR>)(qwG{N?jsM1tb$YB)8VwlrT2 z&KmIB@=N_xA5{J1Ny$B>Pu*N1uUAl)vd$-1+bPwi9rbbLMrr5@cfQw+n$M$dj<3Bh zGp##lX|kh8Uev{*_%<8cfbFw&2O9 zdOx4%tN6+r`X=jO0*tq`DNYHbXEb@$r@UE6P4hR}kH*J=)|S;i$JaJq$}Ic}q)aiK z3Z}4S-CM+cl;4#JLqZ6Kn!k#=x#=!+=-dHc!!#z%`45Lxy}cOZdM=1D$D_dYXW%x( z>&!rc@+(JmhfxVz&(R>rA=pS^v#{pz%)iX&wSzT8E&6dTQmxr~MHc6`e!pl9pQJhT z{)n{*_E9L-@vq2!8nXp_sXh@P3^PGTM18$p!aM8OLW~W3aKZDRjsWw`#H03b!fD*w zSMS6P+Uati9xA9W*t4cEWH48xbMyUPsleV^6@z3Dl<;&il168uGD2yMW#Q+d^&x?& zcR2`m``2}hy_lc4(WrUpIa0E1k{-0~yYZ`Vw zu*bl@ zpF*<|29grzs78&2M_R@+^bd<&?C0E0+p}lm+IJ-2=wGHF)#8lT(f+UitRBlp-XZK) z#78;1su-8e##dWgwTXe((aDcAK(II*XrEbib^#~-5AsL@d677IJPpS4sjBcXrp3=| z7ks#QfyW+(lq53VQ=etx7ZP48AK*5lzf5p)clPVP>&3p4<*2i1{m`X~x?S{~qSQ|bUmti^&iqphJgX-I9G?^q2xzXCy!5fm zn#bFJeJt8zXUNuzr6~#4poR=9Ik!tndkLN^IZ)-bZUttT^?WDSJG>TnYt~WTM@*PZ z5Z0hD*B~GxoX~e4=w{`&u}~~!s&}=;{#3`z*|6%Vv|?!&Lh237tD=}j6*d$^tz`;u zz}=sD^K&e*-@WiqZp-jy`$`#p?>p~NvVBK|XXEh2tK?;+H-iJA-A60hc;I;nM<30Ur}ndTRs z^dex#{%OPrDEBw;#A@ZGwWdF?RQa26*ZxN3CSD0cOJu^V9zZv(F~DB!iL3r|bmX%H z&N#lU*v{#E)Szht_5cX~KO8J61M_})xR+WwIJ8)Gzg8aj8@zZT#1?PtCFzhjm@=Gt zI~?@`2$IT&i3ypt(Kt{ShK$pA6Xst!E+q_EV%lRq(IVI+uan8BNnaSzTEG(|zZS^k zf5qE`z2-Y5%ReaU4h#s7k}kuz2Y(_)%P}bD+p}HY`N*s(wpT% zUgtDJ13bMUx${&ho%!>a=x4b|xUZx<`z(9qCcc8*e4g=0LN`j7)q==j60=FaNbEg* z3y~z8B;iLt{xh0US&C0c@X@lHfP2K|tl^FS?Uociu50%PCe|1k!j_B=C)DbyL|5-E zh#k-)GpS~#QL~qTuj4qm4?rQAWrz$WB|TJ}6Fw*3);!&MxI>C7`<#M0o-*3|$^`Y0 zt1-qGT4q=6e{-%|2P7~3U7QRxk&xtPlcpP2)TW9cs_#S*E7-+nww4vgD-R5jTe*XH z7FR?mg(}pzO|`>pG-rMpeYm1^;A^m@-aP*|@^+S|DR&?d=1&@ElFye?eSO|WK5L^D zX2rU5OKu2hGq%)#ZKsC>Tx(Z}uTl;ux2RR35})ZFO~&~8QbiM)!_Car_TBGTCm*$~ z_2Q*T|LWW(6n3F+aKNur(AyDr(!zu6GJ3mE0H z00*sSmJ5CHwIFi2_TuWfw+vsslJS`}>`=tK!L#5kK&ryOeF1c?a!!IBdb*1jd zCEq@aWoUbz%~*3e@Pkg>4>q4=YB?8@A7OXN!tR0F=7$?oQCEonal1>xx4DDTKFiTj zk{F0T`CMSn6L`<$Xc$c7!3XbpFftQK`k@XW>K3u{YKdtR*hFZI=@kiy!L=u!KWFB6 zxP5o}A3M7cu(vu)kJE3gL*FpN_wX9aCXxw8hT;*f6u0z|$sNLE$&E#oa&PHq?(jb|OLVU7_-gMma*NB^#?d z87iIHrzulYp~+dKEzB3h6^-*pg{n_f9j&g}AkrRbN=$^Hs(c2z5X;;S#}#S^+s+A$ zVy{-gC*57_JVGGu?SrVda}qW*Uy_rgnwRW>d^+;eb~n%UINS`i%sPjyZR zTk;gfbGc(qDZo8+H?3#Ybq`Tj!OmLRsIpJToaWDPWkqFIjG{k zM8Vwo>hN-*PJUkHU``S(7O)!@lrLnK*kpp_B@j-U0*{2(Z7L)Zma5}We2{UXo#qg%atSDHYo*%gbm33U}Wc1TcI;nfXUm?{$} zpQ-=~P#P4~0cWe4O7D6s2b~C6>18?m(EYJ(@5o_37F67^y5UfSEap56m<9>lt9qjREfq-5E^!?8-@MPT5Lx}JjlxH z{RH*Aj<4~4f75)hf2U$wmU3$};r9t4_1XGN8=?|cSUvO2h|6;+qb~KKnJ@N7yn&tP z(ZTX|ax3BC2{8hCYO@zSd(72(o3>(|Y+U0b4E^yw$fzH5V9v>A| z?o6d>wKIReMkYPa?)YQf)Oyl)76WNs9%>)RHj2DRH*0mNt+-eKQFruBjdFc!T^S^j zO)~=))|^M=<#IJgm|o+jHa;Sxdw!=35YB;KtU@;<5bguurWOPL;hjR&}TmVr(r8{$- z3glMjpDV8je@WRqD%0X~;WY(H*+<0 zM3SMF$BtsVW}3o;bqkE-mD_;JgJZ^9#{367P2bZcF+&T4I0+Fx2-6fWpAzi=#C=Xt zmz`YI6yVa{D{`h5^0lANd7wQ4Dq>2AF2dJDXeS=Ve2I{S=O`WRY=GtD1PV5Iw5~Z6 zk2Fc<{>XISk@DG6;NNAQc~sf4I@xWwYy~deX)@2LfoRLA*^k6)@JBoOI-&mXoPC62 zklCd2LBzA_`Ji76iFg(y_N;TWzwl!d@ZH$&RIpmkyxuJPGkbrFL(o^#O;=X!FZ+3M zO~zKLlytVph=~=&4)F@E+zv?1{hNZvOXUJ%i2_jV|&ya}vZgH$9?a z^SzjnkMd`{Kv-?zE5WRn`3A)&LHfB@#+o;4ytG(mlsz*NPC90I7TUsMr2;W|2{e4( zKDD1^VfJPzv0!=0qfl8`!}h<#2e3e<5|oadR={#<0tJb$>l;drlW8Eo_{fjf>~KF} zjOv=k9T~`G{DL?J0ui(R<@h$eG)+;?!#CZ_i@eNicg`fR`$vbj|+8Qr|D$db;%o5aw4u>bM&2vm@IcXbT6Hk8~p!%$YqJay<`X zVj=+WYNex^OyirXrQaxR*M^&^ADh7OpJ;EDcs{Djb$;Ja)znw4F$&IgABPau-X>q* zU*z8unM0c{Ori{zzq%5YtNmBGfYJf0l~YR|9KLl^r~gO!-$0H3Fd>h8YapYCDg8$l z|3ns;+9EOez!<}#R5QdwFcuzzd}tb@r$9>OKt9o%%Waq?OL}aM#-F3j_IH>d-(u+a zPEYGxh?NI2+iPcdEr?h=3}!16E?$}~gcwbb8s%OB@f1=+oz`vsDW&gqw>s2J-1at1 zxLPc#J6%H#26m73u)+9R?o4YbLt)BXOBeX4X+2KZiKox87lWR9g9wg27aB*SJ)`L; zYX86l@Zz0J3!9y@#f?i0X@1$f^yJ_us>03Tc>-BE_MjR+7u<4k4gjqq=K7#1*Lf}H z!RE9`x2?)hB-e%dyvSQY=*27(FQ?Kiy`O?g;=9)<_4uoiS4^COE{3fKgv8PumHX#W0G*uFq4~K~zP&qN!-9TDQZG z(ilud1_75O#&mj~OMBg%`T3sUe5Nzy h^#4(uq%&S}MzHZ``lZ|JWOX^Qs-l)cnVd!7{{rWQk+c8+ literal 0 HcmV?d00001 diff --git a/docs/docs/report/report.md b/docs/docs/report/report.md index 3955d78e4f..643a880e61 100644 --- a/docs/docs/report/report.md +++ b/docs/docs/report/report.md @@ -180,7 +180,14 @@ Boolean field which determines if the specific report template is enabled, and a ### Filename Pattern -The filename pattern used to generate the output `.pdf` file. Defaults to "report.pdf" +The filename pattern used to generate the output `.pdf` file. Defaults to "report.pdf". + +The filename pattern allows custom rendering with any context variables which are available to the report. For example, a [test report](./test.md) for a particular [Stock Item](../stock/stock.md#stock-item) can use the part name and serial number of the stock item when generating the report name: + +{% with id="report-filename-pattern", url="report/filename_pattern.png", description="Report filename pattern" %} +{% include 'img.html' %} +{% endwith %} + ### Report Filters