From 8207c90e5e547bf8d9cc8254535fbef1fbfb03ac Mon Sep 17 00:00:00 2001 From: Rumperuu Date: Sat, 20 Feb 2021 19:18:41 +0000 Subject: [PATCH 1/5] Create README.md --- README.md | 37 +++++++++++++++++++++++++++++++++++++ 1 file changed, 37 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..6a3e29e --- /dev/null +++ b/README.md @@ -0,0 +1,37 @@ +# footnotes + +## Description + +Featured on [wpmudev](http://premium.wpmudev.org/blog/12-surprisingly-useful-wordpress-plugins-you-dont-know-about/) --- cheers for the review, folks! + +**footnotes** aims to be the all-in-one solution for displaying an automatically generated list of references on your Page or Post. The Plugin ships with a set of current defaults but also empowers you to control how your footnotes are being displayed. + +**footnotes** gives you the ability to display well-formatted footnotes on your WordPress Pages and Posts—those footnotes we know from offline publishing. + +## Main Features + +- Fully customizable **footnotes** start and end shortcodes; +- Styled tooltips supporting hyperlinks display **footnotes** or a dedicated text; +- Responsive *Reference Container* at the end or positioned by shortcode; +- Display the **footnotes** *Reference Container* inside a Widget; +- Wide choice of numbering styles; +- Freely configurable and optional backlink symbol; +- Configure the **footnotes’** appearance by dashboard settings and Custom CSS style rules; +- Button in both the Visual and the Text editor to add shortcodes around selection. + +## Example Usage + +These are a few examples of possible ways to delimit footnotes: + +1. Your awesome text((with an awesome footnote)) +2. Your awesome text[ref]with an awesome footnote[/ref] +3. Your awesome text``with an awesome footnote`` +4. Your awesome text`custom-shortcode`with an awesome footnote`custom-shortcode` + +## Where to get footnotes? + +The current version is available on the [WordPress.org Plugin Directory](https://wordpress.org/plugins/footnotes/). + +## Acknowledgements + +Huge thanks to every footnotes user, contributor, bug reporter, feature requester and fan! From 22282f9df16516e91022da7ad21ce227c3411fc2 Mon Sep 17 00:00:00 2001 From: Rumperuu Date: Sat, 20 Feb 2021 20:55:46 +0000 Subject: [PATCH 2/5] Add getting started instructions to README --- README.md | 15 +++++++++++++++ 1 file changed, 15 insertions(+) diff --git a/README.md b/README.md index 6a3e29e..d57f0f6 100644 --- a/README.md +++ b/README.md @@ -8,6 +8,21 @@ Featured on [wpmudev](http://premium.wpmudev.org/blog/12-surprisingly-useful-wor **footnotes** gives you the ability to display well-formatted footnotes on your WordPress Pages and Posts—those footnotes we know from offline publishing. +## Getting Started + +1. Read the contributing guidelines +1. Clone this repository (`git clone git@github.com:Rumperuu/footnotes.git`) +1. Install [Composer](https://getcomposer.org/download/), if you don't have it already +1. Install dependencies (`composer install`) +1. Create a new branch from `main` (`git checkout -b `) +1. When you're finished, commit your changes to the remote version of your branch + and submit a [pull request](https://github.com/Rumperuu/footnotes/pulls). + +## Updating Documentation + +1. Install [phpDocumentor](https://phpdoc.org/) +1. Run it (`phpDocumentor -d . -t docs`) + ## Main Features - Fully customizable **footnotes** start and end shortcodes; From 4363f68d43c71f6d9fa8eb0d354e44d29d08eccf Mon Sep 17 00:00:00 2001 From: Rumperuu Date: Sun, 21 Feb 2021 11:07:48 +0000 Subject: [PATCH 3/5] Add footnotes header image --- img/footnotes.png | Bin 0 -> 4964 bytes 1 file changed, 0 insertions(+), 0 deletions(-) create mode 100644 img/footnotes.png diff --git a/img/footnotes.png b/img/footnotes.png new file mode 100644 index 0000000000000000000000000000000000000000..a4d82f6c4b6b704625dbf3ee328e81bd0cc2e38b GIT binary patch literal 4964 zcmbVPdpy(s_g{%ViAu~}pGA@DHq2!%xtH8;V`7<^8D`9ciRdETmdbK#Mm54*r^ux! zS+0pLNGfxgB9d!vzo}23-|vs_Nf1I87c|Fhdbd8)8Up|V zL3npBvX_HB977~%p*JyFF@$iwHUMCJI3^s83Bi&<{#YD7%tUdz?ujA@A7G;B33Grr zgj-^R@JA^mtQ*DA9YYDh7zQXFHU$~S!1)FUSTY(ELkJCvgvXdD{;~__^P6I@BIp-{ z9AcvQJ18#)XOJb4gayI0AetD69u%afs|D4C80s2ofV3e{2pFmjhUjZTA#j*J90CRX z^Hbz|BLxJ)U9D{X@x^~KQ4AuJ!{K0Xbab>4M z$7qH{D*drwg^k3J@Zn@UF$}b65$#WmBAY1kBmJEMA>6^?U&CRM{}hT}GH?t!91PWh zfC+@nyndl0$*$P{4dXweBi&=ev0zthBr%GF;qOPF(jR4h?f$!?O&~uSxDyG_-xPGH z6%i9fz=n}+txOd8D_Q~g0Jx30z6}(ruM5%FhUghUq2}7=*4FxZRyq)vjirvY^&cDm zNmtL%+(OsNT*nFq(}qH=bu9D^&CP9ebf6a2Py-z(?2oQ(SR@%8hQa>vi|70OM_2p5 z>cTBaSTvbPawif)|8#(J5Rpub3?hbuEZtyQP>=%}gAd!3Y;Mr+e66q~{7Gzp4T(qq z{i-k={~scNKnx)NJ@enX0so(>f%(CJH{0X?w96k6zXvzjf198G@bCCw!}v2p;t$8} zM;QKG?Y?1aW$qp`FiAHdac#tt<2VxP+;Dq>Jj<+w#8Ia5-cQiZP7CuJLfHzqr zDQ&l7I!eNmm}=w7PJXl7ej0pS$S6T3ZZlh*15CS}ue^2Z=t(X;wr=}rA_|52i|?Yl zLy&(Y004o4d~&<>eU;S5wdHohX~RJxdrfk(8cMvI_AzdV_h4ZJ^lj^>+msD3}kmpf}(^ z<|k1+CDSm zyVW{4CZ|;#XzVesvsZQ=o)=4Za;zG9*h!yllnJPJ z>YHumTC%S95?+_4Hy{tQfaMo*Wi;;y5PA7)2jV@+Y1;iF<8 z#I$t&$Q+eRRbSW0e!2boK$Iv$pyBnA#_#r4<7+u5$_6yV6F%fiMXQ0 zn4Vke+-t)RVm;bH-F7AC#~y4JPu_jrKCF*rUBbRtU@RC*0`E><|e4Cf##GJ+L3$nJe|i=Ag>LHF7|IQA_Ju zS1S(LDMF{NKW4^rsb>x86&j_lSjk;}rzB|sy`iy+HPKcQAjBJumlBCp?Y~@g`>Ro6@s}RpMf=^7{!X(uJzjA4Qmzy%*{^fM zkSe(sC0Z`zQ^V~IK#=?&c{q#V9E>Z~YE+S`i>hz+imDYR;C)ZX zwZ;4Adeks*A4av3f*rPCHnV!>2B)TKB49$o2bJYvRkr)D;Lp>0r6R_p9_M}+h^6NZFSj)}8qM;00oLRW}&x=;fQ^?$7 zJU5nujyP@B_4DHKTM%^~ld=`A0X(b*ZhWEY=m=EHs#ANGwaYF$-873i)c5T>prAw!|DEQ24_=HzWw_V7O zs}nyFIiosVnJ;}EeNmr~V;i^kwpX0dbeF!coFGPv zfzO`b`<;w66H0jitMzy9wu=``L~|<;EHP0k*`Wf1;FgM9((4S)auHqf`EI`_u|Qfn8aUYI<`hWNTZ>Azmzt;CRJ%3ngip;ca5@ z7TU_*r{dn^Mp+3(43t%w9RnY|}tyvMWF6jq=j`IprPwNhj{F3Mjlny6973BU7x}ed>*U-S?%8 zDv0pZmnFPgj_4~BCJLnu+8Nm<8_!p;pWT{bUsc8g%*Nx=UB1t$B1F&jMdzk}$t2%* z(=6JtGBS3YQ)Ta%@SeC)9$`Ij*-4&V^!Uu}IRk_y@RTQ9ohK;h0EB<6l#%KEdGrF) z3h$#o7}3w^*Qm;TcYG@#F~LuHxbcT{izE7nJ7oPJag1o$bwNY1W8#}1A0hVD5^SW5 zz-rE8Eh*FPuUwyGF}d}EwFPkYP~}A`kiPkPuKrr79FS2dBdAJ$cdj~w(h%Sk`%aL( z6)<-`ZuW=rL*#+B4m&Lwt^RVwBA$U1|Ha=uuhmqUANIl0_4qij=W~E4#%Dn~Pj#>4 z_(^Yq0(;B~-V>werp~{}cQ*LC|F)E-5N-#&@>#xW z#k?jWu_6x%wtP{1@-4YWC%Jx4KiQixaisvo4Q>1)4MG5NrDjeXk&DQiJ%rL%@ozTG z^ysPh0)3HELaf+&Mf57A;^yeVkvGQ*u)5)3RCe!IPR4z`;s;BygGmb7UH_nXg7?JW z$@6kRsqu@n@1?&)LaVBT0u(tn~5EcMqnT@Kg6fx-JNw%`PpbMR>D~Wm*W{*(<`)@W_ zY_8K$_Anyjv+j2ThI#Uql@@QFQT3yT@pKw+rm!`GBRpn!1zHRcJIa{QczW$qbP3stDpmOdySI6xOu`}@QO4pLWT=f;QRB4;Epz+ zqy5j_ds{4wtKBC*Mf}2M&G{>n<0J=~?`j=rgAD4j6?fOR>{lp#(*7ap#G$>{8-l{` z)l>96x@bYI=_x?J(3rbYnTP+LtIvHV6L~EyzG0vZTAW9s-^*l41!AKw`9?P=)3=** z9I@iAkLH(5pHo720L;J+Uk{$FRqt$1vgG(&1FD6%ycS9000T2v`hgGfiB8dUHSw-v z8WDqT%R3cTBtm3k{MF}r@=+EXK-CxMNfM=KClW5$<%RdemPzSwib*F1SyP`ctHTFv z5*m$gMF9|HvKKDCG?&CbSNXdrezEs_vv6HJ=FUmmsGB+k%B4rd(jV4!h|s?osm*d^ z84~hvi{Lot+Ow}TINN}l5&Yu>2^5;y$75m}&dpH_A&7?z;_a}2; zO`0Kf!Nh}2uJ-G_8Sx<;bvMgj?nhkN#C$|GyKcHVN934#7W2NTR;&tfX@hfcFEsG` zg{Nz_?pJmOuRntNUVF3ahM~f(ay|L!-s{tj=j3=6;Q0ycbNc&Z&2i7)n>_J!b+Okg z^X&Q>El;G45uYr&p2~rh$mv}NZaDTYZSC^SLWH`A)8$@dr>CbAQKuHi!Lb{rVzjr} zLdVBm6wVALRpmb;pmKQSUDL|Zsk4i638zKHG3glkcR<^UarOpSe{GFhw$U)-wiJ1w zs9OIXBhler z`&0l0?+v!2Mw^#SgANbxBIam6Du_^fw|f<7d-ms1t9QnB%T%QyExUx4vwfa4t=)|G zNIY6i?P&zn>hR?+`}g|_o%g!-iHs;$;V}zKyTZn0M+C;n*6^@dBMDiVA9|f)<5ZZx z(R`10>w6?K3kWa;u(xXZsr)F+7-V~0)|{?HPyf0u@ Date: Sun, 21 Feb 2021 11:08:04 +0000 Subject: [PATCH 4/5] Add linting instructions and header image --- README.md | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/README.md b/README.md index d57f0f6..6bd1e8d 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,5 @@ +![footnotes](https://raw.githubusercontent.com/media-competence-institute/footnotes/main/img/footnotes.png) + # footnotes ## Description @@ -18,11 +20,21 @@ Featured on [wpmudev](http://premium.wpmudev.org/blog/12-surprisingly-useful-wor 1. When you're finished, commit your changes to the remote version of your branch and submit a [pull request](https://github.com/Rumperuu/footnotes/pulls). +## Checking WP Coding Standard Compliance + +1. Run PHP_CodeSniffer on the file(s) you want to check (`./vendor/bin/phpcs --standard="WordPress" --colors --encoding=utf-8 -n -p `) +1. (If applicable) run the PHP Code Beautifier and Formatter to attempt to automatically fix any errors (`./vendor/bin/phpcbf --standard="WordPress" --encoding=utf-8 -n -p `) + - You can run either across the entire project by adding the argument `--ignore=*/vendor/*` and targetting the file `*/**/*.php` + ## Updating Documentation 1. Install [phpDocumentor](https://phpdoc.org/) 1. Run it (`phpDocumentor -d . -t docs`) +## Testing + +Unit tests are TODO. + ## Main Features - Fully customizable **footnotes** start and end shortcodes; From a1aebed7f4075fdb012f383b792dc0f34bd92e13 Mon Sep 17 00:00:00 2001 From: Rumperuu Date: Sun, 21 Feb 2021 11:20:11 +0000 Subject: [PATCH 5/5] Add more PHPCS tips --- README.md | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 6bd1e8d..2ff05d5 100644 --- a/README.md +++ b/README.md @@ -23,8 +23,10 @@ Featured on [wpmudev](http://premium.wpmudev.org/blog/12-surprisingly-useful-wor ## Checking WP Coding Standard Compliance 1. Run PHP_CodeSniffer on the file(s) you want to check (`./vendor/bin/phpcs --standard="WordPress" --colors --encoding=utf-8 -n -p `) -1. (If applicable) run the PHP Code Beautifier and Formatter to attempt to automatically fix any errors (`./vendor/bin/phpcbf --standard="WordPress" --encoding=utf-8 -n -p `) - - You can run either across the entire project by adding the argument `--ignore=*/vendor/*` and targetting the file `*/**/*.php` +1. (If applicable) run the PHP Code Beautifier and Formatter to attempt to automatically fix any errors (`./vendor/bin/phpcbf --standard="WordPress" --encoding=utf-8 -p `) + - Add the `-n` flag to ignore warnings (i.e., show only errors) + - Add the `-s` flag to show sniff codes (used for disabling errors in the code with `phpcs disable:` — MAKE SURE THAT YOU HAVE `phpcs enable` AT THE EARLIEST POINT POSSIBLE, and provide a justification for disabling the sniff code) + - You can run either across the entire project by adding the argument `--ignore=*/vendor/*` and targetting the file `./*.php ./**/*.php` ## Updating Documentation