Documentation
| Documentation | |
| Introduction | |
| Intention | Whis this core-replacement for the original Website Baker WYSIWYG-Module, it is possible to keep a history of all changes of WYSIWYG sections, and to have a working-copy (a draft) besides the published content. |
| Requirements | Website Baker Version 2.7 or 2.8 |
| Definition of Terms | Short explanation of relevant terms. |
| Installation | |
| First installation | How to install the Module the first time. |
| Update this module | How to update this Module. |
| After Website Baker update | How to re-install the module after Website Baker was updated, in case it was installed before. |
| Usage | |
| After installation | After successfull installation, you will notice a new checkbox-element labeled "Enable working-copy" in the upper left corner of each WYSIWYG-section. |
| If a working copy is present | If a working-copy is present, the controls above the Editor changes as follows |
| History | See History View |
Introduction
| Intention | Whis this core-replacement for the original Website Baker WYSIWYG-Module, it is possible to keep a history of all changes of WYSIWYG sections, and to have a working-copy (a draft) besides the published content. |
| Requirements | Website Baker Version 2.7 or 2.8 |
| Definition of Terms | Short explanation of relevant terms. |
Intention
Whis this core-replacement for the original Website Baker WYSIWYG-Module, it is possible to keep a history of all changes of WYSIWYG sections, and to have a working-copy (a draft) besides the published content.
Keep in mind that the history stores HTML-source only! That is, it won't store e.g. images in history.
Definition of Terms
Short explanation of relevant terms.
| history | a List of old versions and content of WYSIWYG-sections. |
| published content | the content of a WYSIWYG-sections that is displayed while visiting the site. |
| editor content | the actual content that is displayed inside the editor-window, saved or unsaved. |
| working-copy | a draft, that exists besides the published content of an WYSIWYG-section, and that is visible internal only. |
Installation
| First installation | How to install the Module the first time. |
| Update this module | How to update this Module. |
| After Website Baker update | How to re-install the module after Website Baker was updated, in case it was installed before. |
First installation
How to install the Module the first time.
- unzip wysiwyg_history_2.7.x.x.zip manually
- copy all unpacked files to your server: wb/modules/wysiwyg, overwrite the original files
- call the included upgrade-script: http://www.example.org- /modules- /wysiwyg- /upgrade.php
- delete the upgrade-script
- reload modules (Add-ons -> Advanced: reload modules)
Update this module
How to update this Module. In fact, these steps are the same as for first installation:
- unzip wysiwyg_history_2.7.x.x.zip manually
- copy all unpacked files to your server: wb/modules/wysiwyg, overwrite the original files
- call the included upgrade-script: http://www.example.org- /modules- /wysiwyg- /upgrade.php
- delete the upgrade-script
- reload modules (admin-tools: reload modules)
After Website Baker update
How to re-install the module after Website Baker was updated, in case it was installed before.
- update Website Baker from 2.7 to 2.8 as usual
- unzip wysiwyg_history_2.7.x.x.zip manually
- copy all unpacked files to your server: wb/modules/wysiwyg, overwrite the original files
- call the included upgrade-script: http://www.example.org- /modules- /wysiwyg- /upgrade.php
- delete the upgrade-script
- reload modules (admin-tools: reload modules)
Usage
| After installation | After successfull installation, you will notice a new checkbox-element labeled "Enable working-copy" in the upper left corner of each WYSIWYG-section. |
| If a working copy is present | If a working-copy is present, the controls above the Editor changes as follows |
| History | See History View |
After installation
After successfull installation, you will notice a new checkbox-element labeled "Enable working-copy" in the upper left corner of each WYSIWYG-section. In later versions this is called "Enable extended controls".
Activate that checkbox to make the additional controls visible.
The Controls below the editor consists of
| Comment | Enter a comment to describe the latest changes. |
| Publish changes | Save the actual content from editor as published content. (The default save operation) |
| Save old content in History before | Mark this to have the old content saved into history before saving the editor content. |
Additionally, this will create a "fixed" history entry which will not be deleted automatically if "Save old content in history automatically on every change" is activated and "max" is set to a value larger "0".
| Save as working copy | Save the actual content from the Editor as working-copy. Unsaved changes will be copied, too. |
| Save old content in history automatically on every change | Mark this to have the old content saved into history automatically every time the page is saved. |
| max | Keep only this number of old versions in history. Older ones will be deleted. Use 0 for no limit. |
Additionally, there are some Links in the upper right
| Manage History | Switch to history view. |
| Create working copy | Switch to working-copy, and copy the actual content from Editor into the working copy. You have to click save to actually create the working copy. Note that unsaved changes will be lost if you didn't save the working-copy! |
If a working copy is present
If a working-copy is present, the controls above the Editor changes as follows
In the upper left, the string "Published content" with green background indicates that this is the actual published content, while the link in the upper right corner changes to "Go to working copy".
While in the working-copy view, the string "Working copy" with red background indicates that this is the working-copy.
The links upper right changes to "View" to preview the actual working copy, and "Go to published content" to switch back to published content.
Additionally, the Controls below the edior changes to
| Publish changes | Save the actual working-copy as published content. The old published content will be saved to history automatically. The working-copy itself will be deleted. |
| Save as working copy | Save the actual content from the editor as working-copy again. (The default save operation for a working-copy) |
| Delete working copy | Delete the working-copy. Note that the working-copy is not saved to history! |
History
See History View