Difference between revisions of "User:Hawk"

From Documentation
Line 2: Line 2:
  
 
== Under Editing ==
 
== Under Editing ==
 +
 +
 +
----
 +
 +
[[User:Hawk/Tutorial Extension-UnitTest]]
 +
 +
== Under Review ==
  
 
[[User:Hawk/Create and Run Your First ZK Application with Eclipse and ZK Studio]]
 
[[User:Hawk/Create and Run Your First ZK Application with Eclipse and ZK Studio]]
Line 26: Line 33:
 
* [[User:Hawk/ZK_Studio_Essentials/Preferences_of_ZK_Studio/Project_Properties]]
 
* [[User:Hawk/ZK_Studio_Essentials/Preferences_of_ZK_Studio/Project_Properties]]
  
[[User:Hawk/New_Features_of_ZK_Studio_2.0.0]]
 
 
----
 
  
[[User:Hawk/Tutorial Extension-UnitTest]]
+
== Ready for Publish==
  
== Under Review ==
+
[[User:Hawk/New_Features_of_ZK_Studio_2.0.0]]
  
  
== Ready for Publish==
 
:[[ZK Essentials/Chapter 1: Introduction]]
 
:[[ZK Essentials/Chapter 2: Project Structure]]
 
:[[ZK Essentials/Chapter 3: User Interface and Layout]]
 
:[[ZK Essentials/Chapter 4: Controlling Components]]
 
:[[ZK Essentials/Chapter 5: Handling User Input]]
 
:[[ZK Essentials/Chapter 6: Implementing CRUD]]
 
:[[ZK Essentials/Chapter 7: Navigation and Templating]]
 
:[[ZK Essentials/Chapter 8: Authentication]]
 
:[[ZK Essentials/Chapter 9: Spring Integration]]
 
:[[ZK Essentials/Chapter 10: JPA Integration]]
 
  
 
== Suspend ==
 
== Suspend ==
Line 75: Line 68:
 
# [[Small_Talks/2013/January/Building_User_Interface_Programmatically_with_Richlet]]
 
# [[Small_Talks/2013/January/Building_User_Interface_Programmatically_with_Richlet]]
 
# [[ZK%20Developer's%20Reference/Integration/Security/Spring Security]]
 
# [[ZK%20Developer's%20Reference/Integration/Security/Spring Security]]
 
+
# [[ZK Essentials]]
  
 
== Writing Check List ==
 
== Writing Check List ==

Revision as of 04:01, 29 March 2013

Documentation

Under Editing


User:Hawk/Tutorial Extension-UnitTest

Under Review

User:Hawk/Create and Run Your First ZK Application with Eclipse and ZK Studio

ZK Studio Essentials


Ready for Publish

User:Hawk/New_Features_of_ZK_Studio_2.0.0


Suspend

User:Hawk/Create Data Binding Programmatically


Already published

  1. Small_Talks/2011/December/MVVM_in_ZK6:in_Contrast_to_MVC
  2. Small Talks/2012/January/Ajax GSP with ZK
  3. Small Talks/2012/January/Enrich Grails Server Pages (GSPs) with ZK
  4. Small_Talks/2012/January/MVVM_Extension:_Access_UI_Components_Inside_ViewModel
  5. Small_Talks/2012/February/MVVM_in_ZK6:_Form_Binding
  6. Small_Talks/2012/February/MVVM_in_ZK6:_Work_with_Spring
  7. ZK Developer's Reference/MVVM (whole chapter)
  8. Small Talks/2012/April/The Dawn of ZK Application Test Suite:Mimic Library
  9. Small Talks/2012/April/Shining ZATS Mimic
  10. ZATS Essentials
  11. ZK Getting Started/Learn ZK in 10 Minutes
  12. ZK Getting Started/Get ZK Up and Running with MVC
  13. ZK Getting Started/Get ZK Up and Running with MVVM
  14. Small Talks/2012/October/Binding with Collection and Selection
  15. Small_Talks/2012/November/How_to_Apply_Responsive_Design
  16. ZK Developer's Reference/Integration/Middleware Layer/Spring
  17. ZK Developer's Reference/Integration/Middleware Layer/CDI
  18. ZK Developer's Reference/Integration/Persistence Layer/Hibernate
  19. ZK Developer's Reference/Integration/Persistence Layer/JPA
  20. Small_Talks/2013/January/Building_User_Interface_Programmatically_with_Richlet
  21. ZK Developer's Reference/Integration/Security/Spring Security
  22. ZK Essentials

Writing Check List

  1. Describe the purpose or context at the begining.
  2. To start from a basic, simple concept or fewer concepts.
  3. 1 paragraph presents 1 idea.
  4. Give the overall concept first, then the detail of implementation.
  5. keep consistent style in code or describing way in multiple related articles
  6. Summary at the end. (for small talk)
  7. Check header, footer, TOC, subsections, references
  8. Check overall article's layout.
  9. Picture is better than words.
    1. Picture should be elegant.
    2. Picture should present just exactly enough information.
    3. Set align to center.
    4. Shrink size if a picture occupies more than half of a page.
  10. Code snippet:
    1. Focus on a general case not a specific one.
    2. Keep as short as possible.
    3. Demonstrate only key concepts and remove irrelevant codes.
    4. Demonstrate the correct API usage.
    5. Keep number of codes as fewer as possible to reduce readers' burden.
    6. Highlight key points in descriptions of code example. (Because most engineers read code first instead of text)
  11. Using third party library, specify its version


Document Style

  • Image
    • make it center
    • Shrink the size for too big one
  • Code snippet
    • give short description for a code snippet for its purpose
    • Extracted the key part
    • leave related variables declaration
    • Line number first, then description because it's easier to look up descriptions upon lines.
      • e.g. Line 13: this line's description

Message Template

Standard:

Icon info.png Note: note message


Deprecated:

[i] Note: note message


Warning: warning message


Not Work sample:

/_w/images/e/e2/Icon_info.png

Font design

http://3.7designs.co/blog/2008/06/10-examples-of-beautiful-css-typography-and-how-they-did-it/

Deprecated

User:Hawk/Simple ZK deprecated

User:Hawk/ZK Brief Intro and Simple Architecture

User:Hawk/temp