1 user Sign-in to change your status

A plugin that reads from the schema.yml file and generates a doku-wiki-like syntax to describe it Model

• Repository
• Download package
• Browse source

Plugin that helps documentation of data model in a symfony project using Propel ORM. Basically, what this plugin does is to parse config/schema.yml file and go through its classes and fields, generating a description using dokuwiki's syntax. The output might be seen on screen or be dumped to a specific file.

Developers

Name	Status	Email
CUESTA LUENGO, Jose Nahuel	lead	ra.ude.plnu.ipsec.ollorrased <<ta>> atseucn
DELUCCHI, Luciano	developer	ra.ude.plnu.ipsec <<ta>> ihcculed

License

Copyright (c) 2008 Luciano Delucchi & Jose Nahuel Cuesta Luengo

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Releases for sf 1.1

Join this plugin team

Other releases

Release 1.0.0 - 07/11/2008

sfWikify plug-in

sfWikify helps developers' job when dealing with documentation of a project's data model, by creating a description of the schema in a dokuwiki syntax.

• Automatically parses your config/schema.yml file.

• It is compatible with symfony's empty columns.

• It might be internationalized by editing a simple doku_i18n_<CULTURE>.yml file

Installation

• Install the plug-in

  symfony plugin:install sfWikifyPlugin

• Edit your schema.yml file and add description keys to the model, the classes and/or the fields:

  ## Description for the whole data model:
  description: Data model for fake project.
  
  classes:
    ClassA:
      tablename:            class_a
      ## Description for a class:
      description: >
        ClassA represents objects of A class.
      columns:
        id:                 ## You might omit empty columns' description
        name:
          type:             varchar(255)
          required:         true
          ## Description for a single field:
          description:      The name of the object.
        size:
          type:             integer
          description:      The size of the object. It might be 0.
        created_at:
        updated_at:
  

• Run the task:

  symfony doku:wikify en doc/doku.txt
  

  or simply:

  symfony doku:wikify en
  

• You're done.

Hey! My culture isn't bundled!

If your culture isn't currently bundled with the plugin (at the moment, only es and en are supported), you might create a i18n file for the plugin.

You just have to place it anywhere in the project and the plugin will try to find it.

The requirements for this are:

• The file must be named like doku_i18n_<CULTURE>.yml where is the culture you want to support.

• The file must have the following structure (you can use the ones bundled with the plugin as an example):

  ## en culture internationalization file
  messages:
    title:            Data model
    fields:           Fields
    type:             Type
    default:          Default value
    primary_key:      Primary key
    created_at:       Object's creation date
    updated_at:       Object's last update date
    foreign_reference: References
  

• That's it! Unless you feel like collaborating with us, you can email us at ncuesta at desarrollo dot cespi dot unlp dot edu dot ar and send the i18n file ;)

Changelog

2008-11-07 | 1.0.0

• ncuesta: plug-in added to symfony