Guidelines for contributing

From pmusers
Jump to: navigation, search

The PMUsers wiki is a place where users of ProcessMaker can share examples of Processes, Dynaforms, JavaScript code, trigger code, plugins and any tips and tricks that they have learned.

Guidelines for this wiki

  • Feel free to create new pages on this wiki and share your work with others.
  • We may edit any page to conform to a common style and fix grammar errors, but you are free to post anything that you think might help others users of ProcessMaker. We may add warnings if we feel something presents a security risk or delete content that is offensive, spam, propaganda, etc.
  • We allow content related to other software or hardware which can be used with ProcessMaker, but please keep the advertising to a minimum. The name of a product with a link is fine, but images with advertising slogans will be deleted.
  • Due to the large number of spammers, the front page of the wiki has been locked, but anyone is free to edit the other pages.
  • If you would like the power to edit the front page and/or help administer this wiki, please email: Amos Batto <amosbatto[at]gmail[dot]com>

How to share your work

If adding content which might not work in all versions of ProcessMaker or in all environments, please share the environment where you tested it.

For example, it helps to add this information at the top of a page containing JavaScript code:

---------
'''Tested in:''' PM 3.3.0 Community with Firefox 59 & Chrome 62
--------

And for trigger code:

---------
'''Tested in:''' PM 3.3.0 Enterprise with PHP 5.6.37
--------

Sharing images

It helps to provide screenshots, especially when discussing processes and Dynaforms. To add an image to the text, add the following text to the wiki page:

[[file:filename.ext]]

Make sure that the extension of the file is for an image file such as .png, .jpg, .jpeg, .tiff, etc. After adding the above link to the file, save the wiki page. Then click on the link to upload the image file.

Sharing files

If you are sharing a Dynaform, process or plugin, it helps to include the .json, .pmx or .tar file, so others can download it and play with it.

To include a downloadable file, add the following text to the wiki page:

[[media:filename.ext|filename.ext]] (''right click'' and select '''Save Link As''')

After adding the above link to the file, save the wiki page. It will then appear in the wiki as:

filename.ext (right click and select Save Link As)

Then, click on the link to upload the file.

It is not necessary to add any additional information, but it helps others if the following information is added at the top of the page about the Dynaform, process or plugin:

---------
'''type-of-file:'''  [[media:filename.ext|filename.ext]] (''right click'' and select '''Save link as''')<br>
'''Author:'''  author-information<br>
'''Version:'''   X.X (YYYY-MM-DD)<br>
'''Tested in:''' PM X.X.X community-or-enterprise in environment 
--------

For example:

---------
'''DynaForm:'''  [[media:Running account grid-1.0.json|Running account grid-1.0.json]] (''right click'' and select '''Save Link As''')<br>
'''Author:'''    [https://amosbbatto.wordpress.com Amos Batto] (amosbatto[at]gmail[dot]com)<br>
'''Version:'''   1.0 (2018-12-15)<br>
'''Tested in:''' PM 3.3.0 Community in Debian 9.5 with PHP 5.6.37 and Firefox 59 
--------

Which appears in the wiki as:


DynaForm: Running account grid-1.0.json (right click and select Save Link As)
Author: Amos Batto (amosbatto[at]gmail[dot]com)
Version: 1.0 (2018-12-15)
Tested in: PM 3.3.0 Community in Debian 9.5 with PHP 5.6.37 and Firefox 59


It is not necessary to provide your name or a link to your web page, but allows you to advertise your services if you want others to be able to find you. If you want people to contact you (and don't mind the spam bots), feel free to include your email, Facebook, Twitter, instant messenger, telephone number or however you wish to be contacted.

We also recommend including a version number and date, so that people will know if you have uploaded a new version of the file.

Licenses for wiki content

All content on the wiki is public domain by default.

If you want a file to have a different license, then please add the license information. For example:

---------
'''Process:'''   [[media:Accounting_Process-1.pmx|Accounting_Process-1.pmx]] (''right click'' and select '''Save Link As''')<br>
'''Author:'''    [https://mybigcorp.com My Big Corp]<br>
'''Version:'''   1.0 (2018-03-20)<br>
'''Tested in:''' PM 3.3.0 Community in Debian 9.5 with PHP 5.6.37 and Firefox 59<br>
'''License:'''   [https://www.gnu.org/licenses/lgpl-3.0.en.html GNU Lesser General Protection License 3.0] 
--------

Remember that if you are sharing a file and want to use a license, then you need to provide a license that allows others to modify it, so open source licenses like LGPL or MIT or a similar license are encouraged.

Editing this wiki

Consult the User's Guide for information on using the wiki software.