Help:Contents

About ZK Wiki Documentation

The ZK Wiki Documentation, or ZK Documentation, is a collaborative area designed to leverage the power of the community to maintain complete and up-to-date ZK reference material. We encourage you to share your developing experiences by adding and changing content.

Specifically, we would be ecstatic receiving the following contributions:

1. Updates for out-dated or missing descriptions, concepts, code, images and so on
2. Good examples
3. Proofreading

Admin of ZK Wiki Documentation

Goal

• Making ZK Documentations more complete
• Organize rules about wiki
• Monitor community activities
• Encourage more participation from the Community

Admin

• Main admin contact info@zkoss.org.

Please leave a message if you need any help or have any trouble using ZK Wiki.

Note: If you're interested in becoming an editor of ZK wiki, please leave a message to this address.

Help

Reading

Can't Understand

• If any part of document is hard to understand, you can add the Template:Help_Udst to it and community will enhance the language.

Wiki Text	Result
{{Help_Udst}}	This is not clear.

Content Request

• If any part of document is lost or not created, you can add the Template:Help Request template to it, the community will then take it into consideration while editing.

Wiki Text	Result
{{Help Request}}	ZK Folks ! Help me !

Contributing

How to Contribute

Anyone with an approved ZK Wiki account can contribute to the ZK Wiki Documentation. Please follow the contribution flow below.

Contributing Flow

1. Read through this page before you start
2. Create a ZK Wiki account by clicking create account in the top-right corner
3. You will receive an activation mail in a few minutes after sign-up. Follow the instructions in the mail to activate your ZK Wiki account.
4. Once your account is activated, you can login with your Wiki ID and edit the ZK Wiki Documentation

Please note: A ZK Wiki account differs from a ZK account, to edit ZK Wiki Documentation you will need a ZK Wiki account.

Rules and Obligations

• ZK Wiki Documentation is open to the public. By contributing a Small Talk, you agree that the Small Talk is released under the GNU Free Documentation License. By contributing other work to the ZK Wiki Documentation, you agree to surrender the copyright of your work in ZK Wiki Documentation to Potix.
• Do not submit copyrighted work without permission
• You participate at your own risk. You take responsibility for your own postings and use the information provided on this site at your own risk.
• Obscene, racist, homophobic, sexist, or sexually explicit languages are not allowed. Potix reserves the right to remove postings that defame or insult anyone, as well as posts that are abusive or hateful.
• Your contribution should be in English, or any language approved by Potix. Potix reserves the right to remove content that is off-topic or not in English.
• No solicitations or advertisements are permitted
• Put source code in https://github.com/zkoss-demo

Editing Wiki

Official Help

• Category Help

  Wiki category information

• Wikitext Help

  How to italicize ? How to Strike ?

• Editing Help

  Some wiki formatting directions

ZK Documentation

• Editing Tips

  Some extension guides and frequent useage within ZK Doc.

• Write New Small Talks

  A guide to the process writing small talks.

Drop

Old Version

Wiki Text	Result
{{Old Version|url=http://books.zkoss.org/wiki/|}}	This documentation is for an older version of ZK. For the latest one, please click here.

Deprecated

Wiki Text	Result
{{Deprecated|url=http://books.zkoss.org/wiki/}}	This article is out of date, please refer to http://books.zkoss.org/wiki/ for more up to date information.
{{Deprecated_Content}}	Note: The content of this page has been deprecated/removed in the latest version.
{{Notice|text=description about the notice}}	Notice: description about the notice

Draft Mark

Paragraph Under Construction

Wiki Text	Result
{{Template:UnderConstructionParagraph}}	This paragraph is under construction.

Page Under Construction

Wiki Text	Result
{{Template:UnderConstruction}}	This page is under construction, so we cannot guarantee the accuracy of the content!

Resources

Some resources which are not used within the smalltalks but are available for use, they are placed here to avoid wiki tagging them as unused file.

Flash/SWF/Video

• Flash collection : Some smalltalk video files.