xoops forums

kaotik

Just can't stay away
Posted on: 2007/9/17 11:09
kaotik
kaotik (Show more)
Just can't stay away
Posts: 861
Since: 2004/2/19
#1

Tutorial - Part 5 - Guidlines for Module Development

This tutorial has guidelines for aspiring module developers (and the pros too if they want ). These however are based on my own experience and years of using xoops. Other developers might disagree with some of these points so please take them as a starting point. You will eventually form your own opinion about each of these points.

Part 5 - Guidelines for Module Development

I'll be updating this tutorial so check back once in a while.

rlankford

Not too shy to talk
Posted on: 2007/9/17 11:13
rlankford
rlankford (Show more)
Not too shy to talk
Posts: 158
Since: 2004/8/27
#2

Re: Tutorial - Part 5 - Guidlines for Module Development

Good work! I enjoyed reading it.

sato-san

Quite a regular
Posted on: 2007/9/17 11:19
sato-san
sato-san (Show more)
Quite a regular
Posts: 224
Since: 2005/7/1 1
#3

Re: Tutorial - Part 5 - Guidlines for Module Development

Great, im would like this translate for german users.

kaotik

Just can't stay away
Posted on: 2007/9/17 11:25
kaotik
kaotik (Show more)
Just can't stay away
Posts: 861
Since: 2004/2/19
#4

Re: Tutorial - Part 5 - Guidlines for Module Development

Anyone who would like to translate my tutorials are free to do so! I in fact, encourage it!
Small note: if you are going to translate my tutorials, please be careful with the code parts. Keep them readable for your users. Personally I like to have all code highlighted in a different background color so that it's clear what those lines are.

markesh

Just popping in
Posted on: 2007/9/20 13:01
markesh
markesh (Show more)
Just popping in
Posts: 79
Since: 2007/7/14
#5

Re: Tutorial - Part 5 - Guidlines for Module Development

great tutorials, thanks a lot for this collection.

I've still got a question concering the xoops_version.php:

how do I create a line feed in the text? e.g. I want to have an output (click on the module info symbol) like this:

Description:
line 1
line 2

I've fiddled around with br-Tag, \n with and without '', "" etc. but didn't succeed.

Also if there are German Umlauts encoded in the text XOOPS doesn't show them properly but masks the "&" with an additional "&"

TIA & kind regards
markesh/karim
First German XOOPS book: XOOPS-Buch.de

kaotik

Just can't stay away
Posted on: 2007/9/20 14:37
kaotik
kaotik (Show more)
Just can't stay away
Posts: 861
Since: 2004/2/19
#6

Re: Tutorial - Part 5 - Guidlines for Module Development

I would also like to know the answer to that question . I couldn't get it work either.
Regarding german characters, the info page is created with content="text/html; charset=ISO-8859-1" independent of what you set in global.php

markesh

Just popping in
Posted on: 2007/9/20 16:07
markesh
markesh (Show more)
Just popping in
Posts: 79
Since: 2007/7/14
#7

Re: Tutorial - Part 5 - Guidlines for Module Development

thanks a lot, kaotik, so at least I know that I'm not the only one

I've had a look at the /system/admin.php, which invokes the info, but that wasn't really helpful.

If I use "\n", the browser windows doesn't show anything of this, but the source code has a line break. There's a javascript link for closing the window, but this doesn't help me, either.


As for the German special characters: If I use the ä, ü, ö directly, they appear quite fine.

kind regards
markesh/karim
First German XOOPS book: XOOPS-Buch.de

jcmors

Just popping in
Posted on: 2007/9/21 23:56
jcmors
jcmors (Show more)
Just popping in
Posts: 1
Since: 2005/7/12
#8

Re: Tutorial - Part 5 - Guidlines for Module Development

What a great tutorial and one that imho was much needed! Is the tutorial set downloadable for review and working with offline in some form?

skenow

Home away from home
Posted on: 2007/9/22 1:19
skenow
skenow (Show more)
Home away from home
Posts: 993
Since: 2004/11/17
#9

Re: Tutorial - Part 5 - Guidlines for Module Development

Quote:

sato-san wrote:
Great, im would like this translate for german users.


All of Kaotik's tutorials are available at XOOPSwiki - work is being done there to translate them. Other translators are welcome to join in and help with any documentation you find there.

We also hope to have downloadable versions available as the documents are completed.