Skip to content

Commit

Permalink
Merge branch 'develop' into trunk
Browse files Browse the repository at this point in the history
  • Loading branch information
jeffpaul committed Oct 8, 2020
2 parents d39626f + 9aa0adb commit d8f3080
Show file tree
Hide file tree
Showing 25 changed files with 119 additions and 940 deletions.
6 changes: 3 additions & 3 deletions .github/workflows/push-asset-readme-update.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2,15 +2,15 @@ name: Plugin asset/readme update
on:
push:
branches:
- master
- trunk
jobs:
master:
name: Push to master
name: Push to trunk
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@master
- name: WordPress.org plugin asset/readme update
uses: 10up/action-wordpress-plugin-asset-update@master
uses: 10up/action-wordpress-plugin-asset-update@stable
env:
SVN_PASSWORD: ${{ secrets.SVN_PASSWORD }}
SVN_USERNAME: ${{ secrets.SVN_USERNAME }}
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/push-deploy.yml
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ jobs:
steps:
- uses: actions/checkout@master
- name: WordPress Plugin Deploy
uses: 10up/action-wordpress-plugin-deploy@master
uses: 10up/action-wordpress-plugin-deploy@stable
env:
SVN_PASSWORD: ${{ secrets.SVN_PASSWORD }}
SVN_USERNAME: ${{ secrets.SVN_USERNAME }}
Expand Down
Binary file modified .wordpress-org/screenshot-1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified .wordpress-org/screenshot-2.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified .wordpress-org/screenshot-3.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified .wordpress-org/screenshot-4.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added .wordpress-org/screenshot-5.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added .wordpress-org/screenshot-6.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added .wordpress-org/screenshot-7.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added .wordpress-org/screenshot-8.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
34 changes: 25 additions & 9 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,30 +4,46 @@ All notable changes to this project will be documented in this file, per [the Ke

## [Unreleased]

## [1.1.2] - 2020-10-08
### Changed
- Plugin documentation and screenshots (props [@jeffpaul](https://github.com/jeffpaul) via [#56](https://github.com/10up/eight-day-week/pull/56), [#61](https://github.com/10up/eight-day-week/pull/61)).

### Removed
- Translation files as this is now handled on [translate.wordpress.org](https://translate.wordpress.org/projects/wp-plugins/eight-day-week-print-workflow/) (props [@jeffpaul](https://github.com/jeffpaul), [@helen](https://github.com/helen) via [#60](https://github.com/10up/eight-day-week/pull/60)).

### Fixed
- Unable to change role using upper Print Role dropdown (props [@dinhtungdu](https://github.com/dinhtungdu) via [#58](https://github.com/10up/eight-day-week/pull/58)).
- Display correct title when creating a new Section in Print Issues (props [@dinhtungdu](https://github.com/dinhtungdu) via [#62](https://github.com/10up/eight-day-week/pull/62)).

### Security
- Bump `websocket-extensions` from 0.1.3 to 0.1.4 (props [@dependabot](https://github.com/apps/dependabot) via [#55](https://github.com/10up/eight-day-week/pull/55)).
- Bump `lodash` from 4.17.15 to 4.17.19 (props [@dependabot](https://github.com/apps/dependabot) via [#59](https://github.com/10up/eight-day-week/pull/59)).

## [1.1.1] - 2019-11-22
### Changed
- Bump WordPress version "tested up to" 5.3 (props [@adamsilverstein](https://github.com/adamsilverstein) via [#45](https://github.com/10up/eight-day-week/pull/45))
- Documentation and deploy automation updates (props [@jeffpaul](https://github.com/jeffpaul) via [#38](https://github.com/10up/eight-day-week/pull/38), [#39](https://github.com/10up/eight-day-week/pull/39), [#42](https://github.com/10up/eight-day-week/pull/42), [#46](https://github.com/10up/eight-day-week/pull/46), [#48](https://github.com/10up/eight-day-week/pull/48), [#49](https://github.com/10up/eight-day-week/pull/49), [#50](https://github.com/10up/eight-day-week/pull/50))
- Bump WordPress version "tested up to" 5.3 (props [@adamsilverstein](https://github.com/adamsilverstein) via [#45](https://github.com/10up/eight-day-week/pull/45)).
- Documentation and deploy automation updates (props [@jeffpaul](https://github.com/jeffpaul) via [#38](https://github.com/10up/eight-day-week/pull/38), [#39](https://github.com/10up/eight-day-week/pull/39), [#42](https://github.com/10up/eight-day-week/pull/42), [#46](https://github.com/10up/eight-day-week/pull/46), [#48](https://github.com/10up/eight-day-week/pull/48), [#49](https://github.com/10up/eight-day-week/pull/49), [#50](https://github.com/10up/eight-day-week/pull/50)).

### Fixed
- WordPress.org translation readiness (props [@jeffpaul](https://github.com/jeffpaul), [@adamsilverstein](https://github.com/adamsilverstein), [@helen](https://github.com/helen) via [#41](https://github.com/10up/eight-day-week/pull/41))
- WordPress.org translation readiness (props [@jeffpaul](https://github.com/jeffpaul), [@adamsilverstein](https://github.com/adamsilverstein), [@helen](https://github.com/helen) via [#41](https://github.com/10up/eight-day-week/pull/41)).

## [1.1.0] - 2019-07-26
### Added
- German translation files (props @adamsilverstein, @maryisdead via #31)
- Plugin banner and icon images (props @chriswallace via #30)
- German translation files (props [@adamsilverstein](https://github.com/adamsilverstein), [@maryisdead](https://github.com/maryisdead) via [#31](https://github.com/10up/eight-day-week/pull/31)).
- Plugin banner and icon images (props [@chriswallace](https://github.com/chriswallace) via [#30](https://github.com/10up/eight-day-week/pull/30)).

### Updated
- Update dependencies in `package.json` and `composer.json` to current versions (props @adamsilverstein via #28)
- Update dependencies in `package.json` and `composer.json` to current versions (props [@adamsilverstein](https://github.com/adamsilverstein) via [#28](https://github.com/10up/eight-day-week/pull/28)).

### Fixed
- DateTimeZone setup: fall back to `gmt_offset` (props @adamsilverstein, @Jared-Williams via #32)
- PHP notices w/PHP 5.6 and fatals with PHP 7.2/3 (props @adamsilverstein via #28)
- DateTimeZone setup: fall back to `gmt_offset` (props [@adamsilverstein](https://github.com/adamsilverstein), [@Jared-Williams](https://github.com/Jared-Williams) via [#32](https://github.com/10up/eight-day-week/pull/32)).
- PHP notices w/PHP 5.6 and fatals with PHP 7.2/3 (props [@adamsilverstein](https://github.com/adamsilverstein) via [#28](https://github.com/10up/eight-day-week/pull/28)).

## [1.0.0] - 2015-11-16
- Initial Release

[Unreleased]: https://github.com/10up/eight-day-week/compare/master...develop
[Unreleased]: https://github.com/10up/eight-day-week/compare/trunk...develop
[1.1.2]: https://github.com/10up/eight-day-week/compare/1.1.1...1.1.2
[1.1.1]: https://github.com/10up/eight-day-week/compare/1.1.0...1.1.1
[1.1.0]: https://github.com/10up/eight-day-week/compare/9057a7f...1.1.0
[1.0.0]: https://github.com/10up/eight-day-week/commit/9057a7f310068676ef8a15e0ba0a395273f1cb98
16 changes: 8 additions & 8 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,19 +24,19 @@ For more on how 10up writes and manages code, check out our [10up Engineering Be

## Workflow

The `develop` branch is the development branch which means it contains the next version to be released. `stable` contains the current latest release and `master` contains the corresponding stable development version. Always work on the `develop` branch and open up PRs against `develop`.
The `develop` branch is the development branch which means it contains the next version to be released. `stable` contains the current latest release and `trunk` contains the corresponding stable development version. Always work on the `develop` branch and open up PRs against `develop`.

## Release instructions

1. Branch: Starting from `develop`, cut a release branch named `release/X.Y.Z` for your changes.
2. Version bump: Bump the version number in `eight-day-week.php`, `readme.txt`, `composer.json`, and `package.json` if it does not already reflect the version being released.
2. Version bump: Bump the version number in `eight-day-week.php`, `package.json`, and `readme.txt` if it does not already reflect the version being released. Update both the plugin "Version:" property and the plugin `EDW_VERSION` constant in `eight-day-week.php`.
3. Changelog: Add/update the changelog in both `readme.txt` and `CHANGELOG.md`
4. New files: Check to be sure any new files/paths that are unnecessary in the production version are included in `.gitattributes`.
5. Readme updates: Make any other readme changes as necessary. `CHANGELOG.md` and `README.md` are geared toward GitHub and `readme.txt` contains WordPress.org-specific content. The two are slightly different.
6. Merge: Make a non-fast-forward merge from your release branch to `develop`, then do the same for `develop` into `master` (`git checkout master && git merge --no-ff develop`). `master` contains the stable development version.
7. Test: While still on the `master` branch, test for functionality locally. If all is well, push to GitHub.
8. Release: Create a [new release](https://github.com/10up/eight-day-week/releases/new), naming the tag and the release with the new version number, and targeting the `master` branch. Paste the changelog from `CHANGELOG.md` into the body of the release and include a link to the closed issues on the `X.Y.Z` milestone (e.g. `https://github.com/10up/eight-day-week/milestone/2?closed=1`).
9. SVN: Wait for the [GitHub Action](https://github.com/10up/eight-day-week/actions) to finish deploying to the WordPress.org repository. If all goes well, users with SVN commit access for that plugin will receive an emailed diff of changes.
10. Check WordPress.org: Ensure that the changes are live on https://wordpress.org/plugins/eight-day-week-print-workflow/. This may take a few minutes.
5. Readme updates: Make any other readme changes as necessary. `README.md` is geared toward GitHub and `readme.txt` contains WordPress.org-specific content. The two are slightly different.
6. Merge: Make a non-fast-forward merge from your release branch to `develop`, then do the same for `develop` into `trunk` (`git checkout trunk && git merge --no-ff develop`). `trunk` contains the stable development version.
7. Test: While still on the `trunk` branch, test for functionality locally. If all is well, push to GitHub.
8. Release: Create a [new release](https://github.com/10up/eight-day-week/releases/new), naming the tag and the release with the new version number, and targeting the `trunk` branch. Paste the changelog from `CHANGELOG.md` into the body of the release and include a link to the closed issues on the `X.Y.Z` milestone (e.g. `https://github.com/10up/eight-day-week/milestone/2?closed=1`).
9. SVN: Wait for the [GitHub Action](https://github.com/10up/eight-day-week/actions) to finish deploying to the WordPress.org repository. If all goes well, users with SVN commit access for that plugin will receive an emailed diff of changes.
10. Check WordPress.org: Ensure that the changes are live on https://wordpress.org/plugins/eight-day-week-print-workflow/. This may take a few minutes.
11. Close milestone: Edit the [X.Y.Z milestone](https://github.com/10up/eight-day-week/milestone/#) with release date (in the `Due date (optional)` field) and link to GitHub release (in the `Description` field), then close `X.Y.Z` milestone.
12. Punt incomplete items: If any open issues or PRs which were milestoned for `X.Y.Z` do not make it into the release, update their milestone to `X.Y.Z+1`, `X.Y+1.0`, `X+1.0.0` or `Future Release`.
32 changes: 22 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,11 @@
# ![Eight Day Week Print Workflow](https://github.com/10up/eight-day-week/blob/develop/.wordpress-org/banner-1544x500.png "Eight Day Week Print Workflow")

> Optimize publication workflows by using WordPress as your print CMS. Eight Day Week provides a set of tools to manage your print workflow directly in your WordPress dashboard–right where your posts are! Primarily, it offers an interface to group, label, and manage the workflow status of posts in a printed "Issue".
> Optimize publication workflows by using WordPress as your print CMS.
[![Support Level](https://img.shields.io/badge/support-active-green.svg)](#support-level) [![Release Version](https://img.shields.io/github/release/10up/eight-day-week.svg)](https://github.com/10up/eight-day-week/releases/latest) ![WordPress tested up to version](https://img.shields.io/badge/WordPress-v5.3%20tested-success.svg) [![GPLv2 License](https://img.shields.io/github/license/10up/eight-day-week.svg)](https://github.com/10up/eight-day-week/blob/develop/LICENSE.md)
[![Support Level](https://img.shields.io/badge/support-active-green.svg)](#support-level) [![Release Version](https://img.shields.io/github/release/10up/eight-day-week.svg)](https://github.com/10up/eight-day-week/releases/latest) ![WordPress tested up to version](https://img.shields.io/badge/WordPress-v5.5%20tested-success.svg) [![GPLv2 License](https://img.shields.io/github/license/10up/eight-day-week.svg)](https://github.com/10up/eight-day-week/blob/develop/LICENSE.md)

## Table of Contents
* [Overview](#overview)
* [Features](#features)
* [Requirements](#requirements)
* [Installation](#installation)
Expand All @@ -14,14 +15,20 @@
* [Changelog](#changelog)
* [Contributing](#contributing)

## Overview

Eight Day Week provides a set of tools to manage your print workflow directly in your WordPress dashboard–right where your posts are! Primarily, it offers an interface to group, label, and manage the workflow status of posts in a printed "Issue".

![The Print Issue list table.](/.wordpress-org/screenshot-1.png)

## Features

### Create "Print Issues"

- Add and order sections, and articles within sections
- Assign article statuses specific to your print workflow

![The Print Issue editor, showing the sections and contained articles, as well as several modules at play.](http://ps.w.org/eight-day-week-print-workflow/assets/screenshot-2.png)
![The Print Issue editor, showing the sections and contained articles, as well as several modules at play.](/.wordpress-org/screenshot-2.png)

### Limit access to Print Roles

Expand All @@ -30,16 +37,25 @@ Two custom roles are added by this plugin to best model a real-world print team.
- The Print Editor role offers full access to the creation interfaces, such as Print Issue, Article Status, Print Publication, etc.
- The Print Production role offers read-only access to a Print Issues. The XML export tool is also available to Production users.

![The Users list table, showing the "Change print role to..." dropdown and "Print Role" column.](/.wordpress-org/screenshot-7.png)

### View a Print Issue in "Read Only" mode

- Circumvents the post locking feature by offering a read-only view of a print issue

![A Print Issue in "read only view". This view allows anyone with access to view a Print Issue without inducing a post lock, or being locked out by another editor. Note that the Export tools are still available in read only view.](http://ps.w.org/eight-day-week-print-workflow/assets/screenshot-4.png)
![A Print Issue in "read only view". This view allows anyone with access to view a Print Issue without inducing a post lock, or being locked out by another editor. Note that the Export tools are still available in read only view.](/.wordpress-org/screenshot-3.png)

### XML Export to InDesign

- Export XML files specifically formatted for import into InDesign

![Sample article XML export.](/.wordpress-org/screenshot-8.png)

Issue Statuses | Publications | Article Statuses
------------- | ----------------- | ------------
[![Editing of Issue Statuses](.wordpress-org/screenshot-4.png)](.wordpress-org/screenshot-4.png) | [![Editing of Publications](.wordpress-org/screenshot-5.png)](.wordpress-org/screenshot-5.png) | [![Editing of Article Statuses](.wordpress-org/screenshot-6.png)](.wordpress-org/screenshot-6.png)


## Requirements

* PHP 5.6+
Expand Down Expand Up @@ -80,24 +96,20 @@ Sample usage:
return implode( ', ', wp_list_pluck( my_get_post_authors_function( $post ), 'display_name' ) );
}

![Further down the page of the Print Issue Editor, showing buttons to add sections & articles. Each section has a Save button for convenience; all Save buttons simply save the entire Issue.](http://ps.w.org/eight-day-week-print-workflow/assets/screenshot-3.png)

### Print Issue Table

The information displayed in the list of Print Issues is filterable. Custom columns can be added via the following filter:
`Eight_Day_Week\Print_Issue_Columns\pi_columns`. Note that this is a convenience filter, the base filter is `manage_edit-print-issue_columns`. See `includes/functions/print-issue-columns.php` for sample usage.

![The Print Issue list table](http://ps.w.org/eight-day-week-print-workflow/assets/screenshot-1.png)

### Article Export

The export of posts in a Print Issue is highly customizeable, from the file name of the zip, to the file name of the individual files, to the contents of the files themselves. The best reference would be to read through `includes/functions/plugins/article-export.php`. [Here's](https://gist.github.com/joshlevinson/4a2c3ed78b21b3c54eba) a few examples used on the *Observer*.
The export of posts in a Print Issue is highly customizeable, from the file name of the zip, to the file name of the individual files, to the contents of the files themselves. The best reference would be to read through `includes/functions/plugins/article-export.php`. [Here's](https://github.com/10up/eight-day-week/wiki/Sample-Eight-Day-Week-filters-for-the-Observer) a few examples used on the *Observer*.

## Known Caveats/Issues

### Gutenberg exports

Gutenberg-based exports include some additional metadata/details that a Classic Editor-based export does not. [Gutenberg stores block data in HTML comments](https://developer.wordpress.org/block-editor/key-concepts/#delimiters-and-parsing-expression-grammar), so you'll notice those comments (in the form of `<!-- "Gutenberg block data" -->`) appearing in the Eight Day Week XML export. Note that the XML is still valid--you can test and confirm that yourself using an [XML validator](https://www.xmlvalidation.com/)--though depending on your version of InDesign you may get different results upon importing a Gutenberg export compared to a Classic Editor export. Our testing showed that those HTML comments in a Gutenberg export did not affect the import into InDesign however. You can test how this works in your version of InDesign with these sample XML files: [Gutenberg XML](https://gist.githubusercontent.com/adamsilverstein/3a9af64f4827b0ffcba963fd4b6a380a/raw/0513c4dd7cbd45b54c644a6aa9cbaaf269659b8d/classic.xml), [Classic Editor XML](https://gist.githubusercontent.com/adamsilverstein/fafae070f20232d1061c5517369a8f06/raw/b74310e18125a045cea213513fba435eee1545ff/classic2.xml).
Gutenberg-based exports include some additional metadata/details that a Classic Editor-based export does not. [Gutenberg stores block data in HTML comments](https://developer.wordpress.org/block-editor/key-concepts/#delimiters-and-parsing-expression-grammar), so you'll notice those comments (in the form of `<!-- "Gutenberg block data" -->`) appearing in the Eight Day Week XML export. Note that the XML is still valid--you can test and confirm that yourself using an [XML validator](https://www.xmlvalidation.com/)--though depending on your version of InDesign you may get different results upon importing a Gutenberg export compared to a Classic Editor export. Our testing showed that those HTML comments in a Gutenberg export did not affect the import into InDesign however. You can test how this works in your version of InDesign with these sample XML files: [Gutenberg XML](https://raw.githubusercontent.com/wiki/10up/eight-day-week/BlockEditor-sample.xml), [Classic Editor XML](https://raw.githubusercontent.com/wiki/10up/eight-day-week/ClassicEditor-sample.xml). You can also test how this works with full ZIP exports of Print Issues containing a [Block Editor sample](https://raw.githubusercontent.com/wiki/10up/eight-day-week/BlockEditor-SampleExport.zip) or a [Classic Editor sample](https://raw.githubusercontent.com/wiki/10up/eight-day-week/ClassicEditor-SampleExport.zip).

## Support Level

Expand Down
6 changes: 5 additions & 1 deletion assets/js/scripts.js
Original file line number Diff line number Diff line change
Expand Up @@ -405,7 +405,11 @@
$insert_section: function (name, id) {
var new_section = $('[id^="pi-sections-template"].postbox').first().clone();
new_section.attr('id', 'pi-sections-box-' + id);
new_section.find('.hndle > span').text(name).attr('contenteditable', 'true');
if (new_section.find('.hndle > span').length > 0) {
new_section.find('.hndle > span').text(name).attr('contenteditable', 'true');
} else {
new_section.find('.hndle').text(name);
}
new_section.addClass('js');
new_section.removeClass('hide-if-js');
new_section.find('.section_id').val(id);
Expand Down
Loading

0 comments on commit d8f3080

Please sign in to comment.