XOOPS 
Forum
Forum Index General Forums Community Support Modules Support Themes Support Development International Support Module Hack Reviews Theme Designer Talk
  1. Board index / 
  2. General XOOPS.org forums / 
  3. XOOPS Project Teams
  4. XOOPS Documentation Team 
  5.  / Help needed on Documentation for "Basic Module Pack"
Register
1
Mamba
Help needed on Documentation for "Basic Module Pack"

  • 2011/3/13 9:28

  • Mamba

  • Moderator

  • Posts: 11409

  • Since: 2004/4/23


I am working together with Voltan on "XOOPS Basic Module Pack".

Some of the modules are available for testing.

I would like to include with each of them a tutorial/guide documentation.

Who would be willing to help in writing it?

Obviously, no programming experience needed, so any user could help us with it
Support XOOPS => DONATE
Use 2.5.11 | Docs | Modules | Bugs
2
Mamba
Re: Help needed on Documentation for "Basic Module Pack"

  • 2011/3/13 23:19

  • Mamba

  • Moderator

  • Posts: 11409

  • Since: 2004/4/23


I've created a short tutorial for Marquee.

Can you please take a look and let me know if this format and content is OK? If not, how could we improve it?

Please remember - this is just a draft, so be gentle

The goal is to have a tutorial for each of the module in the "Basic Module Pack", but in order to make it a reality, we'll need some help.

Support XOOPS => DONATE
Use 2.5.11 | Docs | Modules | Bugs
3
Mazarin
Re: Help needed on Documentation for "Basic Module Pack"

  • 2011/3/14 7:06

  • Mazarin

  • Just can't stay away

  • Posts: 533

  • Since: 2008/12/10


Just went through it very quickly and it seems it covers everything. I have a feeling the structure (after the install/uninstall) could be changed to be more intuitive and process oriented, but I don't have a better suggestion at this time, so I should probably keep my mouth shut

Maybe I'll think of something when I write this for XoopsPoll.
4
Mamba
Re: Help needed on Documentation for "Basic Module Pack"

  • 2011/3/14 8:51

  • Mamba

  • Moderator

  • Posts: 11409

  • Since: 2004/4/23


Mazarin, thank you so much for reviewing it! I've updated it based on your feedback and put the blocks actions together with the Marquee actions to make it a one process.

And thank you for your willingness to work on the Poll Tutorial.

I created a Poll Tutorial earlier, based on previous work by MadFish. I'll email it to you, so you can make corrections/improvements.

Everybody else: please check both tutorials and provide us with feedback, so we can make improvements.

Support XOOPS => DONATE
Use 2.5.11 | Docs | Modules | Bugs
5
fdeconiac
Re: Help needed on Documentation for "Basic Module Pack"

  • 2011/3/14 9:33

  • fdeconiac

  • Quite a regular

  • Posts: 278

  • Since: 2008/11/29


Thanks Mamba for the tutorials, they are really nice !

By the i discovered marquee through your pdf... let me install it and play with it :)
6
Mamba
Re: Help needed on Documentation for "Basic Module Pack"

  • 2011/3/15 8:35

  • Mamba

  • Moderator

  • Posts: 11409

  • Since: 2004/4/23


After:

- Marquee Tutorial
- Poll Tutorial

we have now XOOPS Partner Tutorial

Please review and provide feedback:

- Are we heading in the right direction?
- Are these tutorials easy to read and follow?

I'll be working next on WebLinks and fmContent.

Can somebody help us with the other modules:

- News / xNews
- Tag
- extGallery
- extCal
- Contact
Support XOOPS => DONATE
Use 2.5.11 | Docs | Modules | Bugs
7
Mamba
Re: Help needed on Documentation for "Basic Module Pack"

  • 2011/3/15 17:46

  • Mamba

  • Moderator

  • Posts: 11409

  • Since: 2004/4/23


I have added "Contact Us" Tutorial.

Please download it from here

Please review and provide feedback:

- Are we heading in the right direction?
- Are these tutorials easy to read and follow?

I'll be working next on WebLinks and fmContent.

Can somebody help us with the other modules:

- News / xNews
- Tag
- extGallery
- extCal
Support XOOPS => DONATE
Use 2.5.11 | Docs | Modules | Bugs
8
Mamba
Re: Help needed on Documentation for "Basic Module Pack"

  • 2011/3/16 19:26

  • Mamba

  • Moderator

  • Posts: 11409

  • Since: 2004/4/23


I have added right now "MyLinks" Tutorial.

Previously published tutorials:

- Contact Us Tutorial
- Marquee Tutorial
- XOOPS Poll Tutorial
- XOOPS Partner Tutorial

Please review and provide feedback:

- Are we heading in the right direction?
- Are these tutorials easy to read and follow?

I'll be working next on fmContent.

Can somebody help us with Tutorials for the other modules:

- extCal
- extgallery
- Tag
- News / xNews

I am sure that there are people who are using these modules, right?
No programming skills required - just describe the usage of that module and its main functionality, and maybe some tricks and tips, if you have any.

So if you ever thought - I cannot contribute because I am just a user, this is your chance to change it
Support XOOPS => DONATE
Use 2.5.11 | Docs | Modules | Bugs
9
chocofrodo
Re: Help needed on Documentation for "Basic Module Pack"

  • 2011/3/30 18:07

  • chocofrodo

  • Just popping in

  • Posts: 7

  • Since: 2010/2/23


Hi Mamba,

nice work with the tutorials, it's something I like a lot, good documentation, ;).

About it, I would like to make a suggestion: Why don't write them using the wikimedia documentation part? This is because everybody could edit them easily online, thus, more people could write the tutorials keeping a common structure, and it could be written faster.

E.g, you can write maybe a new page: "Tutorial Marquee Module 2.48", and write the tutorial. And people consulting it online can rewrite it adding new things not explained. The structure, what you write on them:

MODULE PORRPOSE
INSTALL/UNISTALL
ADMINISTRATION MENU
PREFERENCES
OPERATING INSTRUCTIONS
THE USER SIDE
BLOCKS
TEMPLATES
MODULE CREDITS

Well, only a suggestion, what do you think?

10
Mamba
Re: Help needed on Documentation for "Basic Module Pack"

  • 2011/3/30 19:28

  • Mamba

  • Moderator

  • Posts: 11409

  • Since: 2004/4/23


Quote:
Well, only a suggestion, what do you think?

That's the plan - after we finish the documents, to put them on the Wiki, and start the "big Wiki clean-up"
Support XOOPS => DONATE
Use 2.5.11 | Docs | Modules | Bugs
(1) 2 »

Login

Register now!  |  Lost Password?

Search

Advanced Search

Recent Posts

Who's Online

286 user(s) are online (115 user(s) are browsing Support Forums)

Members: 0

Guests: 286

more...

Donat-O-Meter

Stats
Goal: $100.00
Due Date: Nov 30
Gross Amount: $0.00
Net Balance: $0.00
Left to go: $100.00
Make donations with PayPal!

Latest GitHub Commits