Converting README to markdown

This commit is contained in:
Eric van der Vlist 2020-05-08 14:56:27 +02:00
parent 4ff9eb4df6
commit 4252fa5f4b
1 changed files with 145 additions and 145 deletions

View File

@ -1,145 +1,145 @@
=== pageMash > Page Management === # pageMash > Page Management
Contributors: JoelStarnes Contributors: JoelStarnes
Donate link: http://joelstarnes.co.uk/donate/ Donate link: http://joelstarnes.co.uk/donate/
Tags: order pages, ajax, re-order, drag-and-drop, admin, manage, page, pages, sidebar, header, hide, Tags: order pages, ajax, re-order, drag-and-drop, admin, manage, page, pages, sidebar, header, hide,
Requires at least: 2.1 Requires at least: 2.1
Tested up to: 2.7.1 Tested up to: 2.7.1
Stable tag: 1.3.0 Stable tag: 1.3.0
Manage your multitude of pages with pageMash's slick drag-and-drop style, ajax interface. Allows for quick sorting, hiding and organising of page parenting structure in a simple intuative manner. Manage your multitude of pages with pageMash's slick drag-and-drop style, ajax interface. Allows for quick sorting, hiding and organising of page parenting structure in a simple intuative manner.
== Description == ## Description
Customise the order your pages are listed in and manage the parent structure with this simple ajax drag-and-drop administrative interface with an option to toggle the page to be hidden from output. Great tool to quickly re-arrange your page menus. Customise the order your pages are listed in and manage the parent structure with this simple ajax drag-and-drop administrative interface with an option to toggle the page to be hidden from output. Great tool to quickly re-arrange your page menus.
Checkout the example page: http://joelstarnes.co.uk/pagemash/example Checkout the example page: http://joelstarnes.co.uk/pagemash/example
Feedback is greatly appreciated: http://joelstarnes.co.uk/contact Feedback is greatly appreciated: http://joelstarnes.co.uk/contact
== Installation == ## Installation
1. Download Plugin 1. Download Plugin
1. Unzip & Upload to `/wp-content/plugins/` 1. Unzip & Upload to `/wp-content/plugins/`
1. Activate in 'Plugins' admin menu 1. Activate in 'Plugins' admin menu
1. Then have fun.. 1. Then have fun..
pageMash works with the `wp_list_pages` function. The easiest way to use it is to put the standard WordPress pages widget in your sidebar. Click the configure button on the widget and ensure that 'sort by' is set to 'page order'. Hey presto, you're done. pageMash works with the `wp_list_pages` function. The easiest way to use it is to put the standard WordPress pages widget in your sidebar. Click the configure button on the widget and ensure that 'sort by' is set to 'page order'. Hey presto, you're done.
You can also use the function anywhere in your theme code. e.g. in your sidebar.php file (but the code in here will not run if you're using any widgets) or your header.php file (somewhere under the body tag, you may want to use the depth=1 parameter to only show top level pages). The code should look something like the following: You can also use the function anywhere in your theme code. e.g. in your sidebar.php file (but the code in here will not run if you're using any widgets) or your header.php file (somewhere under the body tag, you may want to use the depth1 parameter to only show top level pages). The code should look something like the following:
`<?php wp_list_pages('title_li=<h2>Pages</h2>&depth=0'); ?>` `<?php wp_list_pages('title_li<h2>Pages</h2>&depth=0'); ?>`
You can also hard-code pages to exclude and these will be merged with the pages you set to exclude in your pageMash admin. You can also hard-code pages to exclude and these will be merged with the pages you set to exclude in your pageMash admin.
The code here is very simple and flexible, for more information look up `wp_list_pages()` in the Wordpress Codex: http://codex.wordpress.org/Template_Tags/wp_list_pages The code here is very simple and flexible, for more information look up `wp_list_pages()` in the Wordpress Codex: http://codex.wordpress.org/Template_Tags/wp_list_pages
== Frequently Asked Questions == ## Frequently Asked Questions
If you have any questions or comments, please drop me an email: http://joelstarnes.co.uk/contact If you have any questions or comments, please drop me an email: http://joelstarnes.co.uk/contact
= None of it's working = None of it's working =
The most likely cause is that you have another plugin which has included an incompatible javascript library onto the pageMash admin page. The most likely cause is that you have another plugin which has included an incompatible javascript library onto the pageMash admin page.
Try opening up your WP admin and browse to your pageMash page, then take a look at the page source. Check if the prototype or scriptaculous scripts are included in the header. If so then the next step is to track down the offending plugin, which you can do by disabling each of your plugins in turn and checking when the scripts are no longer included. Try opening up your WP admin and browse to your pageMash page, then take a look at the page source. Check if the prototype or scriptaculous scripts are included in the header. If so then the next step is to track down the offending plugin, which you can do by disabling each of your plugins in turn and checking when the scripts are no longer included.
= Do I need any special code in my template = Do I need any special code in my template =
No. As of v1.0.2 you no longer need to add any code to your template. PageMash adds a filter to the wp_list_pages() function and will also work just fine with the pages widget. No. As of v1.0.2 you no longer need to add any code to your template. PageMash adds a filter to the wp_list_pages() function and will also work just fine with the pages widget.
= Which browsers are supported = Which browsers are supported =
Any good up-to-date browser should work fine. I test in Firefox, IE7, Safari and Opera. (NB in IE you might need to use the page name as a drag handle.) Any good up-to-date browser should work fine. I test in Firefox, IE7, Safari and Opera. (NB in IE you might need to use the page name as a drag handle.)
== Screenshots == ## Screenshots
1. Admin Interface. 1. Admin Interface.
2. Setting up the page widget in the old WP admin. 2. Setting up the page widget in the old WP admin.
== Change Log == ## Change Log
= 1.3.0 = 1.3.0 =
- Important core fix ~ huge thanks to Alex Günsche [www.zirona.com] - Important core fix ~ huge thanks to Alex Günsche [www.zirona.com]
- Pages show 'draft' and 'pending review' tags - Pages show 'draft' and 'pending review' tags
- Fix for nested sorting bug in safari - Fix for nested sorting bug in safari
- Danish translation ~ by Georg S. Adamsen [wordpress.blogos.dk] - Danish translation ~ by Georg S. Adamsen [wordpress.blogos.dk]
= 1.2.2 = 1.2.2 =
- Additional multi-lingual support - Additional multi-lingual support
- Adds turkish translation ~ by Ömer Faruk [ramerta.com] - Adds turkish translation ~ by Ömer Faruk [ramerta.com]
- Fix permalinks by flushing the rewrite rules after updates ~ thanks Alexey ;) - Fix permalinks by flushing the rewrite rules after updates ~ thanks Alexey ;)
= 1.2.1 = 1.2.1 =
- fix for menu position in WP2.7 - fix for menu position in WP2.7
= 1.2.0 = 1.2.0 =
- Introduces multi-lingual support. - Introduces multi-lingual support.
- Adds German translation - Adds German translation
- Moves pageMash into the Pages menu for WP2.7 - Moves pageMash into the Pages menu for WP2.7
- All thanks to Tom [www.outsourcetoasia.de] - All thanks to Tom [www.outsourcetoasia.de]
= 1.1.6 = 1.1.6 =
- Corrected filename case. - Corrected filename case.
= 1.1.5 = 1.1.5 =
- Updated for WP 2.6 - Updated for WP 2.6
= 1.1.4 = 1.1.4 =
- Add config option to show debug info. - Add config option to show debug info.
= 1.1.3 = 1.1.3 =
- Fixed hide bug that appeared on some systems - Fixed hide bug that appeared on some systems
= 1.1.2 = 1.1.2 =
- Added Expand all | Collapse all buttons - Added Expand all | Collapse all buttons
= 1.1.1 = 1.1.1 =
- Fix a bug with console.log for safari - Fix a bug with console.log for safari
- Removed php code from js&css scripts to fix error - Removed php code from js&css scripts to fix error
= 1.1.0 = 1.1.0 =
- Added quick rename - Added quick rename
- Externalised scripts - Externalised scripts
- Changed display of edit|hide|rename links - Changed display of edit|hide|rename links
- Deregisters prototypes - Deregisters prototypes
= 1.0.4 = 1.0.4 =
- Removed shorthand PHP - Removed shorthand PHP
- Updated CSS and JS headers to admin_print_scripts hook. - Updated CSS and JS headers to admin_print_scripts hook.
= 1.0.3 = 1.0.3 =
- Fixed datatype bug causing array problems - Fixed datatype bug causing array problems
= 1.0.3 = 1.0.3 =
- Fixed datatype bug causing array problems - Fixed datatype bug causing array problems
= 1.0.2 = 1.0.2 =
- Major code rewrite for exclude pages - Major code rewrite for exclude pages
= 1.0.1 beta = 1.0.1 beta =
- fixed IE drag selects text = - fixed IE drag selects text
= 1.0.0 beta = 1.0.0 beta =
- Major rebuild to use vladimir's sortables class extension - Major rebuild to use vladimir's sortables class extension
- Recusive page handles unlimited nested children - Recusive page handles unlimited nested children
- Collapsable list items - Collapsable list items
- Interface makeover... - Interface makeover...
= 0.1.3 = 0.1.3 =
- Fixed exclude pages feature - Fixed exclude pages feature
= 0.1.2 = 0.1.2 =
- Fixed CSS&JS headers to only display on pageMash admin - Fixed CSS&JS headers to only display on pageMash admin
= 0.1.1 = 0.1.1 =
- Removed version check since some hosts will not allow external includes. - Removed version check since some hosts will not allow external includes.
= 0.1.0 = 0.1.0 =
- Initial Release - Initial Release
== Localization == ## Localization
= pageMash is available in: = pageMash is available in: =
- English - English
- German :: courtesy of Tom [www.outsourcetoasia.de] - German :: courtesy of Tom [www.outsourcetoasia.de]
- Turkish :: courtesy of Ömer Faruk [ramerta.com] - Turkish :: courtesy of Ömer Faruk [ramerta.com]
If you'd like to translate pageMash into your own language get in touch and I'll be happy to add it in. If you'd like to translate pageMash into your own language get in touch and I'll be happy to add it in.