wiki in Focus Areas

[Greg Rundlett <greg.rundlett@oasis-open.org>]

-----BEGIN PGP SIGNED MESSAGE-----
Hash: SHA1

Carol,

I did some research (http://drupal.org/search/node/freelinking),
looked at the editorial board issues
(http://dita.xml.org/editorial-board-issues), and your messages, wrote
documentation (this message) and did some implementation (some
downloads) on the wiki aspects of the Focus Area.

The two choices discussed
(http://wiki.bryght.com/wiki/drupalwikirecipe) in various forums at
drupal and bryght surrounded either the wiki.module
(http://drupal.org/project/wiki), or the freelinking.module
(http://drupal.org/project/freelinking).  In either case, it appears
that better versioning and permissioning support is available in the
4.7 release of Drupal which therefore solves some of the known issues
with "wiki" functionality in Drupal.  What's more, there are
improvements to the freelinking module in 4.7, which doesn't seem to
be listed on the module page, but are discussed in the 'extensions'
page http://drupal.org/node/25986.  We are currently running the 4.6
release of Drupal.  We are not ready to upgrade to 4.7 (I've got to
evaluate the impact and time required to do the upgrade, and the
software is actually still in 'beta'  On January 26th, the 4th beta of
4.7 was released http://drupal.org/drupal-4.7.0-beta4).  I would like
to do that evaluation b/c it would appear that 4.7 brings many
improvements to Drupal overall.  I estimate it would take me a few
hours to review the code changes in 4.7, and understand how those
changes might impact us.  I would likely need a day or two of Steve's
time in setting up more infrastructure (db management tools, secondary
site, SVN repository) so that doing an assessment would be easy.

In comparing wiki v. freelinking, I have not been able to determine
which might be better.  Freelinking does NOT provide wiki syntax (such
as * for a bullet).  Freelinking does provide a wysiwyg interface for
creating new content at previously unused addresses so that authors
can easily create links to new content on the fly.  Neither the wiki
module nor the freelinking module has been updated to version 4.7 yet
(at their project pages), which means they are not as actively
maintained as other modules.  NOTE that actually pulling the 4.7
Drupal code might reveal that the project page(s) are out of date with
the code.   According to it's project page, Freelinking has only been
released in 4.5 format.  This probably accounts for the reason why
freelinking administration is not working in our 4.6 release.  I would
need to find out the database schema changes that occured between
versions and patch freelinking to make it compatible with 4.6.  (Or
after more research it looks like 4.6 code is available somewhere)

Third, the 'wikipage.module' might be another option, hosted outside
drupal.org
http://drupal.org/node/40160
This discussion http://drupal.org/node/42099 of the 'true wiki in
Drupal' says that "wikipage" combines with "freelinking", and hence is
different than 'wiki'

http://wiki.bryght.com/wiki/wiki-recipe-for-wiki-module gives us the
steps for setting this up

With freelinking, some suggest using Book as the content type, while
others disagree because book imposes hierarchy.  I believe for DITA,
that the "page" content type would be better than "book".   So, I
would follow that path if using freelinking.

Looking at the 'freelinking' recipe on the Bryght site (listed below),
I noticed that there were some missing module dependencies which I've
downloaded.  Those need to be installed if we want to enable
freelinking in 4.6.

~    urlfilter automatically converts links in content into hyperlinks
~    http://drupal.org/project/urlfilter The latest is 4.7.0
~    http://drupal.org/handbook/modules/urlfilter

~    nodeprivacy_by_role http://drupal.org/project/node_privacy_byrole
~    http://drupal.org/handbook/modules/node_privacy_byrole
~    This module is not available yet in 4.7 (but may be obsoleted due
~    to core changes in 4.7?)

~    Although I've downloaded this code, it has not yet been installed,
~    or even looked at.


~        Recipe for using the Wiki Module to create wiki functionality

The WikiModule <http://wiki.bryght.com/freelinking/WikiModule> (on
drupal.org <http://drupal.org/project/wiki>) is perhaps the first
thing people will choose to use. Choose this when you want an input
filter that implements plain text-based wiki markup. Unfortunately,
new wiki links are hardcoded to be story nodes (feature request to
make this a setting <http://drupal.org/node/31108>), so you must give
all roles that you want to wiki access to creating story nodes.
NodePrivacyByRoleModule
<http://wiki.bryght.com/freelinking/NodePrivacyByRoleModule> is the
easiest way to allow editing of any story nodes by certain roles.

~   1. install additional modules
~          * wiki
~          * node_privacy_by_role
~   2. turn on modules (Admin > Modules)
~          * go to Admin > Settings > node_privacy_by_role
~          * click "Enable"
~   3. set up wiki format input
~          * go to Admin > Input Formats
~          * under Add new input format, type in a name (e.g. Wiki Markup)
~          * click "Add input format" to save, then check boxes for
~            which roles can access it, then click "Save input formats"
~          * click "configure" next to the Wiki input format
~          * on next screen, check off "Enabled" next to Wiki Text
~            filter and click "Save configuration"
~   4. turn on who can access what
~          * go to Admin > Access and give "create story" and "edit own
~            story" permission to those roles you wish to allow to wiki
~          * go to Admin > Content > Configure > Content Types > Story
~          * in the node privacy section, check off edit for all roles
~            that you wish to be able to wiki
~          * check of "Create Revision" so that revisions are
~            automatically created
~          * optionally give set permissions control to a higher admin
~            role so that individual wiki story nodes can be locked down

And you're done! You may optionally want to go to Admin > Menu and
edit the /create content > story/ menu item to change the name to wiki.


~        Recipe for using the Freelinking Module to create wiki
~        functionality

http://wiki.bryght.com/wiki/wiki-recipe-for-freelinking-module

Use the FreelinkingModule
<http://wiki.bryght.com/freelinking/FreelinkingModule> to implement
wiki-style functionality if you want to pair page creation and linking
with a rich text editor (e.g. TinyMceModule
<http://wiki.bryght.com/freelinking/TinyMceModule>, HtmlAreaModule
<http://wiki.bryght.com/freelinking/HtmlAreaModule>, FckEditorModule
<http://wiki.bryght.com/freelinking/FckEditorModule>). This can also
be useful if you already have a different node_access module enabled
other than NodePrivacyByRoleModule
<http://wiki.bryght.com/freelinking/NodePrivacyByRoleModule>, since
BookModule <http://wiki.bryght.com/freelinking/BookModule> can be used
to allow editing of all book pages. Lastly, no new input filter is
required, since freelinking can easily be added to an existing format.
The below assumes you already have a rich text editor installed, and
have Full HTML set as the default input format for all users, as is
typical when using WYSIWYG editors.

~   1. install additional modules
~          * freelinking
~          * urlfilter (optional)
~          * nodeprivacy_by_role (optional, only needed if you want to
~            use "page" instead of books)
~   2. turn on modules (Admin > Modules)
~          * go to Admin > Settings > freelinking
~          * set both newly created nodes and places to search to
~            /book/ (look up exact wording)
~   3. set up input formats
~          * go to Admin > Input Formats
~          * click "configure" next to the Full HTML input format
~          * on next screen, check off "Enabled" next to the
~            freelinking and urlfilter filters and click "Save
~            configuration"
~          * urlfilter is listed as optional; it enables automatic
~            linking of URLs and email addresses, which is common wiki
~            functionality, and is also compatible with rich text editors
~   4. turn on who can access what
~          * go to Admin > Access and give all book permissions
~            (/create/,/edit/, and /maintain books/) to those roles you
~            want to wiki
~          * feature request: modify book module so there is a separate
~            "maintain outline" permission -- don't give this to wiki
~            roles, and they won't be able to put random nodes into a
~            book outline (but can still create/edit book pages to
~            change their hierarchy)

And you're done! You may optionally want to go to Admin > Menu and
edit the /create content > book/ menu item to change the name to wiki.


- --
Gregory S. Rundlett
Manager
Technology Services
OASIS
"Advancing E-Business Standards Since 1993"
http://www.oasis-open.org
(978) 667-5115 x 205

-----BEGIN PGP SIGNATURE-----
Version: GnuPG v1.4.1 (GNU/Linux)
Comment: Using GnuPG with Thunderbird - http://enigmail.mozdev.org

iD8DBQFD62BGzdIuXNTVHCgRAs9GAJ0UQJDI5QVsjoovZR26ZydSCjxLCgCfYYsI
pvQEs9nmCPobvu1k1fONj5Y=
=Q3JF
-----END PGP SIGNATURE-----