How to Write a How To"
Tmillsclare (talk | contribs) |
|||
| (6 intermediate revisions by one other user not shown) | |||
| Line 12: | Line 12: | ||
We have made some categories below. Please choose a category which best fits your How-To. | We have made some categories below. Please choose a category which best fits your How-To. | ||
| − | Components | + | Components<br /> |
| − | Configuration | + | Configuration<br /> |
| − | Data binding | + | Data binding<br /> |
| − | Framework Integration | + | Framework Integration<br /> |
| − | Look and Feel | + | Look and Feel<br /> |
| − | Installation | + | Installation<br /> |
| − | Performance and Testing | + | Performance and Testing<br /> |
Sample applications | Sample applications | ||
| − | |||
=Creating the relevant page= | =Creating the relevant page= | ||
| Line 37: | Line 36: | ||
And I chose the category “'''''Components'''''” I would then have to sub categorize by component name; In this case “'''''Grid'''''.” | And I chose the category “'''''Components'''''” I would then have to sub categorize by component name; In this case “'''''Grid'''''.” | ||
| − | Creating the page then is a simple task, the page URL follows this structure: | + | Creating the page then is a simple task, the page URL follows this structure: <nowiki>http://books.zkoss.org/how tos/components/</nowiki>'''[component name]'''/'''[question/how to title]''' |
| − | |||
| − | |||
| − | <nowiki>http://books.zkoss.org/how tos/components/'''[component name]'''/'''[question/how to title]''' | ||
| − | |||
| − | |||
| − | |||
| − | <nowiki> | + | In the case of the above question the full page URL would be: <nowiki>http://books.zkoss.org/how tos/components/grid/How do I support huge data in a Grid</nowiki> |
| − | Now all that is required is to edit and create the page. For details on formatting your page please take a look at the wiki formatting instructions. For more information on ZK wiki specific formatting options, such as for source code snippets please follow the [[ | + | Now all that is required is to edit and create the page. For details on formatting your page please take a look at the wiki formatting instructions. For more information on ZK wiki specific formatting options, such as for source code snippets please follow the [[ZK Book Cheatsheet]]. |
== If you chose any category except for “Components” == | == If you chose any category except for “Components” == | ||
| Line 55: | Line 48: | ||
If you chose a category other than the component category then creating a page is an easier affair. The following is the URL structure. | If you chose a category other than the component category then creating a page is an easier affair. The following is the URL structure. | ||
| − | http://books.zkoss.org/how tos/'''[category]'''/'''[question/how to title]''' | + | <nowiki>http://books.zkoss.org/how tos</nowiki>/'''[category]'''/'''[question/how to title]''' |
Therefore if you want to use the title and: | Therefore if you want to use the title and: | ||
| Line 63: | Line 56: | ||
And chose “Installation” as the category name, the subsequent page URL would be: | And chose “Installation” as the category name, the subsequent page URL would be: | ||
| − | http://books.zkoss.org/how tos/installation/How do I install ZK into Tomcat | + | <nowiki>http://books.zkoss.org/how tos</nowiki>/installation/How do I install ZK into Tomcat |
=Insert Header and Footer= | =Insert Header and Footer= | ||
| − | {{HowToPageHeader}} | + | <nowiki>{{HowToPageHeader}}</nowiki><br /> |
| − | TEXT HERE | + | TEXT HERE <br /> |
| − | {{HowToPageFooter}} | + | <nowiki>{{HowToPageFooter}}</nowiki> |
Latest revision as of 03:53, 29 December 2010
Think of a title
Choose a title for your how-to. It can be anything but should be in the form of a question. For example:
How do I implement the MVC pattern using ZK
On the wiki there is no need to put a ‘?’ at the end.
Pick a category for your How-To
We have made some categories below. Please choose a category which best fits your How-To.
Components
Configuration
Data binding
Framework Integration
Look and Feel
Installation
Performance and Testing
Sample applications
Creating the relevant page
Creating the page is an easy task. However it does depend on which category you chose.
If you chose the “Components” category
To create the page when selecting the Components category you are required to sub categorize by the component name. For example if I wanted to use the question:
How do I support huge data in a Grid
And I chose the category “Components” I would then have to sub categorize by component name; In this case “Grid.”
Creating the page then is a simple task, the page URL follows this structure: http://books.zkoss.org/how tos/components/[component name]/[question/how to title]
In the case of the above question the full page URL would be: http://books.zkoss.org/how tos/components/grid/How do I support huge data in a Grid
Now all that is required is to edit and create the page. For details on formatting your page please take a look at the wiki formatting instructions. For more information on ZK wiki specific formatting options, such as for source code snippets please follow the ZK Book Cheatsheet.
If you chose any category except for “Components”
If you chose a category other than the component category then creating a page is an easier affair. The following is the URL structure.
http://books.zkoss.org/how tos/[category]/[question/how to title]
Therefore if you want to use the title and:
How do I install ZK into Tomcat
And chose “Installation” as the category name, the subsequent page URL would be:
http://books.zkoss.org/how tos/installation/How do I install ZK into Tomcat
{{HowToPageHeader}}
TEXT HERE
{{HowToPageFooter}}