Difference between revisions of "User:Hawk"

From Documentation
 
(276 intermediate revisions by the same user not shown)
Line 1: Line 1:
−
= Documentation =
 
  
−
== Under Editing ==
+
= About Me =
 +
[http://hawkphoenix.blogspot.tw/ My Blog (Chinese)]
 +
 
 +
[[Client MVVM]]
 +
 
 +
[[embed demo]]
 +
 
 +
[[New Features of ZK 10.0.0 Beta]]
 +
 
 +
= Special Pages =
 +
* [https://www.zkoss.org/wiki/Category:Books Books]
 +
 
 +
= JavaScript Wiki Browser =
 +
visit [[Documentation:AutoWikiBrowser/Script]]
 +
 
 +
 
 +
= Under Editing =
 +
 
 +
[[Error Messages]]
  
 +
[[Copy Massive Cels]]
  
−
----
+
= Documentation =
  
−
[[User:Hawk/Tutorial Extension-UnitTest]]
+
client-side
  
 +
you can pop a confirm dialog  with <tt>jq.confirm(msg);</tt>
  
−
=== Under Review ===
+
or <tt>jq.alert(msg)</tt>
  
−
[[User:Hawk/Spring]]
+
[[File:confirm-dialog.png]]
  
−
[[User:Hawk/CDI]]
 
  
−
[[User:Hawk/Hibernate]]
 
  
−
[[User:Hawk/JPA]]
+
== Under Review ==
  
−
[[User:Hawk/Building User Interface Programmatically with Richlet]]
+
[[ZK Document Style Convention]]
  
 
== Ready for Publish==
 
== Ready for Publish==
−
[[User:Hawk/Getting Started with Responsive Design]]
+
 
 +
== Suspend ==
 +
* [[User:Hawk/Widget Event]]
 +
* [[User:Hawk/Create Data Binding Programmatically]]
 +
* [[User:Hawk/Tutorial Extension-UnitTest]]
  
 
== Already published ==
 
== Already published ==
Line 41: Line 62:
 
# [[Small Talks/2012/October/Binding with Collection and Selection]]
 
# [[Small Talks/2012/October/Binding with Collection and Selection]]
 
# [[Small_Talks/2012/November/How_to_Apply_Responsive_Design]]
 
# [[Small_Talks/2012/November/How_to_Apply_Responsive_Design]]
 +
# [[ZK%20Developer's%20Reference/Integration/Middleware%20Layer/Spring]]
 +
# [[ZK%20Developer's%20Reference/Integration/Middleware%20Layer/CDI]]
 +
# [[ZK%20Developer's%20Reference/Integration/Persistence%20Layer/Hibernate]]
 +
# [[ZK%20Developer's%20Reference/Integration/Persistence%20Layer/JPA]]
 +
# [[Small_Talks/2013/January/Building_User_Interface_Programmatically_with_Richlet]]
 +
# [[ZK%20Developer's%20Reference/Integration/Security/Spring Security]]
 +
# [[ZK Essentials]]
 +
# [[Small_Talks/2013/April/New_Features_of_ZK_Studio_2.0.0]]
 +
# [[ZK_Studio_Essentials]]
 +
# [[Small_Talks/2013/April/New_Features_of_ZATS_Mimic_1.1.0]]
 +
# [[Small_Talks/2013/June/ZK Binding Tracker - A Chrome Extension]]
 +
# [[ZK_Spreadsheet_Essentials]] (since 3.0.0)
 +
# http://books.zkoss.org/wiki/ZK_Getting_Started/Create_a_Project_with_Eclipse
 +
# [[Small_Talks/2015/March/Testing_ZK-based_Application_with_QF_Test]]
 +
# [[Small_Talks/2016/May/Integrating_ZK_with_Angular]]
  
 +
=Technical Writing =
 +
== My Practice of Writing Documents ==
 +
Preparation :
 +
# list assumptions for readers. To know which knowledge base which you build on and to decide which content the document should have.
 +
# write outline first.
 +
#: to be reviewed and discuss in bird's eye view
 +
#: check order of topic should have logical dependency
 +
# Pre-write quickly first.
 +
# need a technical proofreader to check technical concept
 +
# need an editor to check grammar and style.
 +
# Arrange topics with logic dependent orders, but leave some clues for those readers who skim a document
 +
## Title
 +
## Bold text
 +
## Pictures
 +
## Code highlight
  
−
# [[Small Talks/2012/October/Practices Of Using Spring In ZK]] (only revise)
+
Writing:
−
 
+
# Topic sentence first, then supporting sentences
−
== Writing Check List ==
+
# Describe the purpose or context at the beginning.
−
 
 
−
# Describe the purpose or context at the begining.
 
 
# To start from a basic, simple concept or fewer concepts.
 
# To start from a basic, simple concept or fewer concepts.
 
# 1 paragraph presents 1 idea.
 
# 1 paragraph presents 1 idea.
−
# Give the overall concept first, then the detail of implementation.
+
# overall concept first, an example, then technical detail
 +
# keep consistent style in code or describing way in multiple related articles
 +
# keep consistent wording or terminology.
 
# Summary at the end. (for small talk)
 
# Summary at the end. (for small talk)
 +
# Choose Active, Precise Verbs
 
# Check header, footer, TOC, subsections, references
 
# Check header, footer, TOC, subsections, references
−
# Check overall article's layout.
 
 
# Picture is better than words.
 
# Picture is better than words.
 
## Picture should be elegant.
 
## Picture should be elegant.
 
## Picture should present just exactly enough information.
 
## Picture should present just exactly enough information.
 
## Set align to center.
 
## Set align to center.
−
# Code snippet:
+
## Shrink size if a picture's width is wider than page width.
 +
# Code example:
 +
## Re-using same application as an example. It can reduce user's burden to realize your article.
 
## Focus on a general case not a specific one.
 
## Focus on a general case not a specific one.
−
## Keep as short as possible.
+
## Keep as short as possible. Just extract the key part
−
## Demonstrate only key concepts and remove irrelevant and unused ones.
+
## Demonstrate only key concepts and remove irrelevant codes.
−
## Demonstrate the correct API usage.
+
## Demonstrate the correct API usage instead of work-around
−
## Keep number of code examples as fewer as possible to reduce readers' burden.
+
## Keep number of codes as fewer as possible to reduce readers' burden.
−
 
+
## Highlight key points in descriptions of code example. (Because most engineers read code first instead of text)
−
== Message Template==
+
## give short description for a code snippet for its purpose
−
 
+
## leave related variables declaration
−
Standard:
+
## Line number first, then description because it's easier to look up descriptions upon lines, e.g. Line 13: this line's description
−
<div style="-webkit-border-radius:10px;-moz-border-radius:10px;border-radius:10px;-moz-background-clip:padding;-webkit-background-clip:padding-box;background-clip:padding-box;color:#c06330;padding:15px 40px;background:#fed no-repeat 13px 13px;margin-bottom:10px
+
# In Wiki page style, words before TOC is like preface. The "overview" should belong to one part of content and should be made as a header.
−
">
+
# When using third party library, specify its version
−
[[File:Icon_info.png ]] '''Note:''' note message
+
# Store example codes in a version control repository. They can be changed or verified in the future.
−
</div>
+
# use an editor with a spell checker
−
 
+
# Write directly on wiki page instead of writing in a word processor.
  
−
Deprecated:
+
== Learning Resource ==
−
<div style="background-color:Aquamarine;color:#40806A;border-radius:10px;padding:10px 10px 10px 10px;">
+
English Writing:
−
'''[i] Note:''' note message
+
* The Elements of Style, William Strunk, Jr ., 1918
−
</div>
+
* [https://owl.english.purdue.edu/owl/ Purdue University Online Writing Lab]
 +
* search "grammar girl" for grammar tips
  
−
 
+
Technical Writing:
−
<div style="background-color:gold;border-radius:10px;padding:10px 10px 10px 10px;">
+
* [http://www.chineseowl.idv.tw/html/lla.html 柯泰德線上英文論文編修訓練服務]
−
'''Warning:''' warning message
+
* [http://www.books.com.tw/products/0010556038 寫作大師的秘密聖經： 一次解決所有英文寫作問題]
−
</div>
 
−
 
 
−
 
 
−
 
 
−
Not Work sample:
 
−
<div style="background:#fed url('Icon_info.png') no-repeat 13px 13px;">
 
−
/_w/images/e/e2/Icon_info.png
 
−
</div>
 
−
 
 
−
== Font design ==
 
−
 
 
−
http://3.7designs.co/blog/2008/06/10-examples-of-beautiful-css-typography-and-how-they-did-it/
 
  
 
== Deprecated ==
 
== Deprecated ==
 
[[User:Hawk/Simple ZK deprecated]]
 
[[User:Hawk/Simple ZK deprecated]]
  
−
[[User:Hawk/temp]]
+
[[User:Hawk/ZK Brief Intro and Simple Architecture]]
 +
 
 +
= Supplement =
 +
* http://books.zkoss.org/wiki/User:Jimmyshiau
 +
*: Listbox, ZK container's default size, ID generator, Debug Client Error
 +
* [[User:Hawk/Selector Syntax]]
 +
* [[User:Hawk/Session Timeout Configuration]]
 +
* [[User:Hawk/Detach a Component under MVVM]]
 +
* [[User:Hawk/org.zkoss.zul.listbox.DataLoader.class]]
 +
* [[User:Hawk/org.zkoss.zul.grid.DataLoader.class]]

Latest revision as of 09:18, 4 October 2023

About Me

My Blog (Chinese)

Client MVVM

embed demo

New Features of ZK 10.0.0 Beta

Special Pages

JavaScript Wiki Browser

visit Documentation:AutoWikiBrowser/Script


Under Editing

Error Messages

Copy Massive Cels

Documentation

client-side

you can pop a confirm dialog with jq.confirm(msg);

or jq.alert(msg)

Confirm-dialog.png


Under Review

ZK Document Style Convention

Ready for Publish

Suspend

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
  23. Small_Talks/2013/April/New_Features_of_ZK_Studio_2.0.0
  24. ZK_Studio_Essentials
  25. Small_Talks/2013/April/New_Features_of_ZATS_Mimic_1.1.0
  26. Small_Talks/2013/June/ZK Binding Tracker - A Chrome Extension
  27. ZK_Spreadsheet_Essentials (since 3.0.0)
  28. http://books.zkoss.org/wiki/ZK_Getting_Started/Create_a_Project_with_Eclipse
  29. Small_Talks/2015/March/Testing_ZK-based_Application_with_QF_Test
  30. Small_Talks/2016/May/Integrating_ZK_with_Angular

Technical Writing

My Practice of Writing Documents

Preparation :

  1. list assumptions for readers. To know which knowledge base which you build on and to decide which content the document should have.
  2. write outline first.
    to be reviewed and discuss in bird's eye view
    check order of topic should have logical dependency
  3. Pre-write quickly first.
  4. need a technical proofreader to check technical concept
  5. need an editor to check grammar and style.
  6. Arrange topics with logic dependent orders, but leave some clues for those readers who skim a document
    1. Title
    2. Bold text
    3. Pictures
    4. Code highlight

Writing:

  1. Topic sentence first, then supporting sentences
  2. Describe the purpose or context at the beginning.
  3. To start from a basic, simple concept or fewer concepts.
  4. 1 paragraph presents 1 idea.
  5. overall concept first, an example, then technical detail
  6. keep consistent style in code or describing way in multiple related articles
  7. keep consistent wording or terminology.
  8. Summary at the end. (for small talk)
  9. Choose Active, Precise Verbs
  10. Check header, footer, TOC, subsections, references
  11. 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's width is wider than page width.
  12. Code example:
    1. Re-using same application as an example. It can reduce user's burden to realize your article.
    2. Focus on a general case not a specific one.
    3. Keep as short as possible. Just extract the key part
    4. Demonstrate only key concepts and remove irrelevant codes.
    5. Demonstrate the correct API usage instead of work-around
    6. Keep number of codes as fewer as possible to reduce readers' burden.
    7. Highlight key points in descriptions of code example. (Because most engineers read code first instead of text)
    8. give short description for a code snippet for its purpose
    9. leave related variables declaration
    10. Line number first, then description because it's easier to look up descriptions upon lines, e.g. Line 13: this line's description
  13. In Wiki page style, words before TOC is like preface. The "overview" should belong to one part of content and should be made as a header.
  14. When using third party library, specify its version
  15. Store example codes in a version control repository. They can be changed or verified in the future.
  16. use an editor with a spell checker
  17. Write directly on wiki page instead of writing in a word processor.

Learning Resource

English Writing:

Technical Writing:

Deprecated

User:Hawk/Simple ZK deprecated

User:Hawk/ZK Brief Intro and Simple Architecture

Supplement

Retrieved from "https://www.zkoss.org/_w/index.php?title=User:Hawk&oldid=56072"