Difference between revisions of "Help:Contents"
m (Created page with 'See [http://docs.zkoss.org/wiki/Help:Contents Here]') |
|||
Line 1: | Line 1: | ||
− | + | = 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: | ||
+ | |||
+ | #Updates for out-dated or missing descriptions, concepts, code, images and so on | ||
+ | #Good examples | ||
+ | #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== | ||
+ | '''*[[User:Tmillsclare | Timothy Clare]], [[User_talk:Tmillsclare|Leave a message]], Principle Editor of ZK Wiki.''' | ||
+ | <br/> | ||
+ | Please leave a message if you need any help or have any trouble using ZK Wiki. | ||
+ | <br/>Or email to [mailto:info@zkoss.org us] if there is any trouble. | ||
+ | |||
+ | '''<font style="color:blue">Note: If you're interested in becoming an editor of ZK wiki, please leave a message to any of above editors.</font>''' | ||
+ | |||
+ | =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. | ||
+ | {|style=";border: 1px solid #777777;" cellspacing="5" | ||
+ | |- | ||
+ | | style="text-align:center;background:#606060;color:white;width:250px;text-align:center;"|Wiki Text | ||
+ | | style="text-align:center;background:#808080;color:white;width:250px;text-align:center;"| Result | ||
+ | |- | ||
+ | |align="center" |<nowiki>{{Template:Help_Udst}}</nowiki> | ||
+ | |align="center"|{{Template:Help_Udst}} | ||
+ | |} | ||
+ | |||
+ | === 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. | ||
+ | {|style=";border: 1px solid #777777;" cellspacing="5" | ||
+ | |- | ||
+ | | style="text-align:center;background:#606060;color:white;width:250px;text-align:center;"|Wiki Text | ||
+ | | style="text-align:center;background:#808080;color:white;width:250px;text-align:center;"| Result | ||
+ | |- | ||
+ | |align="center" |<nowiki>{{Template:Help Request}}</nowiki> | ||
+ | |align="center"|{{Template:Help Request}} | ||
+ | |} | ||
+ | |||
+ | ==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 === | ||
+ | |||
+ | #Read through this page before you start | ||
+ | #Create a ZK Wiki account by clicking '''create account''' in the top-right corner | ||
+ | #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. | ||
+ | #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 | ||
+ | |||
+ | == Editing Wiki == | ||
+ | === Official Help === | ||
+ | *[http://www.mediawiki.org/wiki/Category:Help Category Help] | ||
+ | *: Wiki category information | ||
+ | *[http://meta.wikimedia.org/wiki/Help:Wikitext_examples Wikitext Help] | ||
+ | *: How to ''italicize'' ? How to <strike>Strike</strike> ? | ||
+ | *[http://meta.wikimedia.org/wiki/Help:Editing Editing Help] | ||
+ | *: Some wiki formatting directions | ||
+ | |||
+ | === ZK Documentation === | ||
+ | *[[HELP:Editing|Editing Tips]] | ||
+ | *: Some extension guides and frequent useage within ZK Doc. | ||
+ | *[[Help:Writing Small Talks| Write New Small Talks]] | ||
+ | *: A guide to the process writing small talks. | ||
+ | ====Drop==== | ||
+ | =====Old Version===== | ||
+ | |||
+ | {|style=";border: 1px solid #777777;" cellspacing="5" | ||
+ | |- | ||
+ | | style="text-align:center;background:#606060;color:white;width:350px;text-align:center;"|Wiki Text | ||
+ | | style="text-align:center;background:#808080;color:white;width:350px;text-align:center;"| Result | ||
+ | |- | ||
+ | |align="center" |<nowiki>{{Old Version|url=http://books.zkoss.org/wiki/|}}</nowiki> | ||
+ | |align="center"|{{Old Version|url=http://books.zkoss.org/wiki/|}} | ||
+ | |} | ||
+ | |||
+ | =====Depreciated===== | ||
+ | {|style=";border: 1px solid #777777;" cellspacing="5" | ||
+ | |- | ||
+ | | style="text-align:center;background:#606060;color:white;width:350px;text-align:center;"|Wiki Text | ||
+ | | style="text-align:center;background:#808080;color:white;width:350px;text-align:center;"| Result | ||
+ | |- | ||
+ | |align="center" |<nowiki>{{Depreciated|url=http://books.zkoss.org/wiki/}}</nowiki> | ||
+ | |align="center"|{{Depreciated|url=http://books.zkoss.org/wiki/|}} | ||
+ | |} | ||
+ | |||
+ | ==== Draft Mark ==== | ||
+ | ===== Paragraph Under Construction ===== | ||
+ | {|style=";border: 1px solid #777777;" cellspacing="5" | ||
+ | |- | ||
+ | | style="text-align:center;background:#606060;color:white;width:350px;text-align:center;"|Wiki Text | ||
+ | | style="text-align:center;background:#808080;color:white;width:350px;text-align:center;"| Result | ||
+ | |- | ||
+ | |align="center" |<nowiki>{{Template:UnderConstructionParagraph}}</nowiki> | ||
+ | |align="center"|{{Template:UnderConstructionParagraph}} | ||
+ | |} | ||
+ | ===== Page Under Construction ===== | ||
+ | {|style=";border: 1px solid #777777;" cellspacing="5" | ||
+ | |- | ||
+ | | style="text-align:center;background:#606060;color:white;width:350px;text-align:center;"|Wiki Text | ||
+ | | style="text-align:center;background:#808080;color:white;width:350px;text-align:center;"| Result | ||
+ | |- | ||
+ | |align="center" |<nowiki>{{Template:UnderConstruction}}</nowiki> | ||
+ | |align="center"|{{Template:UnderConstruction}} | ||
+ | |} | ||
+ | |||
+ | =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. | ||
+ | ==Image== | ||
+ | *[[Unlink Resource]] : Some images directly linked. |
Revision as of 08:08, 18 January 2011
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:
- Updates for out-dated or missing descriptions, concepts, code, images and so on
- Good examples
- 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
* Timothy Clare, Leave a message, Principle Editor of ZK Wiki.
Please leave a message if you need any help or have any trouble using ZK Wiki.
Or email to us if there is any trouble.
Note: If you're interested in becoming an editor of ZK wiki, please leave a message to any of above editors.
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 |
{{Template:Help_Udst}} |
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 |
{{Template:Help Request}} |
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
- Read through this page before you start
- Create a ZK Wiki account by clicking create account in the top-right corner
- 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.
- 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
Editing Wiki
Official Help
- Category Help
- Wiki category information
- Wikitext Help
- How to italicize ? How to
Strike?
- How to italicize ? How to
- 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. |
Depreciated
Wiki Text | Result |
{{Depreciated|url=http://books.zkoss.org/wiki/}} | Template:Depreciated |
Draft Mark
Paragraph Under Construction
Wiki Text | Result |
{{Template:UnderConstructionParagraph}} |
Page Under Construction
Wiki Text | Result |
{{Template:UnderConstruction}} |
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.
Image
- Unlink Resource : Some images directly linked.