WordPress.org
Get WordPress

Plugin Directory

Changeset 1131083


Ignore:
Timestamp:
04/09/2015 10:18:05 AM (11 years ago)
Author:
mortalis
Message:

readme-edit-1

File:
1 edited

Legend:

Unmodified
Added
Removed

  • html-post-editor-new/trunk/readme.txt

    r1131040 r1131083  
    1515The plugin adds HTML editor to the default post editor. The editor is accessible through a new HTML tab. When opening the tab the editor loads the raw HTML source of the post, formats it and applies Ace Editor to the input area. So the edit area has main features from this web editor: syntax highlight, line numbers, highlight of matching tags and brackets, keyboard shortcuts.
    1616
    17 The plugin is based on the ACE Editor for WP [https://wordpress.org/plugins/ace-editor-for-wp/] plugin. It's updated for Wordpress 4.1 and Ace editor 1.1.8.
     17The plugin is based on the [ACE Editor for WP](https://wordpress.org/plugins/ace-editor-for-wp/) plugin. It's updated for Wordpress 4.1 and Ace editor 1.1.8.
    1818
    1919
    … …  
    3737
    3838= Usage =
    39 
     39 
    40401. To open the HTML tab first make sure you are on the Visual tab because the script loads the data from the TinyMCE editor which is loaded only when the Visual tab activates.
    41412. When you are on the Text tab the HTML tab is disabled and has a light red background so you won't be able to switch to it until you activate the Visual tab.
    … …  
    4545
    4646= Working with features =
    47 
     47 
    48481. Multicursor lets you edit multiple regions at the same time. You can use default shortcuts to add remove regions or select multiple blocks with mouse holding Ctrl key.
    49 2. Default keyboard shortcuts for the Ace editor can be found on the Ace GitHub Wiki page [https://github.com/ajaxorg/ace/wiki/Default-Keyboard-Shortcuts] or on the Ace Editor Shortcuts page I created for the Wordpress version of this editor [http://pcadvice.co.nf/blog/ace-editor-shortcuts/]. Here I selected some shortcuts and organized them by categories.
     492. Default keyboard shortcuts for the Ace editor can be found on the [Ace GitHub Wiki](https://github.com/ajaxorg/ace/wiki/Default-Keyboard-Shortcuts) page or on the [Ace Editor Shortcuts](http://pcadvice.co.nf/blog/ace-editor-shortcuts/) page I created for the Wordpress version of this editor. Here I selected some shortcuts and organized them by categories.
    50503. The Search box gives additional functions:
    5151  - Search All instances
    … …  
    5353  - Whole word search
    5454  - Replace content
    55   - Replace All
    56 It is called with Ctrl+F and Ctrl+H combinations.
     55  - Replace All 
     56It shows with Ctrl+F and Ctrl+H combinations.
    57574. The editor area can be resized using the bottom (southern) handle but doesn't remember its size after switching
    58585. Emmet snippets are used to improve code typing. The documentation:
    59   - Basic Usage [http://docs.emmet.io/abbreviations/]
    60   - Full list of HTML and CSS snippets [http://docs.emmet.io/cheat-sheet]
    61 6. Full screen mode is not a default Ace Editor feature. I've taken the idea from a demo page in the Ace build package [https://github.com/ajaxorg/ace-builds/tree/master/demo]. The page is named scrollable-page.html. It adds a new custom shortcut to the editor which toggles the full/normal mode. So I set this function to the F11 key. The function extends the editor container to the Wordpess admin boundaries but doesn't hide top and left menus. It also works with if the windows size is changed or the left menu is collapsed. But to fill the available space the F11 key must be pressed two times when the editor is in the full screen mode.
     59  - [Basic Usage](http://docs.emmet.io/abbreviations/)
     60  - [Full list](http://docs.emmet.io/cheat-sheet) of HTML and CSS snippets
     616. Full screen mode is not a default Ace Editor feature. I've taken the idea from a demo page in the [Ace build package](https://github.com/ajaxorg/ace-builds/tree/master/demo). The page is named scrollable-page.html. It adds a new custom shortcut to the editor which toggles the full/normal mode. So I set this function to the F11 key. The function extends the editor container to the Wordpess admin boundaries but doesn't hide top and left menus. It also works with if the windows size is changed or the left menu is collapsed. But to fill the available space the F11 key must be pressed two times when the editor is in the full screen mode.
    6262If you need to change this F11 key to other write me a request and I'll add an option to the options page.
    63637. The top Word Wrap checkbox appears when the HTML tab is switched to. By default the editor has word wrapping enabled. You can toggle this option with the checkbox. But it only remembers its state in the current editor session.
    … …  
    6868
    6969= The Options Page =
    70 
     70 
    71711. Font size of the editor may be set in any CSS units (px, pt, em)
    72722. Editor theme is chosen of default Ace Editor themes plus my custom theme Sublime which is the default theme for the plugin
    … …  
    7676= Other Notes =
    7777
    78 1. Emmet plugin works on the specially built package for the Ace Editor. Its source is here [https://github.com/cloud9ide/emmet-core]. And I reduced its size by removing the Underscore.js part and CSS snippets. So the final package is here [https://github.com/mortalis13/emmet-for-ace-css].
    79 2. When the HTML tab is loaded the source code is first represented as one long line. So I used the JS Beautifier [https://github.com/beautify-web/js-beautify/tree/master/js] tool and exactly its beautify-html.js subscript to format that line so it has some readable structure. Additionally I applied my own function to have some blank lines before <p> and <pre> tags.
    80 3. I've put only the minified version of the Ace Editor scripts to the plugin package. To get the full uncompressed files go to its GitHub repository [https://github.com/ajaxorg/ace-builds]
     781. Emmet plugin works on the specially built package for the Ace Editor. Its source is [here](https://github.com/cloud9ide/emmet-core). And I reduced its size by removing the Underscore.js part and CSS snippets. So the final package is [here](https://github.com/mortalis13/emmet-for-ace-css).
     792. When the HTML tab is loaded the source code is first represented as one long line. So I used the [JS Beautifier](https://github.com/beautify-web/js-beautify/tree/master/js) tool and exactly its beautify-html.js subscript to format that line so it has some readable structure. Additionally I applied my own function to have some blank lines before `<p>` and `<pre>` tags.
     803. I've put only the minified version of the Ace Editor scripts to the plugin package. To get the full uncompressed files go to its [GitHub repository](https://github.com/ajaxorg/ace-builds)
    8181
    8282= Resource Links =
    8383
    84 1. Ace Editor Main Site [http://ace.c9.io] and GitHub repository [https://github.com/ajaxorg/ace]
    85 2. Ace Builds GitHub repository [https://github.com/ajaxorg/ace-builds] with sources
    86 3. Ace Editor Demo Pages [https://github.com/ajaxorg/ace-builds/tree/master/demo]
    87 4. Ace Editor Keyboard Shortcuts [https://github.com/ajaxorg/ace/wiki/Default-Keyboard-Shortcuts] and my edition [http://pcadvice.co.nf/blog/ace-editor-shortcuts]
    88 5. Emmet plugin Main Site [http://emmet.io], Documentation [http://docs.emmet.io], List of Abbreviations [http://docs.emmet.io/cheat-sheet]
    89 6. Special Emmet package [https://github.com/mortalis13/emmet-for-ace-css] for the Ace Editor
    90 7. JS Beautifier [https://github.com/beautify-web/js-beautify/tree/master/js]
     841. [Ace Editor Main Site](http://ace.c9.io) and [GitHub repository](https://github.com/ajaxorg/ace)
     852. [Ace Builds GitHub repository](https://github.com/ajaxorg/ace-builds) with sources
     863. [Ace Editor Demo Pages](https://github.com/ajaxorg/ace-builds/tree/master/demo)
     874. [Ace Editor Keyboard Shortcuts](https://github.com/ajaxorg/ace/wiki/Default-Keyboard-Shortcuts) and [my edition](http://pcadvice.co.nf/blog/ace-editor-shortcuts)
     885. Emmet plugin [Main Site](http://emmet.io), [Documentation](http://docs.emmet.io), [List of Abbreviations](http://docs.emmet.io/cheat-sheet)
     896. [Special Emmet package](https://github.com/mortalis13/emmet-for-ace-css) for the Ace Editor
     907. [JS Beautifier](https://github.com/beautify-web/js-beautify/tree/master/js)
    9191
    9292
Note: See TracChangeset for help on using the changeset viewer.