History: How to Create Profiles

View page

Source of version: 34 (current)

To create a profile:

!!# Start a new wiki page on profiles.tiki.org

Simply enter the page name below. Do not use spaces or special characters, however underscore (_) is OK. Although the profile alone would work just fine with spaces in profile name, it is not recommended because the profile parser can't cope with spaces when some other profile wants to reference your profile.

{module module="quick_edit"}

!!# Add YAML to wiki page
!!!# From an export
Just configure your Tiki instance normally (via the GUI) and then ((doc:Export Profiles))

!!!# Build from scratch
Various templates have been set up for each of the ((handlers)) with sample YAML code to imitate. The best is start from a working profile example. Install one first to make sure it works, and copy-paste the wiki text to a new page. Also see the ((profile developer documentation)) for details about the basic syntax.

Besides the YAML code you can write notes and descriptive text before or after the code part(s) to let the users of the profile know what is your profile about. You can use any wiki syntax but ''please keep in mind'' that upon user's installation the links in profile details will be relative to the user's Tiki installation and thus rather __use external link syntax instead of wiki links even for linking to other wiki pages here__ otherwise the user will see just wiki links to non-existent pages at his/her local Tiki. Also try to avoid usage of Wiki Plugins as the user might have them disabled and again, they will render as relative to the Tiki of the user, not to profiles.tiki.org.

You can check the syntax of YAML with the syntax highlighter of your text editor (such as [http://notepad-plus.sourceforge.net|Notepad++])
(Some online checkers: [http://yaml-online-parser.appspot.com/], an emacs-yaml-mode extension)

!!# Assign one or more categories

The new profile will  not be installable unless you assign at least one  sub-category for the following profile related categories: 

* Tiki version
* State
* Type

To do this, click on the __Categories__ tab while editing the page. You will see a long list of categories. If you don't know what they mean, then just check the list of Tiki versions with which your profile is compatible. For example, if your new profile assumes Tiki 4.x, then check the 4.x category.


!!# Save.

Check the details for that kind of handler. See if you got it right. 


!!# Recheck, Re-save and Categorize.
 
Categorize it as "Not Tested" until you have successfully used it.

Once it is categorized, it will appear on the list of profiles available on the profile server. 


!!# Load your profile on your own site.

See: ((How to Use Profiles))

!! Troubleshooting

If for some reason your profile doesn't do what you want it to have a look through the notes here: ((Troubleshooting Profiles))

!! Apply a profile via a plugin
You can also use ((doc:PluginProfile)).


! Alias
* (alias(create)) a profile
* (alias(creating)) a profile
* (alias(make)) a profile
* (alias(making)) a profile

Latest Changes

...more

Like almost all *.tiki.org sites, you can log in with your login from https://tiki.org (register over there)

Search

Most Popular Tags

admin agenda alias antibot antibot captcha app archive articles banning batch blogs calculations calendars cart categories cluster codemirror comments computation contact us datachannel debug debug console dropdown with other error messages features file galleries forums geo geocms geolocation group homepages group watches header i18n images item link items list jquery languages location map maps maths menu menupage multilingual ol3 ol5 openlayers paypal plugin plugin alias plugin datachannel plugin fade plugin tabs plugin trackerlist pretty trackers print project management r r project realnames rss static static text statistics stats structures syntax highlighter tablesorter template trackers user watches visualization watches webservice wiki wiki argument variables wiki structures

History: How to Create Profiles

Source of version: 34 (current)

Menu

Current Profiles

Latest Changes

Search

Most Popular Tags

About Tiki

Support

Community

Documentation

Development

Legal

Tiki Project Sites

Networks

History: How to Create Profiles

Source of version: 34 (current)

Menu

Current Profiles

Latest Changes

Search

Most Popular Tags

Tiki Newsletter

About Tiki

Support

Community

Documentation

Development

Legal

Tiki Project Sites

Networks