Hi Ray

Many thanks for your efforts.

I really think we need an up to date documentation that covers these topics.
But we need the full documentation in the wiki instead of the unchangeable 
pages we have currently or better said half of it on the Drupal site and the 
others in the wiki (and barely interconnected etc).

And besides yes we devs would appreciate an up to date full explanation of all 
fields in the wiki.
I think there is no automation for this like phpdoc or something but since the 
db shouldn't change all too often I guess it shouldn't be too much of a hassle 
to establish this database documentation in the wiki and keep it up to date 
manually (OXID + Community).

I would create a main page in the wiki about the database where you find all 
sub articles linked in.
And then I would create a wiki page for each database table.
These pages should explain the usage of the database table and special things 
to consider and may be what views are generated from it (in case of multi 
language fields).
May be it also should provide a few nice little SQL queries. May be they should 
be collected on another wiki page.

Also on each database table wiki entry we should have a full list (html-table) 
of all fields with the following columns:
Field number
Field name
Data type
Default value
Description (possible values, usage, special things)
Primary Key Field? (Yes/No)
Field exists since Version (4.0/4.1/.../4.5)

May be we can skip the "Field exists since Version" column if we keep a 
separate documentation for each OXID/database version.

Unfortunately I'm busy with a current project and soon I have to serve my army 
duty (4 weeks), so I can't help you with this before the end of September.

Anybody else willing to help us with this?

Greetings from Basel
Marc
 
ORCA Services AG
Herrenmattstrasse 26
CH-4132 Muttenz
Office Basel: Aeschengraben 10, CH-4051 Basel
 
[email protected]
T. +41 61 205 80 80
T. +41 61 205 80 73 (direkt)
F. +41 61 205 80 81

www.orca.ch, www.orca-services.ch
 
"We convert your visitors into customers."
-----Ursprüngliche Nachricht-----
Von: [email protected] 
[mailto:[email protected]] Im Auftrag von Raimund Lang
Gesendet: Donnerstag, 11. August 2011 11:09
An: [email protected]
Betreff: [oxid-dev-general] Template documentation 4.5 (Azure)

Hi there!

Yesterday night I have translated the tutorial about Theme-management in the
wiki into german ->
http://wiki.oxidforge.org/Tutorials/Theme_Management_im_OXID_eShop_ab_4.5.0

By the way, if I have mixed up something unintentionally - please let me
know or correct it directly...

There is still a lot of documentation missing for the 4.5, new handling
things, Theme-issues and so on. It would be very helpful to have at least a
Template documentation which shows the structure and which file builds what
elements, just like this one:
http://www.oxid-esales.com/de/resources/help-faq/eshop-manual/template-docum
entation-eshop-40

Almost 30% of the questions in forums belong to this. 
Maybe a demo-shop like http://www.boxyton.de/oxiddemodebug/ with included
template-names would be helpful? 

As well an Excel-file for the database fields like this one
http://wiki.oxidforge.org/File:Oxid_ce43x_mysql_admin_nomenklatur.xls
would be as well extremely helpful for a lot of forums questions.

Of course I know it is a lot of work to update all manual and faq´s to the
new 4.5 version, but I think with those two basic things and the few already
existing tutorials we could respond most questions.

Thanks!

Your forums Mod - always on the run! ;-)

Ray

____________________________________________________________________

Haller Stahlwaren GmbH 
Am Gartennest 1
74544 Michelbach/Bilz
---
Tel.: 0791/47003
Fax : 0791/47005
www.haller-stahlwaren.de
---
Sitz: Schwäbisch Hall
Registergericht: Stuttgart HRB 570131
Geschäftsführer: Hermann Hebsacker, Karin Hebsacker





_______________________________________________
dev-general mailing list
[email protected]
http://dir.gmane.org/gmane.comp.php.oxid.general
_______________________________________________
dev-general mailing list
[email protected]
http://dir.gmane.org/gmane.comp.php.oxid.general

Reply via email to