From 40a59106fdd3f3dcd205321df8f734844e41984b Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ste=CC=81phane=20Goetz?= Date: Thu, 14 Apr 2016 12:03:25 +0200 Subject: [PATCH] Add the ability to put an information message at the top of a confluence page --- docs/05_Configuration/Confluence_upload.md | 18 ++++++++++++++++++ docs/05_Configuration/info_macro.png | Bin 0 -> 12381 bytes libs/Format/Confluence/ContentPage.php | 8 +++++++- 3 files changed, 25 insertions(+), 1 deletion(-) create mode 100644 docs/05_Configuration/info_macro.png diff --git a/docs/05_Configuration/Confluence_upload.md b/docs/05_Configuration/Confluence_upload.md index 2bbabc3..f474113 100644 --- a/docs/05_Configuration/Confluence_upload.md +++ b/docs/05_Configuration/Confluence_upload.md @@ -68,3 +68,21 @@ By default, it will inform you that some pages aren't needed anymore and you can ``` By setting `delete` to `true` (or running `daux.phar` with the `--delete` flag) you tell the generator that it can safely delete the pages. + + +## Information message +When you create your page. there is no indication that the upload process will override the content of the pages. + +It happens sometimes that users edit the pages to add / fix an information. + +You can add a text in a "information" macro on top of the document by setting the following configuration : + +```json +{ + "confluence": { "header": "These pages are updated automatically, your changes will be overriden." } +} +``` + +It will look like this : + +![Info macro](info_macro.png) diff --git a/docs/05_Configuration/info_macro.png b/docs/05_Configuration/info_macro.png new file mode 100644 index 0000000000000000000000000000000000000000..a93e69e336a0022e61dd67cbb2642342af75d21d GIT binary patch literal 12381 zcmch7Wl&sO+hs#Sa0n9I-QC^Y-5YmzYaj%7cXxMpcbDMq5JGT=$-VFU-J7ZTIaAYB zr)!_JA6;j6)#-XxsDhk0JPZ~L004lOln_w@0Kk7=0AZ+4zrWST&Wr&7m_iF-VFgKH zVFCq5J5vj5697OWG%*=cL3sshc)If>GA;m00=iSu4y<5lrtn*2i~tmAkbr_hZEeZ6 zmI4wOb{lx!wiZAWmMAPxRG{|klO}3{ORXP7VrLI=2gq*I>$)q|Zp!ZMe*MDxem^7C z7eD|!3K6lW0SBD)(Kw`3Lo$=GMTN$LV<>>(rF@`9U{~J9!@`1!Nx^)_Gr9+`aBebY zR@`1pzgtmUAv3oE1ahIse=)V5KxGSFk*JeQfddAGoih(K^CUL|7<408LhJ`gu8SY{ zNyufK))q2C7~})+0e<989EN;=f-R)X)X4*4ml5*-+5n!fpAE1BbX!JojB%N+;3lNy zfo!9YNNh3>#au7li!w2b`}Pk^S#L?DJzmgEq81q$?@rurZUx1Xrr&48;xcINVAFLF zSL#m}Ou(4X$UX*7)cCP)%#)ByzYv+Fq@Q52_wz)l_rOUj5pS5K5NCnZV+NyA3@+;! zG(iSh_Bj|9rtNJVMQ-5CVDtRVIG9;^^j)KhWzePjjCsjJLB?At zS)6Ow$;|C)YK{S0)`*OCKJKAMT`xq1LZF_6wV z;4FR!3?GYnV3xtiw?B1!<%a@8B0!@7(}{tb`-(vWS>D5?00`@Gt-((C`eB=);m-lzC_ck0ePto!9r;-2uMq>g4-X+^pg@C) zcu7b|@>NX`JBO$QgX$ZCAnVNZ4CgVE^M}(QJR#7`=Np74@O*tHnczhO&@zr`?@xOG z4j6sVqy480*rR^!9ioJ@&o+oS@oNlD8Ky&Uz&hrfM z@dXBq7`&0c!$1uqBL<%-XAwZzpEHazyfy4(5Ke!nMuX;qm0#oVlYvn!<#OUO?J{WD z(;Bu3do3DwaL1mC10{o*?&EN;$qtOYm&33_vORAL*g826baiNR-}Cm~FQFGtZ|FCS zH=-`ccVvD!1%hKF9B9Iic!a?Cp4svy=Q_k>ZkUlRG5_ktvT38OvW0)dh4U>WJDB@{@EID^NV4vPC%vFU819scI3uOxcAW6r_qOlfNyxDtTP!U!Y#_!3rx9zAkXEz%~~* zSGV}!OtaxPRa86^eoTIxd4oh+78j|MFb7lUSO_bn^eHTNTAz6iV-2Gi;~oQeSTgO9 z9nWEQozce0>%>Pjt?H^Qr$VPvrT$a(Ew4}IQcY5IC3mjmO65zXWks8SOY5o6VtHA= z(}`2&q2m$S6ff(2ELMeS1zJ&)(s_+m@M=k0P+N7I1gQGy%dG)?P*A#9*brT0IF@i4 zi!8eA*F(BV>9pz;DH%6YtonqNA)HyI`K$RjbKJSp1*|2unWzQ5YTfErmEe;8Imx+| z!uc}hyz)})f_AB9wfk5+!RW%|ie~X@-HZILuRaZLVy|Maf*(viGznG-R`#L@hvk+V z1Q`_W=n_{TjZ-X|XDcQ%T3cIXSnJq&uYF{zWkyQ*!F-YxoO;9{&r$8T2~w^rZMSH$ zsI`7Omn)U4kPFudE5nX~-{CFx@pWo-3g<|8N(sG4x?@}ry|g@u zdbn}!wlzHpd-}X&P1=q49`%0jryUOs&j6koFP|ruXVsncrI5#?=NC^GPvuVH&hd`y zNAu@jAWM*#w+%@Bsp-Ms1^mVJVZ*GvzV!#zT}XH5yXAWmz)`?mK(pssU{An7-{~{X zK7Ir9v1E;24MPj#$AB7P*B~BvR;Wp+R}(N-!DIg`2>L#nezm~H;Q7AfAbeQ-@LwUz zXqOyw3`)o=Sfu!k6lG+mMh)uD4h<|rJffBt<*qT6;i_q&L@)EYY2I=oNi zWWu+nw8OZ8mOGvABazeNK6r(Ak$4ppel3*sa=EwNdTyj?t!Q4)@8}Y$G;|sq26cdV zpEvH7a25C!oVUjXdwU^+y%AYePSulehVZ8NUUnrGV(+pw_!n_hd9|Exv=eKjv~bln z)Qo`2PBQ1qOj%%|aU{_%0~)jm=0kDH}_%9X{M#b;B; znWY@k+}g_k)_s-;7BY6Jbi?$v>Bnp<8&^xd=kOJJ)uYC#WS~M@%{kGf;oD%SbZfGh zwg_#1@?-L|c5)M67qZiV?V5knR5_S>HSoICwQ!^JbGiybF1YIO=i>&tmyQ?R)@7U1IoJ00l#&ix~)jqU|b*JOs=6UNO`QdDh*e@>h;zDs}+T68Ps3_k>r8 zQ$iWBAxUY}olp8!R+?|bOz{}fR&Dg zj)8~|hJb*8$I;l7OG!lRzwW>9c!|uNo$a~k>D}Di=-im;>>SPL896yQ=^2>lnV4vQ zThKar*g6}y)7m-_|0l@*#1S!ZGIF%Aceb#zCHO0@fuWs?GcOU*Uy1(t{HIP6cZ+{B z**g8Vt=|pO|FuKUNXJ0`Pwd~WJb$5F3Ks4r)*2!fHYT=CzjN@ha)OL@%azv z^IwSn$KlyOu$~~)@jspXNqT}*VzxQ3{s^=jV~F{0*c5@7kIOMI$T;GEmVm89^Wo2e z;sDr6g8qBve_;B;VJ82UtPd`TJo6Fd;#aL+gYPT6Tqa+5IQlzx3JC|oAE~Qg!25$< zp$v?~2n~m1Q`*_Frld>&;~}o zlB4;CA7*BKrez=+#HDDCetWXz`HUPMbo@i$SA2iJ8oPi@;vcxax&lE7%P6Et*UOCm zeJsC8+twl>_<>_^@o)ytR4_2)xQTK=uZ1xD*F*c8QaD!dzA5N^g5S;y3g3DUO#Y}v zA6Z}6lHtU0^&b*@SY`d-ORd^GS{?tz{%_2-AzwWm&)l|l&+MXhk1y+60PsUWfrLEX zOhdqFer6|GX-xH~{~og*R;g`B#)68@%!j?h^9LjCZ1sqF;`~}m6Czvu;ZKR`0xvQD zoX8d`Xt*{)7w0Xy7f0pr{HuAh$su`D%L9X+BaMH%6FCNxvGf8{ zesOhgW?pg328s|arhhQzp}eBo?!n8z@r68`fV;(v;tiq$vjRf$J?%r0Z8#vB20f9_ zp_P9j#Cq>*i?7Yge3 z&0JWYJlC2$hh(u@O;0+xEzRuCD7taCeCkoTIEl@w{%CKdE{&LW=N(zy;hT*x|}t(S7=~{I&FP;F~r5OV@z`L(RKG_kK~VuS>obD zKWUz>jwC1zE;l0i?BKKyru=0t;OX^7v9*^*{C%FVhJ+qt{biLv_v?-Vv+pRfBN3B5 zd>7Q)$q9Eou^X-4cV!43oMI2cDzxX{s*i-Tm5JvaI@Q9NQD5)Wxz9LJ$MMZmbr1R* zbtj+8O@Ql9qQ0X@KAa2kosSS{?}>KKv+t02y(qw>-NB~4vV4gD5Uuli=1EVodn7`a%tbP;{Q!0O=g*thKfrR&sPiYG`{|n3( z7q3b+3!#>Iqn1_?bZ-h{KE)4;2wd6w8ySx(k&CAWyfav3By8;PF5q59#6cnFkVI4y@gZ4998~Aj#`$%^5ReRx3DH1SyK#33fq*+>)_t3qmZ;&iT3Pl)y9GozhV7 zZO7y5O7|x3=6&KY%X5pNC-3$Qa>Xt=&il-&%D7iPkrn1p-^R6wl^2o*)5{gJE*2E49L;~0kf$~sq-(+DA7`h23aKK`)Ox?J zzetz-q#S=WYrF(&iV{{@H7M4OP?xtE6DcFi%X84L2Gh;gl!(6OEKXAw&dz-%P`mh? zXLbcDA>VZE%#`w6+nf&M8`ay|UZ_NEY-IwT;;xWUb%^j!PECk&CMp+XCg?`-atHpT z6RE94L{;~VDB9u;-#Txi{08P6H^a*}i~;K~MI++UiL{cCJ#$f-I!N`j68~WfXaWAs zNCM=BO52B=<_`HY^M?bnJW5zFo?H(~^i;3x*m!t+Z-92KA<>2w*X5$y)Nrz=OXiG2 zq-qHl3;L74&cLjf@8D{;c)aX5E2huajyWtDsnI|KT{>G^Mk2Gv>KPfM)YeOc{(Daj;1+!`=XR;{F&e%9?4H(6cVuE zjWi*!+E?wb)&)#z^O^|YO<0F({l{9X2yn$i#HXf#4vIHZajr{f%9$3H^mMRiaA!Hv z83AHO&~Kwf3X_mp3T7;MCQ5L9{X<55$60#7U<@oa{w4mM`|r0ITE>>zGxE-LSU zv&51I9CuV+&=d7QJD|c*t4&>2J#_QE8g1T=(5T6j_>OCntF3lXAy|2@h_J!;wyaAjMOUj6lc}x&pjlp6SW8&^ zp4B?6^^7WVP->uJLG!f|(~P}Pc)B@`MQNGeIVb?5aj&sXEF+Z#BDbuA;`qe2p@B6n zV>ab8O6cq!nb8BgklRvj(It&xUq6Fk0-Ct?nl+adAX5ZF9ovXP9LKy|cvS0ySkaMC zwX}%3HoRlj6Mgkw2sdO`I~Ek&)EwT5oa4@ZiYAPIjS-F<&G~CBo}-0bl#_-0Wp~Kt z{Mh0F&GJ3b=r3pMa&KhznFHbau3>OpOumyJ{T(rK3E1tQtJeI+7M+X_FS$*LZol%p zG_8K*O#taRq0gZ%<)=JrE^zZ}y^0 zl5wgI{4~a8+M6V+LDo0C6?uV3l2ftE`_lhQi-7@Y5pdHiV(uWqr7CxAx`&8|V`?!? z*e`%Ms_FU6z(o_ZnU_6`(@OUxI$e&P=m>YGyf;G}PguqRx68|(RgEm5KczDNh|>Mq zg?FC>^a8@jYy}k3cZF9xm@HrB#agF3ceE+SW|G=%h7=rFf!RGj&}@}78PKqL@SB+- zF~LXk)TO|kRBFU#hEl*|noP$qVkdzc72*jIC6TOuV@yTN%L{>fCDl||6%4kSu1<1% zT{62fR2|gBaJ3fU(IiHTyXK0!rf;W7ktM5t*CEo6i?5Qx&Ro7vvff&UAyyNEE`eou zSr(?Sd`BkttX7t62HM~v=AA$UR0wr6wtu)BH|?|b#21RI_dz@3`*t2eNJqA}GrV_v zuy=3lS1H2datK;upS>0#*(&XAk1oGPrd&3W(edJvZ*{#d#w_=x&le9}zS1HTxz}a7 zCv&FJ2#n@G7a~bu?*`wq(ja>Rjp<5da}qyAWP_;URvq)_k|gJ+i49Z(7Zmqo4~*3U zb4OYvXDOu(8Qa*w3XSLCiWlg$x4L%_3TEqER;oZ0WVp`y_j(Y5Yj`*f#)fyj8^$8w zqSt1^%Jdyi_Xec?Pg^M!$(P=yED%~jnybnSZtxFI_e9>^g1>GT(be1NnX{KaoDPMM zbau`bHKY8@AbU0)TqCpA61-AX^-t^M4T;K*=!$M0My|4 z5pByh0zJX#!5v3%rKPR2O5w4C9BzJKl={7;#&2O<6|kFM=DDn_Yt|8>(Z+m>lwdY~ zvLOHwW&T5#3}@}o4p=_-^{)fd3F0x_6p0w)-=*F=pE{e$Fq2SH`JRIQ!T%hvAR0A zi(W%v*+%R*&=-tk%3SdKEbqANotJFsLHDCW>gP3Yv4KtLxu0=z?q~ASlPtj0 zGtG;H_k}5^)gWaiJv(GD!OnA;eSmNAWo#sdw+^1v^s^4m=GfO-@kf>=M^Bu&<8!{k$@~z35D@OQgWzkJ z2gw+cMM|sO_FZ4{(v_wbLiyl4E8#kd<4`F*;mv@2Vq9%+-pxneXH+64D2+MgNOgdy zu(J6j5UvIlK0>uPWY%$Fz@dZbGyU`c&js)P>io0U72C{z44cwSWXb-fT{>_2r+%0Tw~iDGMt;iJg*ie@fzEe`xqD#; z`V;8f=(fsxLw1{jC>gn-l{Bm$XH3G^vutDZ5N=AGsFP;Y`hNJ5u%_IG>p1OxRoJuh zUTDNB&%070t#D+A`9R6c1T?pDVp^{)8txegSyLY89hUy)gAb@f#W^Re2FArkI}@LA zeB^cQrtwQjJiHo|hbiQ3T`hoSO@~vjWn30HjAAMMBw8s)aa$vdhBR0^CK1kuC27#)y(^1pelT+$Oy+MA{R$d{D?N1MX^cI{YX z@DXjkyqwJth9&-JyC1h+;q_2^xoa|{jq2M=_FErYny-@1`kZJ><`{Keltv52(yZA4 zYO=49gpB)V&1UQT1CDma1Kg0zN?uu@NoZO<(pnz& zui{EO11or0?c|X6(1(7=!H^p9rY|+EOxT}fX zSFZ49Eo5DCW`mE+Q{2yqyt)UQL!lAQJ5#_KcAO3KVJ=gw0lw$}xNmSMcqqY-7M|;! z!+unRA$l3+)B%GAvwdrniY93mJG+B73gL{#v)(zVsT-X#S~z(TIgu^5`#o(Z>=qs-AA{azy@J;% zSrbvtHbJ+Ta1Aizgl$w)gpB za_~8!i;fppH>vS; z6IO^BTCle%=5!CI6-Ugho=pPeidvofH8^fdnpNE7()MAV0Ti|AXu87nf0FYMiUo(t_WOS$DcY{5nRvTQpn zCCeAJwj?edTBA)iC$e)ycyUq9P@V7NE}39;i*z&5c2P44<<`thzWlavv%}FiVD(x+ zXID&2J*UnJ7QXjgj?TuhEJ@s71g>G4qaI3(Mp`e9B1!uM4x^rR95 zzUM|E^qI!@_pC!7E;t-PW z!Z@JSJ-uQ*vev!8#Y`koYTd=TmS=un)SwkAeltbo$U4`>`!dg~bU2AbkBz+?vZQ=pPBOG_#~%|hxUM!hcsy-s7FU%XVoD6 zAwE@vMk>}(?}jAP$ND0uvelH?Y_sOQ#LF_=qXi zl3VeF_6gpNw(xw@SX-f?Wf*-eiLLR&uQ>tf40+Ypp#7pRWT!w)I>$X){ChJk5(&*x zfvig2GWd6jdzZ?G&?Dp+uL=F91c_ccG^B86687R6SI$g~s>;Io-)~n4A{dOqrJL{I zC(lHK7S79GH}L|(+vTVDHXNtD53=COJ?d@5!p|ic@Krs!18N(EPg{T?mC!qy8mJE6 zBCD&rjjM}?B%^NN&l(^)c+UASEpEhLRDA-+bA3CYo-5Jby)4(HbwAm5czR4;`eofq z++u|z%N&^!c*MqYo)p`7PvE0$IDo!O3A$L=TF25c!}ZBjIDM^TJJ=Ycl`bt18=>@| zReN)VoqBOXll^eiW1B{D#!lch1#hf2Lo-D#KWmZEXilR%7a~K~!`vX4q*wk6{|m&( ze4>736b;didA`%^lS|02ReaHvzRw;_Fy%@Kz5HY#+^l@~NGus~MVP_Dc?XLoA(FGX zSuMrDB2cCVE^cH(B)7e;1D=#rxWw0BVmi8vJNnt15c}L~m9ae0hj-TPdElvHTCs3x z#OF^NZA=r_4f*Dq2Va3^2GV+%S91f}^e3$Y&IJ*^kV9^+djs*!V`jF#D%Y;Cly*g= zhXmzCscb9ggx{L~=WW2xgX208Nqo>W$85)3*&bS<1H%Oi;1&B>?;gWunM~+0Yg309Ahs#}S`QgQzFvYbxzGKZy6&@y+2OnK#1V-uT-GH{bI=`{?lJCI*meeWfs|lErbe%A2Pr!k3a`_rjsXoR&-%4-%T~fC zUZv~G4O$Zn@x?EjRPyq*7Om4Vz9*IJ2}uF#`CLC`5=&=nw7=f#0imsc*&|R|(G3+U zpX!^LW@0z4ih;efRxq*p>1gci)#5^OUoe6AEg7Fx=)+Uz(4{X4b5+E}M>}+8-g5Zr z2gO010m;z|*LM+xzrGVBq_lGRa)kaeHI(4L5xRU{5_yWv#gW<~KTOWQJ4cC>KeNnT zeLGoM^A)g7NS$VDKp#j-X6LMjba-wETnY$?>u7oW=#9dF-i#wb_GGR#4V$k&e_lmf z5MTUUYcPD4V#IvfZgm}dHSFPDt;ETCs`k-Cm>jGAWC1I)6l9m5%uv>0%_LPHnVZFL zFvm}PA+Iujk0;6pUnW0m=_pPMqsJLmY+f|gR2LSst8t9&azj+JYTyTBq#%pKgLyCPKt8UpD5c{i&XEdxh4quo@hsdwbR0?7rLl;8P!#)Y9ScCNRC?>t>a2VlOz`7vr4v*=usodu0%Jo%k);*+aJU9t;(o0cGsvgT3Su`Wh zf$O%;oD$TXfk6XOUlvC`_3#qA8eKz_Bcf$JwDie3h`BF2r?!S{ymOPEb;DlmgNRAu zH*uQQeWlZJQ{c#&H; zvb-XgY-JHs-?sgx5%&asGjO_#z78&?+ES}bRpF=*Yccpp;FaK^?r9_jANb{?j`+49 z)rZX?$H?TlCt|ApuWkf1C%e1cYO8$S`MoA{)d&)Yq64iY)xlB{DOFUI;=+h;k=o zEB$t8;Cz{(DhQMoODMRXbDOHlvUE^?jQU@QKab395@fDkSLfh_{WD0`2NzEL zttAj{y>0pN@67uPX;09?m%-^&=6^=*|F6vieoy3U4EXyX%Fm`#5e~|nR#N{JN^Hvs zEOYj4UM@Z2$0@;KGs6sf+VE!_*&*Qk&$Rq6Tj2n|8mEBHy=vHzn6MNF6d6c_ooCpa zy{aGoGyeZQ^|psc`g|ApU%O*+Ly^4f2DjZ`vw9*MOkYrjBM0p#8GNsI?f+>WfYNdb z6>`ACh(a1sLdhQ0kBc<_N@vs)lpyi=zpE+ME+#k#{-C&u4ct&ZL1PMqSy7oR3bw>u z5K{^4py%r!joC*cLzzb}u#Wka5B?)kVECE?RYUj%l`U%EUkuC-o-zsiKl+our3@b> ze`^y6dL3B)z-kBwnf_L&{B6PTl>qv891@PGp+DmMR;hgYgOC5ODwUpha4GeZriKgj S)ZZE_fTXCLNR^Pj|NjCrGCyem literal 0 HcmV?d00001 diff --git a/libs/Format/Confluence/ContentPage.php b/libs/Format/Confluence/ContentPage.php index 4e4b074..ed620f6 100644 --- a/libs/Format/Confluence/ContentPage.php +++ b/libs/Format/Confluence/ContentPage.php @@ -27,7 +27,13 @@ class ContentPage extends \Todaymade\Daux\Format\Base\ContentPage } ); - return $content; + + $intro = ''; + if (array_key_exists('confluence', $this->params) && array_key_exists('header', $this->params['confluence']) && !empty($this->params['confluence']['header'])) { + $intro = '' . $this->params['confluence']['header'] . ''; + } + + return $intro . $content; } private function createImageTag($filename, $attributes)