plugin

From twext

Jump to: navigation, search

PHP5 PLUGIN CORE FOR TWEXTER

Contents

[edit] MILESTONES

  1. SIMPLE CORE PLUGIN ARCHITECTURE
  2. PLUGIN BASIC TWEXTER (integrate with existing working tool)
  3. MAKE IT WORK AT HTTP://TEST.TWEXT.COM
  4. COMMENT COMPLETELY IN CLEAR ENGLISH
  5. STATE PROGRAM LOGIC IN PSEUDOCODE OR UML
  6. SIMPLIFY API PAGE (http://twext.cc/dev/php/api/design.php3)
  7. PLUGIN LYRIC CHUNKSTER (include or separate bid)
  8. SIMPLE DBMS ie MYSQL
  9. SHARE AT SF.NET/PROJECTS/TWEXTER

[edit] TWEXTER

twexter software formats bifocal text for language learners.. twext format subtly aligns known language translations with chunks of foreign language text.. with UniCode, twexter software can work between text in many languages.. so twexter may prove useful to language learners.. see:

image:2b8.png

[edit] PHP5

we will work together to simplify http://twext.cc/go/php3_core, make new demo work in php5, plugin http://twext.cc/twexter, plugin http://twext.cc/go/lyric_chunkster, connect MYSQL, test.. we'll keep it simply simple yet anticipate future plugins to extend twexter services in PHP5

[edit] PLUGIN CORE

image:PluginCore.png

existing php3 core for ancient http://twext.cc/go/twexter software needs simple modern PHP5 solution to enable collaborative development.. we wanna be able to easily PLUGIN (or unplug) various tools.. for example:

[edit] PLUGIN: BASIC TWEXTER

basic firefox twexter functional http://twext.cc/twexter demo done by Waqas Hussein in PHP/AJAX/CSS from http://twext.cc/dev/twexterBASIC.html spec.. the source code is open at http://sf.net/projects/twexter .. you need to PLUGIN this basic twexter function to your PHP5 plugin core..

[edit] PLUGIN: LYRIC CHUNKSTER

http://twext.cc/go/lyric_chunkster will plug into core, chunk text as per http://twext.cc/method.html, get http://translate.google.com translations, put in http://twext.cc/twexter.. so it'll be lots easier to get text twext.. you may bid on lyric chunkster as an add-on (or farm-out).. the point here and now is deliver a core system other developers can use to plugin simple functions to core, ie lyric chunkster..

[edit] PLUGIN?: MYSQL

with working chunkster and twexter, users may wanna store and find data.. probably stored in MYSQL database, with few fields as possible for starters.. to simplify, for example, we may limit the system to multiple anonymous users managing a single set of preferences..

[edit] MINIMAL MULTILINGUAL MANAGEMENT

http://twext.cc/go/18 in the future may help manage multilingual twext, with variable language user interface.. our PHP5 CORE PLUGIN SYSTEM must be simple and flexible so we can add functions as needed for multilingual twext.. (called "TwextLinguas" in the old php3 core).. BUT we do NOT solve multilingual UI yet.. for now, our core connects ONLY THREE (3) simple elements:

  1. BASIC TWEXTER (done)
  2. LYRIC CHUNKSTER (separate bid or add-on)
  3. MYSQL (with fields for a few translate.google.com language pairs)

[edit] RESOURCES

old PHP code at http://twext.cc/dev/php/plugins may be useful to modify and test your new core architecture in PHP5..

[edit] PURPOSE

the purpose of the core plugin system is to enable agile development, where individual developers "own" individual functions, ie basic twexter, chunkster, widgets, etc.. the plugin system lets developers easily include/exclude versions of functions into custom builds.. full documentation helps developers learn the system, participate, customize variable uses, build from your simple, solid, tested, stable core..

[edit] SIMPLIFY

http://twext.cc/dev/php/api/design.php3 includes fancy stuff like user preferences, etc.. for now, wherever possible, we simplify to include only the essential functions needed to generically create, store and find twext text, while making it easy to later add functions as needed..

[edit] COMPLETE

completion of work must include, in English, clear comments on code; pseudo code; author name and email contact; copyright info; GPLv2 license; and source code shared at http://sf.net/projects/twexter

[edit] TEST.TWEXT.COM

you make it easy for me to install/update at http://test.twext.com.. we test (firefox only for now)

[edit] PHP5 TWEXTER API

we simplify and update the http://twext.cc/dev/php/api/design.php3 overview, put in a new place..

[edit] FULL COMMENTS IN ENGLISH

your core code must be explicitly commented and explained so other developers can easily participate..

[edit] EXPLICIT PROGRAM LOGIC

this version of twexter is freely licensed open software.. parallel systems may be developed in python, ruby, scheme, etc.. PSEUDO CODE, UML, FLOWCHART or likewise explicit description of the program logic is required to help others understand, use and extend your work..

[edit] SHARING AND ATTRIBUTION

please include your name and email so so developers can know who did the work and contact you if need be.. successful execution of this work may also serve to promote your services..

[edit] ASSIGN COPYRIGHT TO READ.FM

this is an explicit work-for-hire agreement you assign your copyright to read.fm, which freely releases your work under the GPLv2..

[edit] INCLUDE COPYRIGHT AND LICENSE NOTICE ON ALL CODE:

twext helps you learn to read in any language
free software: http://sf.net/projects/twexter
Copyright © 2008 READ.FM http://license.read.fm
http://more.read.fm/more more read, more market

[edit] SHARE SOURCE CODE

you share complete source code and all documentation to http://sf.net/projects/twexter

[edit] PAYMENT

funds are already in GAF escrow.. upon satisfactory completion, payday

[edit] SERIOUS

please spare us if not serious.. waqas won http://twext.cc/dev/twexterBASIC.html job by doing a rough working demo *before* bid awarded.. he showed real skills and interest..

[edit] baby step

this job is a baby step.. done well, it can lead to extensive future collaboration.. there are many http://twext.cc/go/ideas, but current focus is to find a developer to define a core, collaborative PHP5 architecture for twexter..


zura's doing it

maybe interesting:

can't deal with being tasked with fixing up spaghetti code. My brain simply locks down and refuses to make any modifications which it isn't convinced will work, which is of course impossible when the source material is an incurably bug-ridden mess.. architecture appears to be one of the simplest parts of the whole process, requiring in most cases little more than some pencil and paper calculations and a willingness to change.. Start by modifying the requirements of a problem you're working on. What if the amount of bandwidth or CPU was a hundredth what it currently is? What if it were a thousand times? A million? What if you had a thousand times as much data? A million? A billion?.. /bram hates subversion/.. The most common problem (re architectural decision) is that people can't admit when they're wrong.. bram cohen

seriously..

Retrieved from "http://twext.com/plugin"
Personal tools