Page 1 of 1

Open Documentation Wiki

PostPosted: Fri Feb 28, 2014 9:14 pm
by Bernd.N
I currently learn Servoy and naturally stumble over points where I can not find documentation.
One example is "sequence type" in the table editor, where I tried to google with 'servoy "sequence type" ' and did not find any simple explanation of them. What I need is just a one-sentence-explanation to each type
servoy seq:
db seq:
db identity:
uuid generator:

There are dozens of similar examples when you learn a new system, and it often needs hours to google them and try to figure them out.

Therefore I would like to suggest an open documentation wiki, which could have a simple structure and where people registered in this forum could add items when they look for something and finally figure it out. Example for the structure (the doc is my current state of knowledge, please excuse when there are faults):

Form Elements
___Text Field
______onAction-Event: triggers when.../do not use when.../be careful when...
______onDataChange-Event: triggers when.../do not use when.../be careful when...
______ ....
______onRightClickEvent: triggers when.../do not use when.../be careful when...
______anchors: ...
______background: consider to use CSS-styles...
______editable: ...
______enabled: the difference to editable is...
______valuelist: ....
______visible: ....
___Text Area

Eclipse Table Editor
___Table Columns
______- Maximum N characters when you want to be compatible with PostgreSQL/SQL Server/Oracle/MySQL
______- Do not use big letters as some DBs have problems with that
______- Use always [tablename]_id as name for the primary key to have a useful convention
_________- Use -1 as length to get a text field without fixed length
______ - Deactivate rarely as you will face additional challenges when adding new records
______Sequence Type
_________servoy seq: Explanation...
_________db seq: Explanation...
_________db identity: Explanation...
_________uuid generator: Generates a unique UUID for a TEXT field with length 36

Hope you get the idea.
In case you are an expert already, it might look needless, but for Servoy newbies, it would be a great help.
It would result in faster learning, and the Servoy community would grow even faster, which is in everyone's interest, I think. :)

Whats more, it could be a single point for assembling detailed knowledge to those topics.
And Wikipedia shows that it is possible to work on a large wiki together, the quality is improved through everyone who reads and changes it when necessary with responsibility.


Re: Open Documentation Wiki

PostPosted: Sat Mar 01, 2014 2:31 am
by david

Re: Open Documentation Wiki

PostPosted: Sat Mar 01, 2014 12:39 pm
by Bernd.N
Thanks a lot, David, so just trying to google something without reading the docs first seems not a good idea. Lesson learned. :)

Would be nice if there would be a direct link from the specific data field in Eclipse Environment to this docs, maybe by right mouse click or something like that.

Own table based Wiki

PostPosted: Mon Jan 05, 2015 5:54 pm
by Bernd.N
During my first 8 month of coding with Servoy (which I enjoy more and more), I found it useful to create a small wiki for topics I want to remember.
Saves me time to look that things up elsewhere.
The tags in the first column just mean Postgres (pg) and Servoy Developer (sd).