Difference between revisions of "User:Hawk"
From Documentation
(257 intermediate revisions by the same user not shown) | |||
Line 1: | Line 1: | ||
+ | |||
+ | = 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 = | = Documentation = | ||
− | + | client-side | |
− | + | ||
− | [ | + | you can pop a confirm dialog with <tt>jq.confirm(msg);</tt> |
+ | |||
+ | or <tt>jq.alert(msg)</tt> | ||
+ | |||
+ | [[File:confirm-dialog.png]] | ||
− | |||
− | |||
== Under Review == | == Under Review == | ||
+ | |||
+ | [[ZK Document Style Convention]] | ||
== Ready for Publish== | == Ready for Publish== | ||
− | |||
== Suspend == | == Suspend == | ||
− | + | * [[User:Hawk/Widget Event]] | |
− | [[User:Hawk/Create Data Binding Programmatically]] | + | * [[User:Hawk/Create Data Binding Programmatically]] |
− | + | * [[User:Hawk/Tutorial Extension-UnitTest]] | |
== Already published == | == Already published == | ||
Line 40: | Line 66: | ||
# [[ZK%20Developer's%20Reference/Integration/Persistence%20Layer/Hibernate]] | # [[ZK%20Developer's%20Reference/Integration/Persistence%20Layer/Hibernate]] | ||
# [[ZK%20Developer's%20Reference/Integration/Persistence%20Layer/JPA]] | # [[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 | ||
− | + | Writing: | |
− | + | # Topic sentence first, then supporting sentences | |
− | + | # Describe the purpose or context at the beginning. | |
− | |||
− | # Describe the purpose or context at the | ||
# 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. | ||
− | # | + | # 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 | ||
− | |||
# 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. | ||
− | ## Shrink size if a picture | + | ## Shrink size if a picture's width is wider than page width. |
− | # Code | + | # 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 codes. | ## 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 codes 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) | ## Highlight key points in descriptions of code example. (Because most engineers read code first instead of text) | ||
+ | ## give short description for a code snippet for its purpose | ||
+ | ## 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 | ||
+ | # 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 | ||
+ | # Store example codes in a version control repository. They can be changed or verified in the future. | ||
+ | # use an editor with a spell checker | ||
+ | # Write directly on wiki page instead of writing in a word processor. | ||
+ | == Learning Resource == | ||
+ | English Writing: | ||
+ | * The Elements of Style, William Strunk, Jr ., 1918 | ||
+ | * [https://owl.english.purdue.edu/owl/ Purdue University Online Writing Lab] | ||
+ | * search "grammar girl" for grammar tips | ||
− | + | Technical Writing: | |
− | + | * [http://www.chineseowl.idv.tw/html/lla.html 柯泰德線上英文論文編修訓練服務] | |
− | + | * [http://www.books.com.tw/products/0010556038 寫作大師的秘密聖經: 一次解決所有英文寫作問題] | |
− | |||
− | |||
− | |||
− | |||
− | * | ||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | [ | ||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | http:// | ||
== Deprecated == | == Deprecated == | ||
Line 113: | Line 142: | ||
[[User:Hawk/ZK Brief Intro and Simple Architecture]] | [[User:Hawk/ZK Brief Intro and Simple Architecture]] | ||
− | [[User:Hawk/ | + | = 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
New Features of ZK 10.0.0 Beta
Special Pages
JavaScript Wiki Browser
visit Documentation:AutoWikiBrowser/Script
Under Editing
Documentation
client-side
you can pop a confirm dialog with jq.confirm(msg);
or jq.alert(msg)
Under Review
Ready for Publish
Suspend
- User:Hawk/Widget Event
- User:Hawk/Create Data Binding Programmatically
- User:Hawk/Tutorial Extension-UnitTest
Already published
- Small_Talks/2011/December/MVVM_in_ZK6:in_Contrast_to_MVC
- Small Talks/2012/January/Ajax GSP with ZK
- Small Talks/2012/January/Enrich Grails Server Pages (GSPs) with ZK
- Small_Talks/2012/January/MVVM_Extension:_Access_UI_Components_Inside_ViewModel
- Small_Talks/2012/February/MVVM_in_ZK6:_Form_Binding
- Small_Talks/2012/February/MVVM_in_ZK6:_Work_with_Spring
- ZK Developer's Reference/MVVM (whole chapter)
- Small Talks/2012/April/The Dawn of ZK Application Test Suite:Mimic Library
- Small Talks/2012/April/Shining ZATS Mimic
- ZATS Essentials
- ZK Getting Started/Learn ZK in 10 Minutes
- ZK Getting Started/Get ZK Up and Running with MVC
- ZK Getting Started/Get ZK Up and Running with MVVM
- Small Talks/2012/October/Binding with Collection and Selection
- Small_Talks/2012/November/How_to_Apply_Responsive_Design
- ZK Developer's Reference/Integration/Middleware Layer/Spring
- ZK Developer's Reference/Integration/Middleware Layer/CDI
- ZK Developer's Reference/Integration/Persistence Layer/Hibernate
- ZK Developer's Reference/Integration/Persistence Layer/JPA
- Small_Talks/2013/January/Building_User_Interface_Programmatically_with_Richlet
- ZK Developer's Reference/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
Writing:
- Topic sentence first, then supporting sentences
- Describe the purpose or context at the beginning.
- To start from a basic, simple concept or fewer concepts.
- 1 paragraph presents 1 idea.
- 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)
- Choose Active, Precise Verbs
- Check header, footer, TOC, subsections, references
- Picture is better than words.
- Picture should be elegant.
- Picture should present just exactly enough information.
- Set align to center.
- 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.
- Keep as short as possible. Just extract the key part
- Demonstrate only key concepts and remove irrelevant codes.
- Demonstrate the correct API usage instead of work-around
- 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)
- give short description for a code snippet for its purpose
- 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
- 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
- Store example codes in a version control repository. They can be changed or verified in the future.
- use an editor with a spell checker
- Write directly on wiki page instead of writing in a word processor.
Learning Resource
English Writing:
- The Elements of Style, William Strunk, Jr ., 1918
- Purdue University Online Writing Lab
- search "grammar girl" for grammar tips
Technical Writing:
Deprecated
User:Hawk/Simple ZK deprecated
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