From 0cd82c9459022d25c00a2426a3edd75c548e058d Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?S=C3=B6ren=20Weber?= Date: Thu, 29 Feb 2024 20:45:01 +0100 Subject: [PATCH] resources: new shortcode to deprecate attachments shortcode #22 --- README.md | 2 +- exampleSite/content/_index.en.md | 2 +- .../content/basics/migration/_index.en.md | 8 +- .../shortcodes/attachments/index.en.md | 21 ++++- .../shortcodes/attachments/index.pir.md | 3 +- .../shortcodes/resources/MaybeTreasure.en.txt | 1 + .../resources/MaybeTreasure.pir.txt | 1 + .../shortcodes/resources/NoTreasure.en.txt | 1 + .../shortcodes/resources/Treasure.pir.txt | 1 + .../content/shortcodes/resources/hugo.png | Bin 0 -> 18210 bytes .../content/shortcodes/resources/index.en.md | 78 ++++++++++++++++++ .../content/shortcodes/resources/index.pir.md | 10 +++ layouts/partials/shortcodes/attachments.html | 1 + layouts/partials/shortcodes/resources.html | 60 ++++++++++++++ layouts/shortcodes/resources.html | 11 +++ static/css/theme-neon.css | 2 +- static/css/theme.css | 2 +- 17 files changed, 197 insertions(+), 7 deletions(-) create mode 100644 exampleSite/content/shortcodes/resources/MaybeTreasure.en.txt create mode 100644 exampleSite/content/shortcodes/resources/MaybeTreasure.pir.txt create mode 100644 exampleSite/content/shortcodes/resources/NoTreasure.en.txt create mode 100644 exampleSite/content/shortcodes/resources/Treasure.pir.txt create mode 100644 exampleSite/content/shortcodes/resources/hugo.png create mode 100644 exampleSite/content/shortcodes/resources/index.en.md create mode 100644 exampleSite/content/shortcodes/resources/index.pir.md create mode 100644 layouts/partials/shortcodes/resources.html create mode 100644 layouts/shortcodes/resources.html diff --git a/README.md b/README.md index 366c024eadd..fb137e81287 100644 --- a/README.md +++ b/README.md @@ -46,7 +46,7 @@ The Relearn theme is a fork of the great [Learn theme](https://github.com/matcor - [Image effects like sizing, shadow, border and alignment](https://mcshelby.github.io/hugo-theme-relearn/cont/markdown#image-effects) - [Image lightbox](https://mcshelby.github.io/hugo-theme-relearn/cont/markdown#lightbox) - **Shortcodes galore** - - [Display files attached to page bundles](https://mcshelby.github.io/hugo-theme-relearn/shortcodes/attachments) + - [Display resources contained in a page bundle](https://mcshelby.github.io/hugo-theme-relearn/shortcodes/resources) - [Marker badges](https://mcshelby.github.io/hugo-theme-relearn/shortcodes/badge) - [Configurable buttons](https://mcshelby.github.io/hugo-theme-relearn/shortcodes/button) - [List child pages](https://mcshelby.github.io/hugo-theme-relearn/shortcodes/children) diff --git a/exampleSite/content/_index.en.md b/exampleSite/content/_index.en.md index 3f7c939b129..d2d4774c848 100644 --- a/exampleSite/content/_index.en.md +++ b/exampleSite/content/_index.en.md @@ -49,7 +49,7 @@ The theme is a fork of the great [Learn theme](https://github.com/matcornic/hugo - [Image effects like sizing, shadow, border and alignment](cont/markdown#image-effects) - [Image lightbox](cont/markdown#lightbox) - **Shortcodes galore** - - [Display files attached to page bundles](shortcodes/attachments) + - [Display resources contained in a page bundle](shortcodes/resources) - [Marker badges](shortcodes/badge) - [Configurable buttons](shortcodes/button) - [List child pages](shortcodes/children) diff --git a/exampleSite/content/basics/migration/_index.en.md b/exampleSite/content/basics/migration/_index.en.md index 90761edebf0..13aeecbc3e9 100644 --- a/exampleSite/content/basics/migration/_index.en.md +++ b/exampleSite/content/basics/migration/_index.en.md @@ -20,7 +20,13 @@ This document shows you what's new in the latest release and flags it with one o ## 5.25.0.beta (XXX) {#5250} -- {{% badge style="note" title=" " %}}Change{{% /badge %}} If you run Hugo with [GitInfo](https://gohugo.io/methods/page/gitinfo/) configured, the default page footer now prints out name, email address and date of the last commit. If you want to turn this off you either have to run Hugo without GitInfo (which is the default) or overwrite the `content-footer.html' partial. +- {{% badge style="note" title=" " %}}Change{{% /badge %}} This release deprecates the [`attachments` shortcode](shortcodes/attachments) in favor of the new the [`resources` shortcode](shortcodes/resources). + + If you are using Hugo below {{% badge color="fuchsia" icon="fab fa-hackerrank" title=" " %}}0.123.0{{% /badge %}}, you don't need to change anything as the old shortcode still works (but may generate warnings). + + Other users are strongly advised to migrate as the `attachments` shortcode will not receive support anymore. Migration instructions are listed on the [`attachments` shortcode page](shortcodes/attachments#migration). + +- {{% badge style="note" title=" " %}}Change{{% /badge %}} If you run Hugo with [GitInfo](https://gohugo.io/methods/page/gitinfo/) configured, the default page footer now prints out name, email address and date of the last commit. If you want to turn this off you either have to run Hugo without GitInfo (which is the default) or overwrite the `content-footer.html` partial. ## 5.24.0 (2024-02-28) {#5240} diff --git a/exampleSite/content/shortcodes/attachments/index.en.md b/exampleSite/content/shortcodes/attachments/index.en.md index 40d9489c6fe..7483cbcfa9c 100644 --- a/exampleSite/content/shortcodes/attachments/index.en.md +++ b/exampleSite/content/shortcodes/attachments/index.en.md @@ -1,5 +1,6 @@ +++ description = "List of files attached to a page" +hidden = "true" title = "Attachments" +++ @@ -8,11 +9,29 @@ The `attachments` shortcode displays a list of files attached to a page with adj {{% attachments sort="asc" /%}} {{% notice warning %}} -Since Hugo {{% badge color="fuchsia" icon="fab fa-hackerrank" title=" " %}}0.112.0{{% /badge %}} this only works for leaf bundles. Branch bundles and simple pages must be switched to leaf bundles or you are currently locked to a Hugo version < `0.112.0`. +This shortcode is deprecated in favor of the new the [`resources` shortcode](shortcodes/resources). See [migration instructions](#migration) below. {{% /notice %}} +## Migration + +While this shortcode will still be available for some time, it does not receive support anymore. Start to migrate early, as it will be removed with the next major update of the theme. + +The `resources` shortcode leverages Hugo's resource feature for page bundles. It has all the same parameter as the `attachments` shortcode but applies the `pattern` directly on a resources `Name` attribute. + +To migrate your pages apply the following steps: + +1. If a page is not already a [page bundle](https://gohugo.io/content-management/page-bundles/) convert it +2. Move your files to a valid destination inside of your page bundle (depending if you have a branch or a leaf bundle) +3. Change the calls from the `attachments` shortcode to the [`resources` shortcode](shortcodes/resources) and adjust the `pattern` parameter to the new directory layout and the resources [`Name` attribute](https://gohugo.io/methods/resource/name/). + +Multilanguage features are not supported directly by the shortcode anymore but rely on Hugo's handling for resource translations. + ## Usage +{{% notice warning %}} +Since Hugo {{% badge color="fuchsia" icon="fab fa-hackerrank" title=" " %}}0.112.0{{% /badge %}} this only works for leaf bundles. Branch bundles and simple pages must be switched to leaf bundles or you are currently locked to a Hugo version < `0.112.0`. +{{% /notice %}} + While the examples are using shortcodes with named parameter you are free to also call this shortcode from your own partials. {{< tabs groupid="shortcode-parameter">}} diff --git a/exampleSite/content/shortcodes/attachments/index.pir.md b/exampleSite/content/shortcodes/attachments/index.pir.md index 9022bbbd2c6..8c3d0249ba5 100644 --- a/exampleSite/content/shortcodes/attachments/index.pir.md +++ b/exampleSite/content/shortcodes/attachments/index.pir.md @@ -1,7 +1,8 @@ +++ descrption = "Th' Attachments shorrrtcode displays a list o' files attached t' a plank" +hidden = "true" title = "Attachments" +++ -{{% attachments /%}} +{{% attachments sort="asc" /%}} {{< piratify >}} \ No newline at end of file diff --git a/exampleSite/content/shortcodes/resources/MaybeTreasure.en.txt b/exampleSite/content/shortcodes/resources/MaybeTreasure.en.txt new file mode 100644 index 00000000000..07fc7370eed --- /dev/null +++ b/exampleSite/content/shortcodes/resources/MaybeTreasure.en.txt @@ -0,0 +1 @@ +Nothing to see here :-( \ No newline at end of file diff --git a/exampleSite/content/shortcodes/resources/MaybeTreasure.pir.txt b/exampleSite/content/shortcodes/resources/MaybeTreasure.pir.txt new file mode 100644 index 00000000000..777f98ab13e --- /dev/null +++ b/exampleSite/content/shortcodes/resources/MaybeTreasure.pir.txt @@ -0,0 +1 @@ +Harrr, me found a trrreasure!!! \ No newline at end of file diff --git a/exampleSite/content/shortcodes/resources/NoTreasure.en.txt b/exampleSite/content/shortcodes/resources/NoTreasure.en.txt new file mode 100644 index 00000000000..07fc7370eed --- /dev/null +++ b/exampleSite/content/shortcodes/resources/NoTreasure.en.txt @@ -0,0 +1 @@ +Nothing to see here :-( \ No newline at end of file diff --git a/exampleSite/content/shortcodes/resources/Treasure.pir.txt b/exampleSite/content/shortcodes/resources/Treasure.pir.txt new file mode 100644 index 00000000000..777f98ab13e --- /dev/null +++ b/exampleSite/content/shortcodes/resources/Treasure.pir.txt @@ -0,0 +1 @@ +Harrr, me found a trrreasure!!! \ No newline at end of file diff --git a/exampleSite/content/shortcodes/resources/hugo.png b/exampleSite/content/shortcodes/resources/hugo.png new file mode 100644 index 0000000000000000000000000000000000000000..48acf346c9e87d15ca919141c2b283e7fa8bce4e GIT binary patch literal 18210 zcmdSBcQl+|^gc?oh+aYxL?@yqTC_pb=p~6Dh~A0bMvH_&L~l_>mmzwK=s`rHccToV zGfFVZn3?;|=li?&-&@vQ>#n=jB=0GEKl|BxpTmTC5^JERL3QiiEdl}ps%M(2Mg#;z zXaWM_$eTpK%Ij}ooCE}f9tJwk)qp8Zq4EFo*Dyf{o&yfI@}_E@CU%VW{ZZ5WHl*il zXk+mrZ^n(Y5SlRknis(I_yhZwtr=sQK#NihbUs0o* zqqib2R}YT`OSagvuB585C^Qz086^!ns+~bSs+c5=oVXo5P5vIeeLC|n8DUnj!^q;{U30153~4*8nqD$0TlZ~2jc*59 zSaAUr7xp#MGbXquS_M&&Pe~kYvCz4k@i)DT_1VuaO9~=gxX9EHX0qk%7}2S+F!^CP zFxanxVR=bFpeFT9Rrz@!e1B=)yF!UkebvFB&(up*mo?SN6pdj&q%_fZ@{IRq^itkg z2N5$P&f)I0(5lBIi+;>3IHh{MB}{g(ru;0hZT~!t4N(pDP(~RV-NIqoYWf zBQS6iW7O7j!w@vx`>XWTG~vz_(Zdf5&9A1z9uZ8%(%3AO+7o=4$bQCKws=7hC!rAv z(+nS%An*-LD0w%`@h*X6NWRwDJ4tb?f|q}U(#=YSz>)XZd|;}{Iry8T2AvX`DQWLO951j#bD0Vk;9MhW|5G`oM@YxM!fjdVuLWS>{#v_~zlYEmtU0=rM`Vk>{e$=) zgXmFM9z7SR+X@R%Y4u*B2z(3E?jt)A!H3*p4hi^JEXAm19atZu8Jk9>8duHh*|SvK zJ$L8ULINEL72317B=%qK5J6N-ZwIa==C1FmJVq&PYJ`%GokP=wzjx1)L(7F?C%A0Q4`-d!$`(#I*iPY@bf-X?LCKC+uYMDDeyZNT&K5SZ?D z!PJO%C*5(+WNbQ~N>ssGslT@>n3hh|FC3UU<#RMO+%2!J*=w%a>&*G7%Lzc`NBX)r zR>VBd7yR>l;BnqAY)q|>Y}eOV&N$~@h)RQpJ&us}IP&rI)W}>}p2c<&yv_h&Asz}G~l%j+Ds+X`-;%xHaJ{M?=I~$&DWG`KrvWC>}BQxVMma}j^Y((CY zQ3Z3TK5m*!_a`e|aReN{80a8B4j%B3harIq-eM$c&nc{LgOT;2$9r>8{gZ}i~a{r%p@tW@x&l!$;{9c#)>!l0Z1w34*J?_~6m-}B8 z3vbUcdj~GXYX|8e_gk84k)26E$vjW;;HFhbqOT;QVO*fVypt)twg#FyR|*+ur`Sn< zB`e_i6QslaUZK+ zT%cb-5Z?p^O@Tm^_(?x|r?K2Dbsz?cQ3W5di27x|pu(3WFvu$(4jVoN&Mut<4>G?TGU+2DTIN1ObZ~(*k*q+=C1H7TTp*zq zfhHe~zL@@uQh!T^W9!lnu)IuF@SL-w%a-2d(E0ojGc1pLL)?mvy~LloDg6BNC0El) zGb+0VLSrNs^V_lWKRg%c<<)`3;fXY0%mrdhg$I?$ubrIyG&7P*JcVMoK<1(3tVh(B zQ@4+;#b9|ps^ACQO+IFq0f#3wEb*Gi*G8a|+sE@NE?Y%d0DANmwDW4JL$5F9xWpf1 zxfW0Z(U*heQN}uULG;C8d3U%#?fNd|#%lqGsfWv2Msm*dj-6eh=QGK0^0dn(!8K#x z=A}Vs$V&Woc}Ku%U^7jm9mDY|FDy?|6?~!Z;>b+Lj!lNo^LcFwu8C(79`eKjDMGVL z{G$i24dmz_)e9kk@pYGA%(_+3Ho&AqmOTd=(G$K0S1EP0848N;!% zi(_Tqp(P#E%}9=yYcz}w`r1fN?QvJgFj)K<()Zc*!R_N`JWZ4Q_*kjxF6Bn+L+5P} zeOg$aSuCQ%p;M;B|MPz=A74zlX9l8jF2m$uc_gafB>4Qp<2IANEm;_wtOHPK=4VI) zaiCB#`Yti`_&PZo$vqzi@*7ElEBBGX*j%_k;i};KDe%GoAlM0HYQze4z)?#5;AWB2 z<6$8pa=To^jMW>9IB(+HY8a|8Wmt8IMXQtUsrz?0!vCVqz zjqm@m^TR(W1GBR)n^WP|2H2&L;64qP7*pVA?;l#i*c>p9xK@1l&T*v0%Fy``o*FyX z+N8QmOd|cUGgnjZi;Aug96RH2GJMqxNKQHie6EFj+krY<29COs99Zu%z%vvNN*pVW zIKcaJayfQ(;EVB&C+xg=1YGL>E9J?F`^SrmDPH}xc?4=nut}w)4>CGhhBvRH?+OXQ zL-AiLvk-gJ^>lmYS{HT?gZ3KQCF&}gFTqkfpWY8 z&Q{xh)m8^MSkSQ(SvEgDNr$f*BqKV2TW%yLl={nAI`HRDco6sFDEh9Ev(lat1>ePSuK`19s3>L}-IXq->oWc6NrZJx!zg+& zDmG-qOvtWy?qHhb*xH4R{8@8IlR7vHu56ToTyD~9%Y?D5^UfdKzKh>&6=)8*{oih| zBFRF>DmO?6S#S$5?6v9CK@#*2fX~^E3t<#v2lg&x589UG0{dcMY#gRT0b>vvV>zYH ztiuR@QDE>p>+pb%z05zN5xE?I2PFLW6WnDk3asouLSX;fLfpZJ)VzBVD!JA>MSY~R zn{|kwW53bfje}f1ZX&Y#c!~Xw)poM{W?OC|16iQVY2nl3eOy-7q0W&-B8=^3GVAfB zY=f-@1?ueP(bIUFq4Sd_whfmJZ>Qa-iEHy+-(|~c&$nHGz0@~t=f_9ER)Xh2&@vG_ z^5&4tDmDkf^Rm$?>a?ANi;vCzkfwMbH@{$@F31`mVIXy4Z{+d_s>usKru60p<<#R& zop*~^U69MVJ-8!=6*bd7n@$TD^wMd!NZt%^r1IN(3XD~Ou^da;?ciDd?sy}Cey~Or zl~>_OC73wS@Nr?*;i=89)99gUDMCv|y$73U=kCCmp=Bmri!}Z6CG_yJcmNe~U~-hs zP=H5Uo-=ss@0iAYE=Sz<*Y~zi7@Hl}RX!bClZK0PJvuD zqcWadw*$a-ytF6oeBY_?HrgDU3#MH;$r?5;Wb+sZ2(2MKv)4o9wOvd)?ud&zn-69! z^EZgyrh~d8Cd2+(-#jY1U-t-6wv`;dY6zqwQixps&>@u*OnIaIi~gIT0NK z7D;o6T*wY;kz1@O%IrhJMJ@tPk$FF&OvHt0`k153e=py?A(wZcFv0G4 zpFZ___owoZQGc%j$+>)uZs~Y9V43&`y708AlUZ+>~nAyA!#v^clde& ztHJ*_RG|Ql4y{3z8auM2E|E!jOZqoY5%?^I2`J&pVxV|AGKp_qmdbbYnY!x~!f zZ*`V=t6-Qc&Evv(^jR5|lBY5Mc%jdt1n^JkT$P$Un~{f>9DQet0_%)y;%!Pve@5=E z6E|K&{u>UHxgQED2Moj`AirwZNr)7&8MZ>B`FZktZt z-_WESa~;Klb+4v~5WkyN}H6^|7$c(5FCGGyOUKfie<(U6rxX$r)p8#9BPERAFHJ~2GvE;YK;jQR< z6>&SxAH7aMd3Xb7?44#p{n&$mRLq~UmH%;Q_bthWP;Z*+e?*nHF*}*IzEs^DvN1_$ z8x!VQqn;%TZyMr|h%?5I=f6Vh%4uG~R>YvJYt@8ze&uohGA~*rn=z?f$qf0+De|Vt zd(>xeVa*>$782n5Ly3~eu(pV`%q3c zL#b-bXh~P-Y;dd5==po%pr4=ze5&M6i5t~34~Je)+GyD7NGKm(W{izoIuiDbt? z{|_Hn?C0nYrqAz4XqT(#x9!Rt@#NR>pZO}x9{MUcPxpS?6@bZ7R8TLxP|^1p;CT4{ zL;O7_92r~8OS>hhszON@^ONr1e;V(>rUfhK8*^hDM!wqbPaSJl+wl9$FqCh&{U%%} zdui+DM=$u+Kibi-dT6&sj{-S61U1k0-(X62^4V$PY*}iRVc2}Tm}C2I`$nlgSXM|Q zdpvw0jlswFz)okMTO(i6=PvF1r+I1rC{&kN0@uk4W^c^z;e}-B{TciAt$B%AP?2?G?XF}X?GXX1c(4mri3PNVkbZn0iBV9 zllc~5O#Jukc_RrZdyj5Y5g8l)^nEO+)F{RLSDo>mYMsvBf$J=vR>01=e87?DGL+`A zGyDG^UQk@I`HShn!N!VPVFjTmZ9njLc{dt|ljGX!8Ol%8@IU8g$0E2$!^6GC{@w54 z;?;X)LNR^{_rbm|<1-ulJfFMiqW5EW!-A&oW`;k33TKS!_v`KG%_O>a34~9dF0@Rx z*-*e8&;3IF#Ls$DoS^)T_TTSZ)lR0dRMxPwOD##kadwB60SqKR#6DS#=al#K28+yb z@lB0R&_s|E7TFY4rXb=88JJ4=OdAQGD{ZROW^pOiI?Ngr#s$9JT?5aG&{b(50$ak1B#MW%JRDsBz zLFm7Cbxbu%jCX&e1u6Fd$@{l-&Hu=?P`)DO&tk9ws?@oJ)c46^YrU7#zIR@r0u~nFVc(;J;vrK$9&ao=*HEpYati_9YkR;d6@K||qP`6SxKhoC z`5tO}WtS@NS2n+Z1yobGt1ibKooA)~l&;@wfdaRD#lX}eIb>2~M{5T;HvpJQ_~CpS zD1sa|5o2-R2ygNQQ+(W^U}5re^BjepO2DW38I@V94}JdD8d}{8;AS);q7$wTB|_h@ z;Mw0so`02F#g*Zx^)I@1)bU9xqm8vE$?zsC|3&$WtPyJKtvQHBP@>E}wgQlE(fv1> za+2D~-8S(U^C)rlmvSjz@9#Hn0jyGy8p3nJ`4c9GyGENiyg&h1+`ra^yz+9CgpVma;O*83&2znH7}tz%A}VOtX9aMRHwimu{eO(r2m zW5y?xD6wbQVBVj};q<%LBh#%fF8F%$!4vhqlue6nQ!3-0pEv~4OjFLd$BY=9ntyS? zm!A}VZty{IZ)`p;k^A{-3PiUwiZ{km%W-c%^m)>vH+nG)i99#xQPH$18Z@@p`}>U| z$X=0Kd6H-y$pti`rWK=0Z5nHm^xpo%RY$N03YsDC?B*hI{e2+!u1yrn#D*0akMqv# z+Y!Yo1JK}Z;KW%AerpC*!?9Dw5i~9|qfo>BkJIr~zU_f-9f zemxIe-rNOvQ9tP@61XX@&f(mKzaH?U-@>(@hVZPv>3Mzqme|??&#)9D`F@GHA_7to3qn+cCE&IDLOxvAA#Y7-ss{l0BO&3Uc4F|TKLzy8~ zpKzCcNyz{T@RMxms<)rUtsS48649q+G=IIaQZ5crH$179t*`M}jV?K-{cnJW?7}&R-SZ@g%MGvm9roUn zSYPzeavrjbO4XV*yr`IFoK`c3m|sYl>vhcQI~q@E>mb6~lPxt5&x+iigQ+bYNIMY} zxs{6d_m97Yk*D5Ta72?dD}J(`NG+0Nx|pqa=wDfs_($M+Yn$x9E!^fpzhMd6R$Wd3 zRjL^m@15?FQPg~x7c$`YlNVeI8M!kC)U_Y_?F8(D}@>z~w1CJbHOsPfOBrC5P2zcOm~n zlvV!cIv|KDnq^zfsNS+AS3x3ARm-2IgAK^Pwb?VA^u8!B2hCWe=6u;$h#lIkD*}ZE zS)m&4sMPofmbS$#rvbp%3kYR*#wmN;-Czp=1Y@v?8_w#)g?hJq2}?A!NuMG!#TWbJ zEnySYg6Pj@EsD{W=1(6-!j)cMP&YlXM!$4ZbYGU4a-mO=+ZOJRC7B9#LqsFXM;DZl zFP<7j!kNAPQo11KI;j@)p#j!GnG!tG1|dw+WdEzh!sIss!Qb(k@-#%0FhbQl~)-? zd|ZsWSw*-YZH>(4qZU>%Sn`v(z^B;D|o7Zs<(HfN`^D4{CBVFC;L+Z%{6nd2NE( z>1-ZPCOcr`%)I*UDbakrM8wNXWKJz6Er_nsfj&)(w&hAl8a*Q^x{xk&R`AUDAW7TW5)HT}=lQ*)G z3oX`Y^p=InjzBHSd`znkM)p7$UrB@_jhW#a&*J9EOr zy-?B)&Eyt7DsP-r6WN5jSxVvMN>;_Y(DDYrn=U+KeTB}nc0<;&BF5hUhKe;P^Z*?D zdhz?anKV4fcK9KiD_Ym9@86z^X7tnLDR`MjA7Y{r)NKmsquo^6RYq)<85!V01~nsMUJfHrqmM&_2tvL1?sqn=p4@Oy|0X z+q``7xmbep#fQ#NMCTF;`o(3_4J~-B9REAtFoUPKqS_Ou4)<)Ez<&76RNc&;Rb^Kj zUq1zNTVFUwF1Uw3wRhB5NYpWTy!qe{*~5hkR4BUZ=Fozbf$6prn*Vw{|2OFa4SK^D z8EBMe2_{|;`B%waPI{qhfSqj#dRhZ>qd{O38WsJ@FeVS%zRictUYLDPEoKbuQQTSR zN=LcY7CIMV#M6hD+;DEe_wQbk+dCOqEVYCSBD;E{qd%Znp3i#MV;ryNbALZgTh;WF zLtv{Kadj)h2-oXrqa;Ww@^GleVNU5d1@gPIyX7ztoo7S#S-+lcK|VPl3aPQ_+0JQY z*e*5A7K*NJQOvyll*2Lzm)2jWf~REk!GGAq<+K;Bi-M9L0WfWazcp}bF>~WZi zCG#L}H}rk_%OP!;f9DnT$?_ znt#)F>jCOuG&{_Nn8HXdjAzZgL^koByskRbB)`^9yu4N$|>yU8+m+<@`fDm ziExio(jRstAxZd+|dDYuuRf>xGc%y;f9>{pju+h`oXO|K3FLJldW|z_V>2#XegwI`uHIb<*7;nf&>z-5_Gn2A|@60#UAKDKV07^4m`wZH2T0hj0X9{$qa`ndHl%JFGA3IH^T4JoG#e&@SLWl7z0Z{5D z#e%U~!WWllKPV+d^AwW@$IP{og6pq7&Zc3rv4$sQQ!k=CyMmFn>V;paBoi1)-z$SA zyD{o>>bflnppwsYX9`ockc2jYCZrD{?Dj%e@myF0PW#i{QU}_K@jgr1K|Q0+OTmUi zC!0A-C9eGTF(rv;&#pM+mih0FYOG0En@a2V`5qbXg`GPOrE2ar=@zbXC)ly`$uI&x z>beI5YBGpA&X!%~dxUj)y=TxXCIu4H_rSHrhO<~vOT7IpIXWOY734{B0k!j%z^WVq zm!J_-q9XjqQn2T6?dL{huzFJE{_^I@K}l4R0aJSY-{?;RrpA{?WM4evl|q+ zTX4{Qm|)0u9{*or#r3vfiz;@*S+SUCk*Ygkxie&4{wZJ0kmU>s76s0_a+~J^K9zO9 zj*Z2Zzp{r|$Gmh40HQWy?6k$_y~DCbjqjPMXxyL3cMG}I6?8|v(Ux6hHu+`gpUbyT z5bBK&S-M-SmQat1C>+Kb7A7o!lhyC(i(mtzUwA0yj}x*)MV;hIMn?9ABtn{FTXS&X4;LULZ*Ezn;Q8%lt{ z>NY|tO^al8Hb$0c&52rAai9oKoD_V3!`At`SmxrSfa6@f*YW3YJOuFlYN&q5n?PFX zpT4zz@oD-T;ypPS-7*OZ78S*k>plJ( zG{30w;%((!LYmlrrWXY6Pm>_3l~pkvXx;N9B&uNUam?5Q+a!BBKGFpj&2eFUd%JS0T+Cp0`XLhQ^gy9RSaxQEf_zmFwsCFqY%`Xo~xT`5eL+&#HAPtxs z$A7^5s1iy3$bIsx@%}`yAu!+o$M#>?gN|^UqncT72s7mAAMO%VV0N3sol{gNE;Dht zT=cfIQB{L+edHMtE?vKow(W%t>w(Q7Gv1n9cS38+Mm5uP$O_;!zG%p7pXD5>O0fFk zyv9)yoafyMmHu<|v%pq?z`(n7u>Qk zWWgXh%!@Sy-Uo-SFw!%eKl)}W72DBs=Z2Hunsxfx-RUp|piU+KWCXrV(Ax-Vaz=a3 z_kHd-KW4}8kjYA=3&neln`rfcmY&{Ox*5y606Bi=(j|iA?ks#f%ulOy{)(6W!1v~D z7O6U$5LrtgQdwxXBur@V3(X@N(ZYZ8>eQ>gf}Bk6CUZ6_QLa-UF?XZ8xv4Z>*W=N@ zH}?HBS6{js%@5hKdm15UD?$t0CmgHvK*X*HwdbFk{3(LIEhPO;-De6+bm?+H5*_Rt zFAW(BXvJ1>ruQ6##@P7|ml&zWpjtZs@9Izv1dZbBI0|Q>0K!ncz$aSADkv?Fs+~z! zZNJ=7c#SohfUo0y_3fqdA2jHif8hm*-VPJOTdm-!n>)qtkmCbt6&S}dGiB|x?%B8r z!%l2Th_3Xr3@vYV)YIx=*6;8|a}=js_-+;V_m|#x5)2_OT|d2%4l0?v=NYOR7-^x# zWun{mH0`jV@C#9N3$@_G2ND4Yvj;j&RzAm5-?L**KMm(4e>%Q>QQhoHJU+i0Zuhe7 zLk)kvyg%923=`F`yJIkN;yLjy0Z7>|%|=mzbCwsQA-Y!>93DbLYyM#dGPYB2uk z&VQ+)vb4Zw83}0DJr#a!(CQ!brlOD5LGrCM|1S;e^vQ1E1H8MgB5P%R$A7*$7#ir! zp1&CL|IQFISJ^iG-dgPAUlR$Y`UJ30>G1U}r%$dl?<2mv`k+hV7tqy7BKPvHoVVu5 z^}#Amp1^C@620K)>Ta4bz#pL}lVR^%wd6UDg)TqYGWuOg8@iP{6Wl*1_Kf}z1N!6k zIfIk9bV@tFi@E>jos*kKq7FZW;%t((T8(xE-aq?%P%m_{3{AEBHK*l@%-y4?OEdBw zK^&o_r8mGL8=5!kJV>KnL>-%ns@rG2o zhjhooP$S2o#u?kKTqoJEZxl{A^(Wcd^^A5%2p_+CG`S4g>}7+q@Ko?FmnWDh;lm}< z-ey*Y?)a1S1ZF?Fr<437T41Ckr;57X=O^_{c0A<#lQGoFXttjVoAvHI@R@4&uM02t z1FquQxT=2%UYEB8{W$=B8RPZz|MZX5{$wP+g%KR#d&(j)EB_Z8XfylC{SK)O$IX|g zALb$%HFuRUCM%1{YVr_ikFpruUy~raiU0dAvo9E10{2fYu#<&ws)FIlG#F|XAv}eZ zijXpInz}?Hh@5;(wDS;HP=r(negO(Byu>er5V!*$)aY7(uH92gt<2gfK~bSsA~zgD z&rk}Nz`zoGhGM%~4cN=ORNT+guACNQ{6L~{OYfTI6OYi%XMB-LI+I1h7X*3Rnz>iF z^4;+^q^Xy=0{_gzfXF~(>wID^c(|d78SOb#<>6PEce*KS_5lOBa`KqAGOpcJe3>;= zB{DW3sD$jrB4e?NA~A2UR;EvUDlPO+&TVkD3|LGsgRAI+6GQ`hnK>%Fpjh|3#v1pf zJmj5t#bSVk{)^LyM0FFa_08}|Ol{y{=J=_}+bC;c_qgI5lr^I2_Am}c%^&g}b3fSm zQ&H(XT_)PrN(@I3ja~6WlF0{GOY-PFiM7Zel8BcKcOrcV5$~9P(xKaz~mNhVmSxZVEJXzkkF$Syc`ERNn&X8Ky8e(hJy(kU zeuQ0fzYLQOT{gdBX1%EL#bRRU(qvZwwF*{bpWU;x>x~o)<#I1LJ1{D3poD4YrY>yv z+#X^3(i^Vzt>_wF0F~JaGUy8=MAN?~o`!~^PDQ`;J`86^CHl8JDkbmO2cYK1nMtPC zDQA5HLG$mN9Z}^J^DRA}5%*6Whkgn{B-XnkLdk9TQOGVYNPTZlzTQ4NazlaI@Z0_$ zkgJTB4A1RR$T;n`IMZs7D2n+bb8U@N$QblmVDzal+mdkq1$~ZL4RmJ9UJnuE7inU0e3gCt|1zP_{VD%1{Jp0o|p3 zL%8=-!AtqhExmC*T)*Xfdg$NekcJwXEA9GWssY>Y_Fb8lXB4VX)dyxiz&Z%ASuER-cLVE^1QP%uFdwr~9ou$G*|-Wquj`&PIH} zO6&#A#$QrfKIXnuBPGA@U6x(j1QoRiL(gFZy>tWRn$l-j+xThId$Njir8vYh7W(zZ z>RG)QI7#=L=Oj<^_huMqDToC!liF*P6oO{BKmQ)?H~i*x)CtCnU)4Z^oj?gdeY6Ve$D_k6s4v<#&*-hiqqC*MUydUtJpU`ykO^OKf zoAU4%p6Dbv6yvBrgh*Fe?^IVfVC$4@w7>Y*vz@&0M_=HM_(p1-OgC=ZcROo^JI?U7 z{>)5eDB+*^Pnp7qB-YpT&z}_K#2@%RTD~q)d!|hL50qux7w@evUvA~?(lHq0imI|A zk!{Jo^+oD-E5+<|bXP`H{Fm`C@+HD#K^zZtg=8^wi$?d%pnsI&`q#b>;nEH^c)~WS zMii|P0GBS( zOtH?SrbTF_kM0XPq=~+Q-6z+rrbEA03ILA7`3?$QAO7(!?t4Rxa}Fl5xe$h!%}G5q zk$RDD!?5$ydObB_hb-a28$+%XNuozS_tQzrrtd{n8yJ!eK0E%ouiY}TmNXaI&l6gn zL3D#nmDc^HGs1A7k;R z!OjYU2?+RL^SlkTQsWxJRi{tlTaMlftx>}+@8d8E*pK4rRH&d}aOVg+f0GPJ+9uZ8 zb*g#u&#;6dG=Ybi^0iXz7mlwRsr!kB5#BGR-#t)c^z7^G>w2_8KjeIygX^9!*>_LA z(ezQ}CWq$vt=-jFLk<+IyLr-`?X4%S58Dyej71f<3tXl@j21>Id^L4ue2q+rQ2ROH zuD!)3viImj)b!Ebh+O~ORzHs$x%A0ogY@V>Qs_0fww@Vw2t-yveZ_r)jV}Wo|CuP1 z?e*nQn5#o-X!U(d!`eR3ZG&8FHTBuif%H-z;zXO7hy-TTHHE&DA%1_6rp;aorh zWk3RlJUEl3)`j^MY~qRYLa^jK!UoEsrs-XL>2u8DCUuJA?+*FU+@Fpf*K92*cbwF=^mk}ruCn7vPShvAIGg>wa@QAx`l-H- zM!aWWc#Qma^2F=C;GLP0^-Z;KYQ0zp--K;mcsZgbYlk>_y(EwuHTb^ncR^Q`dqY8P zt)WkM{U>45YOq6>Os`1uml524)L zy2D7-`Vb-PP%{28p?rN5?VGkad3U+mEtr>U7aEhce^|?IfV|R4nTi4ub7bI?ExlT$ za!o4FOJkiW|0~Y=0#sL%bs35(Pa|zzZ<+VZJE%E_&b2|8%d8&|tk66xJJxWrPgUYj zDj@e7Y`DkUsanri&tqmbUd6(CEAz$cb4-np#hzcy*~GJupY(?T^J#v~f6s(<_Z_7# zR#s@)mnHrU=J8m5uI4OweY-C7n}k`|Pu;(2Vyxqc!b(d=_0lF?b8Zv=?{*59=SeVc zC#yFuj`8rQAU9*kDJK8SUP{d)t0MQ5s4C$nNZ?19{5<2PX=B+d#tqq+#ZQTSty<1o zsdE90KDfEWhxXA@iCl+}P>s@j-Q(3BAG;NW@|fjWxU0r25QDF#apcyE`@H^oHG_>F zK6{Hk!GCmI^H}WZz1fvKJ)K`J>@IwLT#=P&T+!&?2)QpYEp?9e?R}@ZS7Pw69HZn~ zT;~~|CEfTt0b`|H%IA+IT-+MtQx^&@fcy^!l>xCyme$IU$HnT%%a0#n-=QayS}n{D z)T8v>;&x&Xc@_a=mMh%L^o!B-<7eO#%Ni}e(yxoH@~xl6i-YY+M9*(NmC)LL5Rs=c z^-$a~eqY&q^<|yDc%b<6hZ9DO{`xCK&n2Jz`xmXw*htcVxpvnRN;huF!nfmyMZc(;44Tg-$m=TD6v4*N0ID@VEc zufomOx%AO$U)BmlFHJrrkD9;Q=4QFO#mrUWg>emib@4v;CxVN!uLI1&U9Ml-7?Ud^ z!p+&IaNVk;7xIRUt8()R{ZlvO1+gjHyR&aG?LQR((e2W(x~M0*H<6rX1tu=v0Bbe}hV|JPb5N&hSi;9M3a^+$s(&GubRHoe zK-X!`VNajrVpQ2J36IwZIm{0w&w8QxtyQr1UV59`r%BrSw- zUN3DMcd)%WC+TQSnzH2l+Cvh2LLzk;hy7^(sf*Sp)A)2t(Cu`U?#kz%_5}L<#h>M+ z{SxYaWdfW@h#~E})d~_t4;=}Qp}hAdZ%vpu3|_yHrf2p5YnE0uY@P&xk)O~*R<-QWVf1hET;pMrr;k}9R{ECRP1nf)e8x#KT1M;eQhzpLvvaMR`CA2FTHM*Zh(9rh z9;RyLbVP8+xhrHAj3L0K@Ciaq5qArVw@yof)6?NMv}Zwew=45$8V}N4g4rU=Y!P16 z^i?6H@8WKV_O@n=##rrH!m=dDw7pI-f%_)ICKYzMkzZ^{Xe=)XzxQcW*gPUMo|W?Q zA-y*ZF1;5`M4PuX=deZ^`26HHPM5uV3gT`|*1`c~eJzzAwTtSOn$_+u@vFITl_E5m zXkc%3iqNdH0!y++RCrk{PRo;~x^%7;?=XD(l=Jf4#VwtR%Q#QVt(EU_RjhJV+_bPw zLCe+<;#ou20j)_LF8my;>0_YwY*K3)M4T#eOs9A%{+6w|%6GQ>%>*x~9>c`_HqUaw za~o3?1q522Yb#Fg`|*IXw@dc3GlSDMqv=ZnGon2%`4gTy(bP_ zE!eZJQ4669rW&6deT($J4e`DlC$R#LPChv9sv!7Ie3dYz0>?`fHDNFsjJ+b;T#>ET z5O_5i+`V90(z}bDvdBAt#{RV^?xYmehX4X`?BoE5UxQ4-(2mO{@CH|J~r0q9MG|Kt{ zL{W5{O(&b%4|f{7#81?+*NK*g%d3A6emt~f)Kpk;AJ$7*Jj(;fs;MNCwg=1(e$coa z$~?3Li)gtFd_Bo(-_8Tv1YZ6lJiJu%w)+(z`kRCONH2OY8=DGv^~c;O_1}jGaRyZ%G*epKNIx05bJcWhG?DDmE9O}kqi!M|6ZzB+Vvz9nU4C$!T}cSYlo+3eZZEjy z*8@sN)70=?5ew?T*b9y)mk})unlgamQYV(I-4m8KM0czl4WtTd)3@LPJs=>m1pYRR zh2;rDE(#=E&&m(xj>|nV#H~6*dLjb&Rlx>H^~Q35!pz|2WrTDp-sz^g+=^cc90rJ) zF4l=GMPYe>>;|HXh3!3PY9OIwCvFPPxPNtEBV*_YF2<;OcIC+ozidw*ai)m0~HIfSgGQ#aIJ@R-?NU3J{z&Yswhg-z0 znG}pDS%Q)3mEz#_Gh6g!uEne1nNZHA2K`GwE#{d5^dHbB(Xm&jz~{C5VjzTvSNecl zshZ;6QFOUKwJLbK2;7|mh0D+$7e-y_FHynrq#+kaI-= z6qB_Z$vG(8FTYg}>GLka^mQwLcK9LX_ zX;UIgSl%C1@UOc^VL0KY69PJRBT@j4hW?n-rW^1R!)qjguDHY$id!K%Oh~8#Lw8Xe zYYiW#sJTEa=`_H!nQN^<9TPEI?jgdvp%RwOeAOGoF!1AnB z!H=iP{lU8<+-nR4SH|aisrpOFzq>-zz|r_*hj`b-U*Urv*l~f3|I7a)|C+cFfKBL0 zKnL~ujW3UYDp(zcCje+|@2;D=#IVpo?RW7zUaDZy2f#TvgXL)UmA8??@X} zV@(`I2&fG=%06B^S^0368?=EZ>uXaD(Z4i0-$fG!KQinqM*;t1fJ(scQSfM0NE9An zdz6?CdPQWZZ4sPy|5yNDgF^FhI_N)q#e$hw06k?S0A?g7X4_YO4S4r*`~doZ$NpFh zTJvFVm;ywgLT7YPPur&!r zQtLbYHkz~#SmQW=&oEO@PLR^RrmRL=5k^KhnO&(kIUWqjnxpU>$}ky=1)Dl13z?BB_>+zc*#z*=bRm1J2L7}KOuf~>QngbbUVPvJ#qc!| znR0_-c$$b{+#oWpCL-P04xmvfkWs}Hc;q-bLNqdQCO+Sb+4#ZPn^H1Iv zWG&En9AvP|6FHF6ciaIvNMPaLlfJPX!O{ICz!Io&!5W626aO9qO+|US`njxgN@xNA0~OEV literal 0 HcmV?d00001 diff --git a/exampleSite/content/shortcodes/resources/index.en.md b/exampleSite/content/shortcodes/resources/index.en.md new file mode 100644 index 00000000000..a5548f27c4f --- /dev/null +++ b/exampleSite/content/shortcodes/resources/index.en.md @@ -0,0 +1,78 @@ ++++ +description = "List resources contained in a page bundle" +title = "Resources" +[[resources]] + name = 'MaybeTreasure.txt' + src = 'MaybeTreasure.en.txt' ++++ + +The `resources` shortcode displays the [titles](https://gohugo.io/methods/resource/title/) of resources contained in a [page bundle](https://gohugo.io/content-management/page-bundles/). + +{{% resources sort="asc" /%}} + +## Usage + +While the examples are using shortcodes with named parameter you are free to also call this shortcode from your own partials. + +{{< tabs groupid="shortcode-parameter">}} +{{% tab title="shortcode" %}} + +````go +{{%/* resources sort="asc" /*/%}} +```` + +{{% /tab %}} +{{% tab title="partial" %}} + +````go +{{ partial "shortcodes/resources.html" (dict + "page" . + "sort" "asc" +)}} +```` + +{{% /tab %}} +{{< /tabs >}} + +Multilanguage features are not supported directly by the shortcode but rely on Hugo's handling for resource translations applied when the theme iterates over all available resources. + +### Parameter + +| Name | Default | Notes | +|-------------|-----------------|-------------| +| **style** | `transparent` | The style scheme used for the box.

