Edi

Summary: Structured page editor
Version: 20150815
Prerequisites:
Status: Planned
Maintainer: Petko
Categories: Uncategorized
Users: (view? / edit)
Discussion: Edi-Talk

Structured page editor.

Recipe not yet fully functional, work is in progress.

Questions answered by this recipe

Wiki markup appears complex and hard to learn for new authors. Is there a simpler, easy to learn way to edit wiki pages?

Description

Edi is a "structured page editor". It facilitates the editing of individual blocks/sections within the structure of the wiki page. It differs from other WYSIWYG editors, because it allows only limited configurations. Nevertheless, it offers the most often used features for a general purpose content editing, and work with it is intuitive. The authors see what they're about to get.

A major inconvenience of WYSIWYG editors is that the content is stored as HTML code which is difficult to search and almost impossible to edit by hand. Edi actually saves the page content in a wiki text very similar to the regular PmWiki markup. Advanced authors could edit an Edi page by hand.

Installation

  • Get edi.zip.
  • Place the file "edi.php" in your "pmwiki/cookbook" directory.
  • Place the folder "edi" in your "pmwiki/pub" directory.
  • Add to config.php the following line:
include_once ('cookbook/edi.php');

Usage

In a wiki page source, place the Edi markup:
{ { { [ =
!! A heading
= ] } } }

Save the page. When browsing a page with Edi elements, you can edit those. Click on the "Edit" button above or below the element to enter into editing mode. At the right top of every paragraph, heading, table cell or other editable element, there is a small down arrow: click on it to open a menu.

Configuration

You can disable some features of Edi.

To disable the Preformatted text feature, add to config.php:
$Edi['EnablePre'] = 0;

To disable the WikiText feature, add to config.php:
$Edi['EnableWikiText'] = 0;

To disable the Table editor, add to config.php:
$Edi['EnableTable'] = 0;

Notes

Currently the recipe is in pre-alpha quality. Some features may not work, or may be buggy. It may change substantially. Do not use it on a production website.

Change log / Release notes

Version Changes
20150815 Rework of the editor not to use a textarea, some of the previously available features need updates and will not work.
20150804 Pre-alpha public release, ready to be tested.
20150703 Creation of the recipe framework.

kn mljùSee also

WikiText block
Cookbook /
EditHelp  Easier editing with automatic detection and insertion of some wiki markups (Experimental)
EditHelp-Talk  Talk page for EditHelp.
NetstreamsCMS  A CMS (Content Management System) extension for pmwiki features different page-types (article, blog, comment issues), separation of content and layout, basic workflow capabilities, content-type based authentication and wysiwyg editing. (Experimental)
NetstreamsCMS-Talk  Talk page for NetstreamsCMS.
NewsMaster  How to handle newsletters and other mailings (very nicely working (although the admin side is still in test))
RecentChanges  
RichEdit  WYSIWYG editor (Abandoned)
RichEditBugs  
TbsDynamicContent  insert dynamic contents in your pmWiki page using TinyButStrong template engine. (in active use)
Toggle-Talk  Discussion of Toggle
Wikiwyg  Integrate Wikiwyg into PmWiki for WYSIWYG editing (pre-alpha)
Worse  Simple WYSIWYG editing for PmWiki (experimental)
WYSIWYG-donations  
WYSIWYGFundDrive  Pledge card for PmWiki WYSIWYG development
PmWiki /
BasicEditing  PmWiki's basic edit syntax
DesignNotes  Some of the features and notes about PmWiki's design decisions
FailureStories  When things don't go as planned
PmWiki101  This page aims to tell you how to get started using PmWiki
PmWikiFeaturesAlt  
Questions  Ask your questions about PmWiki here, after checking the documentation index and FAQ
RecentChanges  
RoadMap-Talk  Preliminary thoughts and discussion for PmWiki 2011 version 3?
Skins  Change the look and feel of part or all of PmWiki
Support  Get support from the PmWiki core developer
WYSIWYG  Notes about WYSIWYG support in PmWiki
WYSIWYG-Talk  Talk page for WYSIWYG.

Contributors

Recipe written and maintained by Petko.

Comments

See discussion at Edi-Talk.

User notes? : If you use, used or reviewed this recipe, you can add your name. These statistics appear in the Cookbook listings and will help newcomers browsing through the wiki.

";

Edit DeleteDelete row

H2 H3 H4

Numbered Bulletted

Move up

Move down

Move list up

Move list down

Move row up

Move row down

Move table up

Move table down

Add paragraph

Add heading

Add list item

Add list

Add table row

Add table

Add <pre> block

Add WikiText