Fullscreen
[Show/Hide Left Column]
[Show/Hide Right Column]

Tips for new developers... (Cached)
Refresh Print

TikiDevNewbie

About
This page is dedicated to help you, the new Tiki developer, get started in Tikiwiki Development. There are a lot of references here - some are basic, some advanced. You may need to read some or all of the references, but please take the time to read this page before you start. We hope it will save you time in the long run. As you learn, we invite you to come back and update this page - share what you have learned.

  1. Join the ))TikiWikiDev(( mailing lists at https://sourceforge.net/mail/?group_id=64258 (external link) and ask lots of questions.
  2. Join the #tikiwiki group on IRC and ask lots of questions. Read ConnectingToIrc for instructions
  3. Use ))TikiWiki(( and understand how it works before you start trying to change it. Set up a site, use and administer it on an everyday basis until you can fix the problems you encounter.
  4. Set up your development system to use one or more of the SVN branches (there are several). The bleeding edge is Head.
  5. If you are not sure how to set up a local server and want to use IIS on a Windows machine read IisInstall? or Installation (external link). There are some good "LAMP" stacks Sokkit (external link) and XAMPP (external link) available for Windows if this will be your development platform.
  6. Set up an Internet available site. This will be your playground and showcase to show off your latest feature. Then let everyone on #tikiwiki know you have something new. If you haven't already been asked to join the group - you will be now.
  7. SVN is one of the more complicated things you'll need to learn about Tikiwiki Development.
    1. Read the SourceForge pages for beginners on SVN http://apps.sourceforge.net/trac/sourceforge/wiki/Subversion (external link). It has links to a lot of references and ideas on SVN use.
    2. Ask lots of questions on IRC. Using SVN correctly could be a degree all by itself. biggrin
    3. Read http://dev.tikiwiki.org/tiki-index.php?page=Commit
  8. Read the 3Rules
  9. If this is the first open-source project you have worked on, understand that working on an open-source project is NOT like any other development project you have ever done. You will be dealing with a large number of people who are scattered all over this beautiful world of ours. Many of our friends learned English as a second (or third) language. Misunderstandings WILL happen! Assume positive intent and practice forgiveness. All of this will require an added effort on your part. Please read KinderCode often. A good place to learn about the diferences of open source development is Eric Raymond's Cathedral and the Bazaar (external link)
  10. Before you DO anything - ask for help on the Development list or on #tikiwiki. It doesn't make a lot of sense for you to spend a lot of time trying to accomplish something the Hard Way when a few questions could save you a lot of effort. Again - ask questions and use the expertise that is available.
  11. If you have an idea for a new feature, suggest it on the dev list or #tikiwiki. Get some feedback and opinions on the need for the feature and ideas on how to implement it. Some in the tikiwiki community have been here for 2-3 years and know the history. As Newton before you, take an opportunity to see further by standing on the shoulders of giants.
  12. If you need help with something - ASK! Most developers are more than happy to assist when they we can - but we need to know when (and where) the help is needed. This is a very friendly group who believe in helping each other!
  13. Read the Hello World introduction in order to learn the basic structure of the tikiwiki environment. This article starts with a basic "hello world" page and goes on to cover permissions, menus, queries, wiki parsing, themes and more.
  14. How to get commit access
  15. Tiki is licensed under the LGPL license (external link). Take the time to understand the meaning of this license before you commit any code. By submitting to the project you are committing to that license model. Further, any code you copy from another open source project must be compatible with LGPL.
  16. Finally: That nasty word Documentation. While nobody expects a developer to spend his time writing the documentation for the manual, some documentation is necessary. Writing a simple proposal in a Wiki page on dev.tikiwiki.org stating what you want to accomplish and how you plan to do it does several things. First, it will help you to clarify your thoughts. Second, it should provide you and others with some specific goals. The most important thing is that it will provide others with a place where they can comment on your ideas. Documenting the source code is also important! Comments allow the unskilled novice to become better.

Other tw.o references:


Contributors to this page: Kissaki307 points  , lindon440 points  , sylvie2406 points  , pkdille611 points  , luci1593 points  , judiospi6 points  , mn , gmartin85 points  and marclaporte31761 points  .
Page last modified on Saturday 25 July, 2009 13:48:50 UTC by Kissaki307 points .

Main Menu [toggle]


Bugs and Wishes
  1. Report a Bug (or suggest a feature enhancement)

  2. Search Bugs

  3. List yours



About Development

Mailing lists

Extra Stuff

Teams

External Links

Full list of Wiki Pages

TikiWiki on Social Networks


To register [toggle]

To have an account at this site, please register at Tikiwiki.org (external link), and then use that user name and password to log in here.

Search a Wiki Page [toggle]

Exact match

Search Tracker Items Subject [toggle]

Keywords [toggle]

The following is a list of keywords that should serve as hubs for navigation within the Tiki development and should correspond to documentation keywords.

Each feature in Tiki has a wiki page which regroups all the bugs, requests for enhancements, etc. It is somewhat a form of wiki-based project management. You can also express your interest in a feature by adding it to your profile. You can also try out the Dynamic filter.

Accessibility (WAI – 508)
Action log 2.x
Administration
Ajax 2.x
Alert 3.x
Articles & Submissions
Backlinks
Banner
Blog
Bookmark
Browser Compatibility
Calendar
Category
Chat
Comment
Communication Center
Consistency
Contacts Address book
Contact us
Content template
Contribution 2.x
Cookie
Copyright
Custom Home (and Group Home Page)
Database independence
Database MySQL
Date and Time
Debugger Console
Directory (of hyperlinks)
Documentation link from Tiki to doc.tikiwiki.org (Help System)
DogFood
Dynamic Content
Dynamic Variable
External Authentication
FAQ
Featured links
File Gallery
Forum
Friendship Network (Community)
Gmap Google maps
Group
Help System
Hotword
HTML Page
i18n (Multilingual, l10n, Babelfish)
Image Gallery
Import-Export
Install
Integrator
Interaction
Inter-User Messages
InterTiki
jQuery
Karma
Live Support
Lost edit protection
Mail-in
Map with Mapserver
Menu
Meta Tag
Missing features
MindMap 3.x
Mobile Tiki and Voice Tiki
Mods
Module
MultiTiki
MyTiki
Newsletter
Notepad
OS independence (Non-Linux, Windows/IIS, Mac, BSD)
Payment 5.x
Performance Speed / Load / Compression / Cache
Permission
Poll
Profile Manager
Quiz
Rating
RSS
Score
Search engine optimization (SEO)
Search
Security
Semantic links 3.x
Shoutbox
Site Identity
Slideshow
Smarty Template
Spam protection (Anti-bot CATPCHA)
Spellcheck
Spreadsheet
Staging and Approval
Stats
Survey
System log
Tags 2.x
Task
Tell a Friend + Social Bookmarking 2.x
TikiTests 2.x
Theme
Toolbar (Quicktags)
Trackers
TRIM
User Administration
User Files
User Menu
Watch
WebHelp
Webmail and Groupmail
WebServices 3.x
Wiki 3D
Wiki History, page rename, etc
Wiki plugins extends basic syntax
Wiki syntax text area, parser, etc
Wiki structure (book and table of content)
Workspace Ideas 4.x
WYSIWTSN 4.x
WYSIWYCA
WYSIWYG 2.x
XMLRPC

Last Comments [toggle]

  1. Fix
  2. Re: Test
  3. Test