Loading...
 

Naming Convention

What name to give?

In Tiki, we try to have descriptive names for everything.

Ex.: Forums are called forums. It’s clear, simpler and good for SEO. There will not be 2 discussion forum features so no need to have exotic names to distinguish them. Don’t try to be fancy!

A feature

  • Try to use a descriptive, already recognized term.
    • Look on Wikipedia and at other software
  • Better one word than two
  • Try to avoid something that could be confused with another feature


A preference

and lib/prefs/* (where they are defined)
in lib/setup/pref.php (default value)

A permission

they all start with tiki_p_

So it could be tiki_p_view_history


Documentation and development pages

So, this feature should end up in the list of keywords

  • doc.tiki.org/XYZ What the feature does
  • dev.tiki.org/XYZ What we wish the feature did
  • tiki.org/XYZ if we are Dogfooding for the community or require a gateway page.

How to handle integration with others?

BigBlueButton, Kaltura, Google Analytics and all the Interactions

Questions

  • Should online services (ex.: Google Analytics) be treated differently than projects we bundle (ex.: Zend Framework) or integrate with? (ex.: BigBlueButton)

Arguments in favor of using generic term

  • Descriptive

Arguments in favor of using project name

  • Some people may search via these keywords (esp if project is well known)
  • It’s a nice gesture to them


Related links



Suggested changes

Wiki plugins renamed to something else


Problem: people think that plugins are features that are not included in Tiki. Example, in Firefox, not bundled features are add-ons or plugins

So in reality, what we have is “bundled plugins” which is a mouthful...

 luci thinks:

Well, ideally, they should be always called ”Wikiplugins”, not just “Plugins”, which would indicate they are being “plugged” add-ons to the wiki syntax. Or “Content Plugins” ? But actually I think it is not worth of the renaming. It didn’t hurt anybody much so far and people just have to get used to it, imho. Cannot please everybody used to some other term.


What else could we use?

Aliases

Keywords

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)
Accounting 7.x
Administration
Ajax 2.x
Articles & Submissions
Backlinks
Banner
Batch 6.x
BigBlueButton audio/video/chat/screensharing (5.x)
Blog
Bookmark
Browser Compatibility
Calendar
Category
Chat
Comment
Communication Center
Consistency
Contacts Address book
Contact us
Content template
Contribution 2.x
Cookie
Copyright
Credits 6.x
Custom Home (and Group Home Page)
Database MySQL - MyISAM
Database MySQL - InnoDB
Date and Time
Debugger Console
Directory (of hyperlinks)
Documentation link from Tiki to doc.tiki.org (Help System)
Docs 8.x
DogFood
Draw 7.x
Dynamic Content
Preferences
Dynamic Variable
External Authentication
FAQ
Featured links
Feeds (RSS)
File Gallery
Forum
Friendship Network (Community)
Group
Help
History
Hotword
HTML Page
i18n (Multilingual, l10n, Babelfish)
Image Gallery
Import-Export
Install
Integrator
Interoperability
Inter-User Messages
InterTiki
jQuery
Kaltura video management
Karma
Live Support
Logs (system & action)
Lost edit protection
Mail-in
Map
Menu
Meta Tag
Missing features
Visual Mapping 3.x
Mobile Tiki and Voice Tiki
Mods
Modules
MultiTiki
MyTiki
Newsletter
Notepad
OS independence (Non-Linux, Windows/IIS, Mac, BSD)
Organic Groups (Self-managed Teams)
Payment 5.x
Performance Speed / Load / Compression / Cache
Permission
Poll
Profiles
Quiz
Rating
Realname
Report
Revision Approval
Score
Search engine optimization (SEO)
Search
Security
Semantic links 3.x
Share
Shopping Cart 5.x
Shoutbox
Site Identity
Slideshow
Smarty Template
Social Networking
Spam protection (Anti-bot CATPCHA)
Spellcheck
Spreadsheet
Staging and Approval
Stats
Survey
Syntax Highlighter (Codemirror)
Tablesorter
Tags 2.x
Task
Tell a Friend, alert + Social Bookmarking
Terms and Conditions
Theme
TikiTests 2.x
Timesheet
Token Access
Toolbar (Quicktags)
Tours
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 and perspectives 4.x
WYSIWTSN 4.x
WYSIWYCA
WYSIWYG 2.x
XMLRPC




Useful Tools