X-Git-Url: http://erislabs.net/gitweb/?a=blobdiff_plain;ds=sidebyside;f=doc%2Fdevelopers-guide%2Fintroduction.xml;fp=doc%2Fdevelopers-guide%2Fintroduction.xml;h=e83daa80ab80fea95b10805268977054ddf2700b;hb=da9904ba5215aa6f6142b04a799bd4aaa43631b7;hp=8b0b2532ac1b652351ea991dccb5c2eb128901e9;hpb=8711c37c7c9beac74946554537ad66c84228b09d;p=mir.git diff --git a/doc/developers-guide/introduction.xml b/doc/developers-guide/introduction.xml index 8b0b2532..e83daa80 100755 --- a/doc/developers-guide/introduction.xml +++ b/doc/developers-guide/introduction.xml @@ -16,9 +16,9 @@ the dynamic site (see figure).
mir architecture (single host) - + - + @@ -35,9 +35,9 @@ site. Mirrors are simple to set up, since only static pages are involved
mir architecture (mirrored) - + - + @@ -47,7 +47,7 @@ site. Mirrors are simple to set up, since only static pages are involved
Concepts used by Mir Here's a list of important terms and concepts used by Mir. -Many of these concepts will be further detailed latter on in this guide. +Many of these concepts will be further detailed later on in this guide. producer @@ -61,11 +61,11 @@ In many CMS systems, the available variables (data) are hard-coded into the software. In practice, this is often not flexible enough for web designers. Mir allows designers to request the data they need by using -the producer framework, configured in the "producers.xml" file. +the producer framework, configured in the producers.xml file. Originally producers were mostly used to generate pages, but they are now used for a lot of -other tasks. In fact, the producers.xml file provides a +other tasks. In fact, the producers.xml file provides a simple, xml-based, programing (scripting) language, so that site administrators can script their own custom tasks without changing the java code. @@ -75,13 +75,15 @@ feeds for the global wire.
An example of article generation with the producers framework - + - +
+In the admin web interface, producers appear, for example, on +the admin->"Generate manually"->"advanced page": (they are called Tasks) Further information on producers may be found at XXX and in the javadoc (classes Producer, NodedProducer, roducerNode...). @@ -90,14 +92,14 @@ Further information on producers may be found at XXX and in the javadoc
- database + database access Mir uses a postgres database to store it's data. -Currently, the mir.storage, mircoders.storage, mir.entity, and -mir.entity.adapter +Currently, the mir.storage, mircoders.storage, +mir.entity, and mir.entity.adapter packages -are used to acces the database in Mir. However, these packages +are used to access the database in Mir. However, these packages are obsolete and will be replaced by the hibernate object/relational persistence system. @@ -110,10 +112,26 @@ object/relational persistence system. localizer -FIXME localizers are to allow mir installations to add code seperate from the -main code. A lot of things can be changed in an installation (and are -by various mir sites). Think of custom open posting mechanism, open -posting validation, data model enhancements. +Localizers provide a customization framework that allows +different mir sites to behave differently. Each site can +write it's own bits of java code that override default behavior. +This is effectively +used by various indymedia sites to customize things +such open posting mechanisms, open +posting validation, data model enhancements, etc. + + +The MirLocalizer interface describes +the centralized localizer, that may be accessed via the global +MirGlobal.localizer() +function. The central localizer provides accessors to +domain specific localizers +(like MirBasicOpenPostingLocalizer). + + +Default behavior is provided by the MirBasicLocalizer +and it's associated classes. These classes can be extended to +override default behavior. @@ -137,10 +155,10 @@ sites) and velocity (not used at all but supported anyway). logger -Logging is understood here as "sytem logs" : information written +Logging is understood here as "system logs" : information written out to files that may be used to track what is going on in Mir, -especially errors and warnings. Mir uses the log4j logging system. -This alows us to split logs into different files, making them +especially errors and warnings. Mir uses the log4j logging system. +This allows us to split logs into different files, making them easier to understand. @@ -150,7 +168,7 @@ easier to understand. mircoders packages -Originally, the mircoders packages were meant for local developpements, +Originally, the mircoders packages were meant for local developments, as opposed to the core Mir code. This distinction is now obsolete and these packages will probably be reorganized in future releases.