Dotclear

Last modified 14 years ago

Français

kezako

Allows the inclusion of a description in many languages of tags, categories, etc.

Author/Contributors?

Development

Bugs and features requests

Repository

Recent Changes

[2700] by franck on 10/02/10 14:23:09

Remise en place de l'auteur original dans les entêtes de licence

[2695] by franck on 10/02/10 06:17:33

dc 2.2 compliance

[1703] by kozlika on 10/25/09 09:33:19

Kezako: typo, lignes vides en fin de fichier .php

Documentation

The Kezako plugin (french word meaning "what is that?") is a plugin that was designed to fill two specific gaps in Dotclear 2 interface:
  • One could not describe tags. When a selection of articles is done based on a keyword, such as debian or photo, one had only the keyword written at the top with no further explanations.
  • One could describe a category, but only in one language. Adding a language management could be done through some complicated work (which I did).

I implemented such a system, allowing to attach a description in one or more languages to a specific tag or category (thus replacing the existing system for categories). It can in fact be attached at anything (but nothing was done to exploit it in a context other than a tag or a category). This is the Kezako plugin.

This system is flexible enough so that if nothing is specifically defined for some tag or category, the old system is used instead (displaying the tag or the category's description). There is no mandatory description for each and every tag.

This extension for Dotclear 2 requires the modification of one page of the theme used for the blog (it is now very easy with the theme editor included with Dotclear 2). It is necessary in the tag.html page, where the description of the tag should be, to surround the current presentation of the tag by <tpl:TagDescription>...</tpl:TagDescription>. For example: 

<tpl:TagDescription><h2>{{tpl:lang Keyword}} - {{tpl:MetaID}}</h2></tpl:TagDescription>

This extension adds a table in the database. It was not tested with PostgresQL (but I do not see why it should not work, I use only very simple operations).

The maintenance page for this plugin is located at this address: http://jean-christophe.dubacq.fr/post/kezako.

Installation

Use the zipped file attached to this post. Go then to the administration area, and give the editor permission to the users allowed to attach descriptions to tags or categories. The Kezako menu should appear in the administration interface for these users. Do also the theme modification mentioned above. If the table was not created, you probably did not go to the administration area.

source:/plugins/kezako/doc/kezako-settings.png

There are two settings for this plugin: one that allows to override the category description, and one that allows to use descriptions in several languages (and not only in the blog's language). Since most blogs are monolingual and that in this case, the category override is not useful, both of these settings are disabled by default. For a full usage of this plugin, they can be enabled. Remark that the language of your blog must be set if you use only the blog's language.

I did not find any matching plugin elsewhere.

The current version of this plugin is 0.8 (local svn 396).

This plugin is licensed under GPL version 2.0.

Usage

source:/plugins/kezako/doc/kezako-list.png

In the "Blog" section of the administration area, you access the two parameters and the list of all known descriptions. You can modify or delete descriptions, or insert a new one. When you insert or modify a description, you use the usual visual editor of Dotclear. The identifier of the description for a tag is the tag itself, the language is to be chosen from the menu (if you chose to use the many languages option). Your description is completely up to you. Remark that for tags, it will replace the former display (Keyword - tag), not be appended to it.

source:/plugins/kezako/doc/kezako-entry.png

If a description for a category is not found by Kezako in its own tables, the description internal to Dotclear is used instead. Thus, Kezako has no visible effect on a blog where the plugin is installed but unused.

To tell me about a bug or helping this plugin

The best way is to contact me by mail (for a bug) or leave a comment (telling me you tested this extension) at the maintenance page. In case of an update, I will modify the maintenance page accordingly.

Note: this changelog is not complete, automatically generated and probably not even informative before 2009.

  • Local SVN release 396 (jcdubacq,2009-10-03)
    • Fix licence blocks
  • Local SVN release 380 (jcdubacq,2009-05-10)
    • Reduce db fields sizes, hoping to fix #170
  • Local SVN release 366 (jcdubacq,2009-04-30)
    • Fix licence blocks
    • Clean up code
    • New design for administration interface
  • Local SVN release 270 (jcdubacq,2008-12-22)
    • Add common filtering attributes
  • Local SVN release 251 (jcdubacq,2008-11-13)
    • Use categories descriptions by default, fix doc
  • Local SVN release 196 (jcdubacq,2008-07-19)
    • Reindent kezako plugin, clean, fix, and generally make better. Document it, also.
  • Local SVN release 168 (jcdubacq,2008-05-06)
    • Order plugins and themes
  • Local SVN release 83 (jcdubacq,2008-02-28)
    • Add the editor permission support
  • Local SVN release 76 (jcdubacq,2008-02-27)
    • Initial creation of Kezako plugin

To do

  • Check that it works without the dctranslation framework (it should)
  • Allow the disabling of categories to work for multiblog.

Sites map