Add event when saving drafts and make dw_locktimer reusable by plugin JS #2413
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This is useful for plugins that want to replace the default editor and use their own editor instead and need to do some work before their output can be saved as syntax.
Plugins may want to add further fields to be present when saving drafts
This change is useful for plugins that may want to implement their own toolbar (and thus hide the default toolbar), but still would like to let the locktimer set the draft status.
splitbrain
approved these changes
Jun 6, 2018
inc/common.php
Outdated
| } | ||
|
|
||
| $event->advise_after(); | ||
| return (bool)$draft['hasBeenSaved']; |
There was a problem hiding this comment.
hasBeenSaved will be uninitialized when an event prevented the default. It should probably be initialized as false further up.
This can be used by plugins to execute some js functionality that should be timed to the saved draft
Klap-in
reviewed
Jun 7, 2018
lib/scripts/locktimer.js
Outdated
| @@ -55,6 +58,15 @@ var dw_locktimer = { | |||
| dw_locktimer.fieldsToSaveAsDraft.push(selector); | |||
| }, | |||
|
|
|||
| /** | |||
| * Add a callback the gets executed the post to renew the lock / save the draft returns successfully | |||
There was a problem hiding this comment.
I do not get the meaning. Could you reformulate 'the gets executed'?
There was a problem hiding this comment.
Ah, this is a typo. the -> that
I will try to explain it in a bit more detail in the body of the doc block
What exactly was I thinking when writing the original line? A third of the words is missing and it isn't even proper English 🤨
If a plugin does another init() to attach the dw_locktimer to its own editor, then the default callback would be added a second time, causing unexpected and undesired behavior.
micgro42
added a commit
to cosmocode/dokuwiki-plugin-prosemirror
that referenced
this pull request
Jun 7, 2018
This requires dokuwiki/dokuwiki#2413 to work
splitbrain
reviewed
Jun 7, 2018
| ); | ||
| ).done(function dwLocktimerRefreshDoneHandler(data) { | ||
| dw_locktimer.callbacks.forEach( | ||
| function foo(callback) { |
There was a problem hiding this comment.
Does this function have to be named? Wouldn't an anonymous function work?
Merged
|
Closed in favor of #2415 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Some plugins that completely replace the editor may still want to have their edit-progress be saved as drafts by the default DokuWiki draft-saving process.
COMMON_DRAFT_SAVEdw_locktimerto allow posting further fields to the server when saving drafts in the background while editing#draft__statusout of the toolbar<div>so we can hide the toolbar without hiding the draft status