1myshortcuts plugin for DokuWiki 2================================= 3 4Create your own personal DokuWiki keyboard shortcuts for common actions. 5 6FEATURES 7-------- 8* Customizable keyboard shortcuts for editing and saving pages 9* Quick snippet insertion with keyboard shortcuts 10* Visual snippet selection dialog 11* Easy configuration through DokuWiki admin interface 12* Supports multiple modifier keys (Ctrl, Alt, Shift, Meta/Cmd) 13 14DEFAULT SHORTCUTS 15----------------- 16* Ctrl+E - Edit current page 17* Ctrl+S - Save current page (only in edit mode) 18* Ctrl+I - Insert snippet (only in edit mode) 19 20INSTALLATION 21------------ 22If you install this plugin manually, make sure it is installed in 23lib/plugins/myshortcuts/ - if the folder is called different it 24will not work! 25 26Please refer to http://www.dokuwiki.org/extensions for additional info 27on how to install extensions in DokuWiki. 28 29CONFIGURATION 30------------- 31After installation, go to: 32Admin → Configuration Settings → myshortcuts plugin 33 34Available settings: 35 361. shortcut_edit: Keyboard shortcut to edit pages (default: ctrl+e) 372. shortcut_save: Keyboard shortcut to save pages (default: ctrl+s) 383. shortcut_snippet: Keyboard shortcut to open snippet dialog (default: ctrl+i) 394. snippets: List of text snippets (one per line) 40 41SNIPPET FORMAT 42-------------- 43Snippets should be entered one per line in the format: 44 Label: Text to insert 45 46Examples: 47 Meeting Notes: ## Meeting Notes\n\n**Date:** \n**Attendees:** \n**Topics:** 48 TODO: ☐ TODO: 49 Code Block: ```\nYour code here\n``` 50 51KEYBOARD SHORTCUT FORMAT 52------------------------ 53Shortcuts can use the following modifiers: 54* ctrl or control 55* alt 56* shift 57* meta or cmd (Command key on Mac) 58 59Examples: 60* ctrl+e 61* alt+s 62* ctrl+shift+i 63* meta+e 64 65USAGE 66----- 671. View Mode: 68 - Press your configured edit shortcut (default: Ctrl+E) to enter edit mode 69 702. Edit Mode: 71 - Press your configured save shortcut (default: Ctrl+S) to save changes 72 - Press your configured snippet shortcut (default: Ctrl+I) to open snippet dialog 73 - Select a snippet from the dialog or press ESC to cancel 74 753. Snippet Dialog: 76 - Click on a snippet to insert it at cursor position 77 - Use keyboard navigation (Tab/Shift+Tab) to move between snippets 78 - Press Enter to insert selected snippet 79 - Press ESC to close dialog 80 81BROWSER COMPATIBILITY 82--------------------- 83Note: Some keyboard shortcuts may conflict with browser defaults: 84* Ctrl+S is "Save Page" in most browsers - the plugin will override this 85* Ctrl+E may open search in some browsers 86* If shortcuts don't work, try using Alt or Meta modifiers instead 87 88TROUBLESHOOTING 89--------------- 901. Shortcuts not working? 91 - Check browser console for errors (F12) 92 - Verify shortcuts don't conflict with browser shortcuts 93 - Try different modifier keys (Alt, Meta instead of Ctrl) 94 952. Save not working? 96 - Make sure you're in edit mode 97 - Check if the edit form is visible 98 993. Snippets not inserting? 100 - Make sure you're in edit mode 101 - Check snippet configuration format 102 103DEVELOPMENT 104----------- 105Key files: 106* action.php - Passes configuration to JavaScript 107* script.js - Handles keyboard events and actions 108* style.css - Styles for snippet dialog 109* conf/default.php - Default configuration values 110* conf/metadata.php - Configuration field types 111* lang/en/settings.php - English configuration descriptions 112 113SUPPORT 114------- 115If you need help, please report issues at: 116https://www.dokuwiki.org/plugin:myshortcuts 117 118LICENSE 119------- 120Copyright (C) David Jiménez <davidjimenez75@gmail.com> 121 122This program is free software; you can redistribute it and/or modify 123it under the terms of the GNU General Public License as published by 124the Free Software Foundation; version 2 of the License 125 126This program is distributed in the hope that it will be useful, 127but WITHOUT ANY WARRANTY; without even the implied warranty of 128MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 129GNU General Public License for more details. 130 131See the LICENSE file for details 132