From Documentation

(Redirected from Help:Writing Small Talks)
Jump to: navigation, search




Contents


General Information

  • If you want to change the smalltalk's title, you can add redirection at first line.
  #REDIRECT  [[pagename]]

Create a Page

To create a Small Talk in our current set-up just use the URL:http://books.zkoss.org/wiki/Small_Talks/YEAR/MONTH/The_Name_Of_My_Page

Replacing The_Name_Of_My_Page with the name of your article. The general convention with the wiki is to replace any spaces with an _ (underscore) in the URL link. If in any doubt you can create a link to your article below by editing this page and using the following:

[[The Name Of You Article]]


  • Naming Convention:
    • use Article Name as Page name
    • use underline to replace whitespace (ex. MVC_Made_Easy)
  • Date Ascending

Editing the Content of Page

{{Template:Smalltalk_Author|
|author=Charles Pao, Engineer, Potix Corporation
|date=November 04, 2008
|version=ZK Studio 0.9
}}
it will show




  • Author
    Charles Pao, Engineer, Potix Corporation
  • Date
    November 04, 2008
  • Version
    ZK Studio 0.9
  • start to edit your own content
    • if your page is still draft or under review, you should put Draft Mark on it.

Adding Images

To add images to your Small Talk you need to navigate to Special:Upload. On this page you are able to upload your images and then include them in the page using the following syntax:

   * [[Image:File.jpg]] to use the full version of the file
   * [[Image:File.png|200px|thumb|left|alt text]] to use a 200 pixel wide rendition in a box in the left margin with 'alt text' as description
   * [[Media:File.ogg]] for directly linking to the file without displaying the file 

For more information please click here.

Adding WAR/ZIP/Source Code to your Small Talk

If you want to add any source code to your Small Talk it is recommended to host your code in github or google code then add a link to your small talk.




Headline text

After Editting the Content

  • add See Also section (not necessary to add hyperlinks.)
  • add related categories at the bottom of your article (multiple categories are allowed)
    • Must Add [[Category:Small Talk]]
    • for example. [[Category:Tutorial]]
  • add Footer (include copyright declaration and comment link)
{{Template:CommentedSmalltalk_Footer_new|
|name=Potix Corporation
}}
it will show

Comments



Copyright © Potix Corporation. This article is licensed under GNU Free Documentation License.



Content Guidelines

Here are some guidelines that you should follow, or at least keep in mind or reference to when you're writing a small talk, a blog or just any article in general.

1. if you are including a demo in your small talk/blog, when you record it, please remember to set the size accordingly so that it stays inside the margin of the page.

for example, please don't let this happen --> http://books.zkoss.org/wiki/Small_Talks/2012/February/How_To_Use_Canvas4Z_Part2

2. When you write, please write an introduction, a body and a conclusion.

Introduction should consist of:

- purpose of writing - how this component/feature/implementation/integration etc. is beneficial in any way and its reason

Body:

- implementation steps - code snippets - demo etc.

Conclusion:

- summarize the article

A good small talk example: Small_Talks/2011/December/MVVM_in_ZK6:in_Contrast_to_MVC

Notify community admin

Notify community admin for article review, news announcement, and put your name into Hall-of-Fame page.

Biography and photo

In addition we would like to always include a biography and photo with every Small Talk, therefore if you want to provide this information please contact the Admin.

Notice

About Tracker

If you want your link (especially Download) become tracker, you MUST use this.

 <tracker url="http://URL" page="my download link">Text</tracker>
  • url : the link destination
  • Text : the text stands for the link
  • page(option): the tracker's label , this attribute is optional.

About Categories

  • Acegi
  • Apache Struts
  • Apache Tiles 2
  • Application Server
  • Database
  • Databinding
  • Eclipse
  • Event Queue
  • Framework
  • Grinder
  • Hibernate
  • I18N
  • IDE
  • Installation
  • JAAS
  • JSF
  • JSF
  • JSP
  • JSP
  • JUnit
  • Liferay
  • MVC
  • NetBeans
  • Portlet
  • Seam
  • Seasar
  • Server Push
  • Spring
  • Spring Security
  • Tutorial
  • Unit Test


Indexed Categories

Indexed categories are those present on the Small Talk tree.

  • Beginner
    • Overview
    • Working with IDEs
  • Data Access
    • Data Binding
    • Hibernate
    • JDBC
    • JPA
  • Design Patterns
    • MVC
    • Server Push
    • Server+Client fusion
  • Enterpise
    • Charting and Reports
    • Component Development
    • Performance
    • Security
  • Integration
    • 3rd Party Components
    • Deployment
    • Other Frameworks
  • Products
    • New Features
    • ZK
    • ZK Calendar
    • ZK Mobile
    • ZK Spreadsheet
    • ZK Studio
    • ZK Web Flow
You got stuck here?
Let us know why!
For questions please use the forum