Plug:mjahn:LexiWord

From phpCMS

Jump to: navigation, search

Contents

[edit] LexiWord

[edit] Overview

title         : Lexiword
version       : 0.3
author        : (c) by Martin Jahn (mjahn)
licence       : GPL
description   : A plugin for phpCMS to cover acronyms and abbreviations
phpCMS version: 1.2.x
please post any errors, discussions etc. about this plugin to the
phpCMS forum at http://www.phpcms.de or mail (at) martin-jahn.info

[edit] Licence

This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.

[edit] Download

The plugin can be downloaded from the plugin-website on http://martin-jahn.info/phpcms/lexiword/

[edit] Plugin description

The plugin Lexiword is a simple script, that uses a glossaryfile (i.e. a formatted contentfile) to extract the terms and their descriptive text and an optional link. It takes these terms and replaces them in the contentfields of the current contentfile.

[edit] Plugin installation

Copy the pluginfile into the plugindirectory of your phpCMS installation. Then include a PLUGIN-call into the template and change the path to the glossaryfile in the pluginfile lexiword.php to fit your needs.

[edit] Plugin configuration

[edit] Exclude content in special tags from being replaced

It is also possible to prevent the content in special tags (i.e. title, a, textarea, input and so on) from being replaced with their descriptive text.

[edit] Optional link to an external page

You may give an additional link to an external page within the glossaryfile. Just place another <dd>-Tag with the full URI to the destination page.

[edit] Structure of the glossaryfile

The glossaryfile can be used as a normal contentfile. I use it as glossary in my website. It just have to wrap the terms with the follwoing structure:

<dl>
<dt>Term</dt>
  <dd>Descriptive text related to the term</dd>
  <dd>optional link related to the term</dd>
<dt>another Term</dt>
  <dd>Descriptive text related to the another term</dd>
  <dd>optional link related to the another term</dd>
</dl>

Main Page: Main Page | Top Page: Plugin Documentation MainPage

Personal tools