- by severity: `info`, `note`, `tip`, `warning`
- by brand color: `primary`, `secondary`, `accent`
- by color: `blue`, `green`, `grey`, `orange`, `red`
- by special color: `default`, `transparent`, `code` | +| **color** | see notes | The [CSS color value](https://developer.mozilla.org/en-US/docs/Web/CSS/color_value) to be used. If not set, the chosen color depends on the **style**. Any given value will overwrite the default.

- for severity styles: a nice matching color for the severity
- for all other styles: the corresponding color | +| **title** | see notes | Arbitrary text for the box title. Depending on the **style** there may be a default title. Any given value will overwrite the default.

- for severity styles: the matching title for the severity
- for all other styles: `Resources`

If you want no title for a severity style, you have to set this parameter to `" "` (a non empty string filled with spaces) | +| **icon** | see notes | [Font Awesome icon name](shortcodes/icon#finding-an-icon) set to the left of the title. Depending on the **style** there may be a default icon. Any given value will overwrite the default.

- for severity styles: a nice matching icon for the severity
- for all other styles: `paperclip`

If you want no icon, you have to set this parameter to `" "` (a non empty d with spaces) | +| **sort** | `asc` | Sorting the output in `asc`ending or `desc`ending order. | +| **pattern** | `.*` | A [regular expressions](https://en.wikipedia.org/wiki/Regular_expression), used to filter the resources [by name](https://gohugo.io/methods/resource/name/). For example:

- to match a file suffix of 'jpg', use `.*\.jpg` (not `*.\.jpg`)
- to match file names ending in `jpg` or `png`, use `.*\.(jpg\|png)` | + +## Examples + +### Custom Title, List of Resources Ending in png, jpg or gif + +````go +{{%/* resources title="Related **files**" pattern=".*\.(png|jpg|gif)" /*/%}} +```` + +{{% resources title="Related **files**" pattern=".*\.(png|jpg|gif)" /%}} + +### Info Styled Box, Descending Sort Order + +````go +{{%/* resources style="info" sort="desc" /*/%}} +```` + +{{% resources style="info" sort="desc" /%}} + +### With User-Defined Color and Font Awesome Brand Icon + +````go +{{%/* resources color="fuchsia" icon="fab fa-hackerrank" /*/%}} +```` + +{{% resources color="fuchsia" icon="fab fa-hackerrank" /%}} + +### Style, Color, Title and Icons + +For further examples for **style**, **color**, **title** and **icon**, see the [`notice` shortcode](shortcodes/notice) documentation. The parameter are working the same way for both shortcodes, besides having different defaults. diff --git a/exampleSite/content/shortcodes/resources/index.pir.md b/exampleSite/content/shortcodes/resources/index.pir.md new file mode 100644 index 00000000000..bf7ca78a0a7 --- /dev/null +++ b/exampleSite/content/shortcodes/resources/index.pir.md @@ -0,0 +1,10 @@ ++++ +descrption = "List Rrresources shorrrtcode contained in a plank bundle" +title = "Resources" +[[resources]] + name = 'MaybeTreasure.txt' + src = 'MaybeTreasure.pir.txt' ++++ +{{% resources /%}} + +{{< piratify >}} \ No newline at end of file diff --git a/layouts/partials/shortcodes/attachments.html b/layouts/partials/shortcodes/attachments.html index fe8e12526de..fac88b5f19e 100644 --- a/layouts/partials/shortcodes/attachments.html +++ b/layouts/partials/shortcodes/attachments.html @@ -3,6 +3,7 @@ {{- $page = .context }} {{- warnf "%q: DEPRECATED parameter 'context' for shortcode 'attachments' found, use 'page' instead; see https://mcshelby.github.io/hugo-theme-relearn/basics/migration#5180" $page.File.Filename }} {{- end }} +{{ warnf "%q: DEPRECATED shortcode `attachments` found, use `resources` instead; see https://mcshelby.github.io/hugo-theme-relearn/shortcodes/attachments#migration" $page.File.Filename }} {{- $color := .color | default "" }} {{- $content := .content }} {{- $style := .style | default "default" }} diff --git a/layouts/partials/shortcodes/resources.html b/layouts/partials/shortcodes/resources.html new file mode 100644 index 00000000000..8f80a00ca89 --- /dev/null +++ b/layouts/partials/shortcodes/resources.html @@ -0,0 +1,60 @@ +{{- $page := .page }} +{{- if and (not $page) .context }} + {{- $page = .context }} + {{- warnf "%q: DEPRECATED parameter 'context' for shortcode 'resources' found, use 'page' instead; see https://mcshelby.github.io/hugo-theme-relearn/basics/migration#5180" $page.File.Filename }} +{{- end }} +{{- $color := .color | default "" }} +{{- $content := .content }} +{{- $style := .style | default "default" }} +{{- if and (not $color) (eq (len $color) 0) }} + {{- $style = .style | default "transparent" }} +{{- end }} +{{- $title := .title }} +{{- if not $title }} + {{- if eq $style "info" }}{{ $title = $style | T }}{{ end }} + {{- if eq $style "warning" }}{{ $title = $style | T }}{{ end }} + {{- if eq $style "note" }}{{ $title = $style | T }}{{ end }} + {{- if eq $style "tip" }}{{ $title = $style | T }}{{ end }} +{{- end }} +{{- $title = trim ($title | default ("Attachments-label" | T)) " " }} +{{- $icon := .icon | default "" }} +{{- if and (not $icon) (eq (len $icon) 0) }} + {{- $icon = "paperclip" }} + {{- if eq $style "info" }}{{ $icon = default "info-circle" }}{{ end }} + {{- if eq $style "warning" }}{{ $icon = default "exclamation-triangle" }}{{ end }} + {{- if eq $style "note" }}{{ $icon = default "exclamation-circle" }}{{ end }} + {{- if eq $style "tip" }}{{ $icon = default "lightbulb" }}{{ end }} +{{- end }} +{{- $icon = trim $icon " " }} +{{- if and $icon (not (findRE ".*?\\bfa-\\w.*?" $icon)) }} + {{- $icon = printf "fa-fw fas fa-%s" $icon }} +{{- end }} +{{- $sort := .sort | default "asc" }} +{{- $pattern := .pattern | default "" }} +{{- with $page }} +{{- if eq .BundleType "" }} + {{- warnf "%q: UNSUPPORTED usage of 'resources' shortcode found, use a page bundle instead" $page.File.Filename }} +{{- end }} +
+
{{ if $icon }}{{ end }}{{ if and $icon $title }} {{ end }}{{ $title | .RenderString }}
+
    +{{- range sort .Resources "Name" $sort }} + {{- if findRE $pattern .Name }} + {{- $size := len .Content }} + {{- $unit := "Byte-symbol" }} + {{- if ge $size 1024 }} + {{- $size = div $size 1024 }} + {{- $unit = "Kilobyte-symbol" }} + {{- end }} + {{- if ge $size 1024 }} + {{- $size = div $size 1024 }} + {{- $unit = "Megabyte-symbol" }} + {{- end }} + {{- $unitsymbol := $unit | T }} +
  • {{.Name}} ({{$size}} {{$unitsymbol}})
    • + {{- end }} +{{- end }} +
+ {{- $content }} +
+{{- end }} \ No newline at end of file diff --git a/layouts/shortcodes/resources.html b/layouts/shortcodes/resources.html new file mode 100644 index 00000000000..09f71ab518d --- /dev/null +++ b/layouts/shortcodes/resources.html @@ -0,0 +1,11 @@ +{{- $_hugo_config := `{ "version": 1 }` }} +{{- partial "shortcodes/resources.html" (dict + "page" .Page + "color" (.Get "color") + "content" .Inner + "icon" (.Get "icon") + "pattern" (.Get "pattern") + "style" (.Get "style") + "sort" (.Get "sort") + "title" (.Get "title") +) }} \ No newline at end of file diff --git a/static/css/theme-neon.css b/static/css/theme-neon.css index 469c76daea2..2ede784d8e4 100644 --- a/static/css/theme-neon.css +++ b/static/css/theme-neon.css @@ -51,7 +51,7 @@ --BOX-BG-color: rgba( 8, 8, 8, 1 ); /* background color of colored boxes */ --BOX-TEXT-color: initial; /* text color of colored box content */ - /* optional base colors for colored boxes as in attachments, badges, buttons and notice shortcode */ + /* optional base colors for colored boxes as in badges, buttons, notice, etc. shortcode */ --BOX-BLUE-color: rgba( 48, 117, 229, 1 ); /* background color of blue boxes */ --BOX-BLUE-TEXT-color: var( --BOX-BLUE-color ); /* text color of blue boxes */ --BOX-GREEN-color: rgba( 42, 178, 24, 1 ); /* background color of green boxes */ diff --git a/static/css/theme.css b/static/css/theme.css index 77b32dfb776..2cc27147b61 100644 --- a/static/css/theme.css +++ b/static/css/theme.css @@ -667,7 +667,7 @@ p:empty { margin-bottom: 0; } -/* attachments shortcode */ +/* resources shortcode */ div.attachments .box-content { display: block;