close
The Wayback Machine - https://web.archive.org/web/20190327235700/https://plugins.trac.wordpress.org/changeset/1782444

WordPress.org

Plugin Directory

Changeset 1782444


Ignore:
Timestamp:
12/07/2017 08:11:43 AM (16 months ago)
Author:
Joen
Message:

Update README for clarity

File:
1 edited

Legend:

Unmodified
Added
Removed
  • gutenberg/trunk/readme.txt

    r1777833 r1782444  
    33Requires at least: 4.8
    44Tested up to: 4.9
    5 Stable tag: 1.8.1
     5Stable tag: 1.8.0
    66License: GPLv2 or later
    77License URI: http://www.gnu.org/licenses/gpl-2.0.html
     
    1111== Description ==
    1212
    13 The goal of the block editor is to make adding rich content to WordPress simple and enjoyable.
    14 
    15 <strong>This is beta software.</strong>
    16 
    17 The new post and page building experience will make writing rich posts effortless, making it easy to do what today might take shortcodes, custom HTML, or "mystery meat" embed discovery.
    18 
    19 WordPress already supports a large amount of "blocks", but doesn't surface them very well, nor does it give them much in the way of layout options. By embracing the blocky nature of rich post content, we will surface the blocks that already exist, as well as provide more advanced layout options for each of them. This will allow you to easily compose beautiful posts like <a href="http://moc.co/sandbox/example-post/">this example</a>.
    20 
    21 Gutenberg is built by many contributors and volunteers. You can see the full list of contributors in <a href="https://github.com/WordPress/gutenberg/blob/master/CONTRIBUTORS.md">the GitHub CONTRIBUTORS.md file</a> which we are continuously updating. You can follow along on <a href="https://github.com/WordPress/gutenberg">github.com/WordPress/gutenberg</a> and on the <a href="https://make.wordpress.org/core/tag/editor/">#editor tag on the make.wordpress.org blog</a>.
     13Gutenberg is more than an editor. While the editor is the focus right now, the project will ultimately impact the entire publishing experience including customization (the next focus area).
     14
     15<a href="https://wordpress.org/gutenberg">Discover more about the project</a>.
     16
     17= Editing focus =
     18
     19> The editor will create a new page- and post-building experience that makes writing rich posts effortless, and has “blocks” to make it easy what today might take shortcodes, custom HTML, or “mystery meat” embed discovery. — Matt Mullenweg
     20
     21One thing that sets WordPress apart from other systems is that it allows you to create as rich a post layout as you can imagine -- but only if you know HTML and CSS and build your own custom theme. By thinking of the editor as a tool to let you write rich posts and create beautiful layouts, we can transform WordPress into something users _love_ WordPress, as opposed something they pick it because it's what everyone else uses.
     22
     23Gutenberg looks at the editor as more than a content field, revisiting a layout that has been largely unchanged for almost a decade.This allows us to holistically design a modern editing experience and build a foundation for things to come.
     24
     25Here's why we're looking at the whole editing screen, as opposed to just the content field:
     26
     271. The block unifies multiple interfaces. If we add that on top of the existing interface, it would _add_ complexity, as opposed to remove it.
     282. By revisiting the interface, we can modernize the writing, editing, and publishing experience, with usability and simplicity in mind, benefitting both new and casual users.
     293. When singular block interface takes center stage, it demonstrates a clear path forward for developers to create premium blocks, superior to both shortcodes and widgets.
     304. Considering the whole interface lays a solid foundation for the next focus, full site customization.
     315. Looking at the full editor screen also gives us the opportunity to drastically modernize the foundation, and take steps towards a more fluid and JavaScript powered future that fully leverages the WordPress REST API.
     32
     33= Blocks =
     34
     35Blocks are the unifying evolution of what is now covered, in different ways, by shortcodes, embeds, widgets, post formats, custom post types, theme options, meta-boxes, and other formatting elements. They embrace the breadth of functionality WordPress is capable of, with the clarity of a consistent user experience.
     36
     37Imagine a custom “employee” block that a client can drag to an About page to automatically display a picture, name, and bio. A whole universe of plugins that all extend WordPress in the same way. Simplified menus and widgets. Users who can instantly understand and use WordPress  -- and 90% of plugins. This will allow you to easily compose beautiful posts like <a href="http://moc.co/sandbox/example-post/">this example</a>.
     38
     39Check out the <a href="https://github.com/WordPress/gutenberg/blob/master/docs/faq.md">FAQ</a> for answers to the most common questions about the project.
     40
     41= Compatibility =
     42
     43Posts are backwards compatible, and shortcodes will still work. We are continuously exploring how highly-tailored metaboxes can be accommodated, and are looking at solutions ranging from a plugin to disable Gutenberg to automatically detecting whether to load Gutenberg or not. While we want to make sure the new editing experience from writing to publishing is user-friendly, we’re committed to finding  a good solution for highly-tailored existing sites.
     44
     45= The stages of Gutenberg =
     46
     47Gutenberg has three planned stages. The first, aimed for inclusion in WordPress 5.0, focuses on the post editing experience and the implementation of blocks. This initial phase focuses on a content-first approach. The use of blocks, as detailed above, allows you to focus on how your content will look without the distraction of other configuration options. This ultimately will help all users present their content in a way that is engaging, direct, and visual.
     48
     49These foundational elements will pave the way for stages two and three, planned for the next year, to go beyond the post into page templates and ultimately, full site customization.
     50
     51Gutenberg is a big change, and there will be ways to ensure that existing functionality (like shortcodes and meta-boxes) continue to work while allowing developers the time and paths to transition effectively. Ultimately, it will open new opportunities for plugin and theme developers to better serve users through a more engaging and visual experience that takes advantage of a toolset supported by core.
     52
     53= Contributors =
     54
     55Gutenberg is built by many contributors and volunteers. Please see the full list in <a href="https://github.com/WordPress/gutenberg/blob/master/CONTRIBUTORS.md">CONTRIBUTORS.md</a>.
    2256
    2357== Frequently Asked Questions ==
     
    2963= How can I contribute? =
    3064
    31 The more the merrier! To get started, check out our <a href="https://github.com/WordPress/gutenberg/blob/master/CONTRIBUTING.md">guide for contributors</a>.
     65We’re calling this editor project "Gutenberg" because it's a big undertaking. We are working on it every day in GitHub, and we'd love your help building it.You’re also welcome to give feedback, the easiest is to join us in <a href="https://make.wordpress.org/chat/">our Slack channel</a>, `#core-editor`.
     66
     67See also <a href="https://github.com/WordPress/gutenberg/blob/master/CONTRIBUTING.md">CONTRIBUTING.md</a>.
     68
     69= Where can I read more about Gutenberg? =
     70
     71- <a href="http://matiasventura.com/post/gutenberg-or-the-ship-of-theseus/">Gutenberg, or the Ship of Theseus</a>, with examples of what Gutenberg might do in the future
     72- <a href="https://make.wordpress.org/core/2017/01/17/editor-technical-overview/">Editor Technical Overview</a>
     73- <a href="http://gutenberg-devdoc.surge.sh/reference/design-principles/">Design Principles and block design best practices</a>
     74- <a href="https://github.com/Automattic/wp-post-grammar">WP Post Grammar Parser</a>
     75- <a href="https://make.wordpress.org/core/tag/gutenberg/">Development updates on make.wordpress.org</a>
     76- <a href="http://gutenberg-devdoc.surge.sh/">Documentation: Creating Blocks, Reference, and Guidelines</a>
     77- <a href="https://github.com/WordPress/gutenberg/blob/master/docs/faq.md">Additional frequently asked questions</a>
     78
    3279
    3380== Changelog ==
     
    410457* Improve accessibility of add-new-category form.
    411458* Documentation gets an updated design and content improvements.
    412 * Adjust column width calculation in gallery block to properly respect column count.
     459* Adjust column width calculation in gallery block to properly respect column count.
    413460* Move pending review control together with sticky toggle at the bottom.
    414461* Add caption styling for video block.
     
    420467* Fix the resetting of drop-zone states after dropping a file.
    421468* Fix embed saving "undefined" text when URL is not set.
    422 * Fix placeholder styling on Text when background color is set.
     469* Fix placeholder styling on Text when background color is set.
    423470* Update Composer + PHPCS.
    424471* Rename default block handlers.
     
    497544= 0.8.0 =
    498545* New Categories Block (based on existing widget).
    499 * New Text Columns Block (initial exploration of text-only multiple columns).
     546* New Text Columns Block (initial exploration of text-only multiple columns).
    500547* New Video Block.
    501548* New Shortcode Block.
    502549* New Audio Block.
    503550* Added resizing handlers to Image Block.
    504 * Added direct image upload button to Image Block and Gallery Block.
     551* Added direct image upload button to Image Block and Gallery Block.
    505552* Give option to transform a block to Classic when it encounters problems.
    506553* Give option to Overwrite changes on a block detected as invalid.
     
    508555* Added support for custom taxonomies.
    509556* Added post formats selector to post settings.
    510 * Added keywords support (aliases) to various blocks to improve search discovery.
     557* Added keywords support (aliases) to various blocks to improve search discovery.
    511558* Significant improvements to the way attributes are specified in the Block API and its clarity (handles defaults and types).
    512559* Added Tooltip component displaying aria-labels from buttons.
     
    538585* Fix problems with quote initialization and list transformation.
    539586* Fix issue where Cover Image was being considered invalid after edits.
    540 * Fix errors in editable coming from Table block commands.
     587* Fix errors in editable coming from Table block commands.
    541588* Fix error in latest posts block when date is not set for a post.
    542589* Fix issue with active color in ColorPalette component.
     
    559606* Add theme support for customized color palettes and a shared component (applies to cover text and button blocks).
    560607* Add theme support for wide images.
    561 * Report on missing headings in the document outline feature.
     608* Report on missing headings in the document outline feature.
    562609* Update block validation to make it less prone to over-eagerness with trivial changes (like whitespace and new lines).
    563610* Attempt to create an embed block automatically when pasting URL on a single line.
     
    612659* Added page attributes with menu order setting.
    613660* Use two distinct icons for quote style variations.
    614 * Created KeyboardShortcuts component to handle keyboard events.
     661* Created KeyboardShortcuts component to handle keyboard events.
    615662* Add support for custom icons (non dashicons) on blocks.
    616663* Initialize new posts with auto-draft to match behaviour of existing editor.
     
    651698* Improve version compare checks for plugin compatibility.
    652699* Clean up obsolete poststoshowattribute in LatestPosts block.
    653 * Consolidate addQueryArgs usage.
     700* Consolidate addQueryArgs usage.
    654701* Add unit tests to inserter.
    655702* Update fixtures with latest modifications and ensure all end in newlines.
     
    668715* Add "table of contents" document outline for headings (with empty heading validation).
    669716* Refactor tests to use Jest API.
    670 * New block: Verse (intended for poetry, respecting whitespace).
     717* New block: Verse (intended for poetry, respecting whitespace).
    671718* Avoid showing UI when typing and starting a new paragraph (text block).
    672719* Display warning message when navigating away from the editor with unsaved changes.
     
    682729* Show error message when trashing action fails.
    683730* Pass content to dynamic block render functions in PHP.
    684 * Fix various z-index issues and clarify reasonings.
     731* Fix various z-index issues and clarify reasonings.
    685732* Fix DropdownMenu arrows navigation and add missing aria-label.
    686733* Update sandboxed iframe size calculations.
     
    693740
    694741= 0.4.0 =
    695 * Initial FAQ (in progress).
     742* Initial FAQ (in progress).
    696743* API for handling pasted content. (Aim is to have specific handling for converting Word, Markdown, Google Docs to native WordPress blocks.)
    697744* Added support for linking to a url on image blocks.
     
    732779* Add translation to embed title.
    733780* Add missing text domains and adjust PHPCS to warn about them.
    734 * Added template for creating new issues including mentions of version number.
     781* Added template for creating new issues including mentions of version number.
    735782
    736783= 0.3.0 =
     
    749796* Auto-focusing for inserter search field.
    750797* Added text formatting to CoverImage block.
    751 * Added toggle option for fixed background in CoverImage.
     798* Added toggle option for fixed background in CoverImage.
    752799* Switched to store attributes in unescaped JSON format within the comments.
    753800* Added placeholder for all text blocks.
     
    758805* Changed the block name declaration for embeds to be "core-embed/name-of-embed".
    759806* Simplified and made more robust the rendering of embeds.
    760 * Different fixes for quote blocks (parsing and transformations).
     807* Different fixes for quote blocks (parsing and transformations).
    761808* Improve display of text within cover image.
    762809* Fixed placeholder positioning in several blocks.
     
    769816* Enhance FormTokenField with accessibility improvements.
    770817* Load word-count module.
    771 * Updated icons for trash button, and Custom HTML.
     818* Updated icons for trash button, and Custom HTML.
    772819* Design tweaks for inserter, placeholders, and responsiveness.
    773820* Improvements to sidebar headings and gallery margins.
     
    778825* Fix sidebar breadcrumb.
    779826* Fix for block-mover when blocks are floated.
    780 * Fixed inserting Freeform block (now classic text).
     827* Fixed inserting Freeform block (now classic text).
    781828* Fixed missing keys on inserter.
    782829* Updated drop-cap class implementation.
     
    792839* Added button to open block settings in the inspector.
    793840* New block: Custom HTML (to write your own HTML and preview it).
    794 * New block: Cover Image (with text over image support).
     841* New block: Cover Image (with text over image support).
    795842* Rename "Freeform" block to "Classic Text".
    796843* Added support for pages and custom post types.
Note: See TracChangeset for help on using the changeset viewer.