Documenta*on	  Insight                  	             	  
•  Spring	  Framework	  for	  Delphi	     	  •  DevJET.net	           	  •                                   	  
Spring	  Framework	  for	  Delphi
Technical	  Writers•  Help	  Authoring	     –  Overview	     –  GeCng	  started	     –  How	  to	     –  …	  •  API	  Docu...
XMLDoc///	  <summary>Provides	  access	  to	  informa*on	  on	  a	  drive.</summary>	  ///	  <remarks>	  ///	  	  	  Use	 ...
Help	  Insight
 •  XML,	  XPath,	  XSLT	  •  Inline	  Documenta*on	       –  IDE        	                •           	                •  ...
•  Documenta*on	  Insight	  Demo
Documenta*on	  Insight
Add-­‐inTransforma*ons	    XML	  <-­‐>	  HTML  Code	  Model
Code	  Model
Code	  Model•  Lexer	      –               	      –  Input:	  Stream	      –  Output:	  Tokens	  •  Parser	      –        ...
Transforma*ons•  XML	  to	  XHTML	  •  XHTML	  to	  XML	  
XSLT•  Extensible	  Stylesheet	  Language	     Transforma*ons	  •  Data	  Presenta*on	  (Style)	  •  Data	  Transforma*on	...
<?xml	  version="1.0"	  encoding="UTF-­‐8"	  ?>	  <xsl:stylesheet	  version="1.0"	  xmlns:xsl="hbp://www.w3.org/1999/XSL/T...
Add-­‐in•  Extending	  Delphi	  IDE	     –  Splash	  Screen	     –  Menus	     –  Hotkeys	     –  No*fica*ons	     –  Insta...
WebBrowser	  Customiza*on•  designMode	  vs	  contentEditable	  •  Execute	  Script	  •  External
•    Spring4d      API	  Documenta*on	  •           	  
•         	       –                                  	       –           API             	  •         	       –      Delph...
•  Standard	     –  Delphi	  Documenta*on	  Guidelines	  •  Documenta*on	  Insight	  •  Documenta*on	  Generator	  •  Inco...
•    $10-­‐15	  •    $49-­‐69	  •    $89-­‐99	  •    >$100	  
•  Hos*ng	     –  Hostmonster	          •  WordPress	  •  Sales	  Plamorm	     –  Share	  It!	          •  Gross	  Price/N...
•      CnPack                           	  •        Open	  Source	  Projects	  •                              	  •        ...
•       Delphi                 	  •    Visual	  Studio   	  
•             	  •             	  •  V1.0	  • 
Q	  &	  AEmail/MSN:	  Baoquan.Zuo@gmail.com	  Follow	  Me:	  	  	  weibo.com/zuobaoquan	  
Email/MSN:	  Baoquan.Zuo@gmail.com	  Follow	  Me:	  	  	  weibo.com/zuobaoquan	  
Documentation Insight技术架构与开发历程
Documentation Insight技术架构与开发历程
Documentation Insight技术架构与开发历程
Documentation Insight技术架构与开发历程
Documentation Insight技术架构与开发历程
Documentation Insight技术架构与开发历程
Upcoming SlideShare
Loading in...5
×

Documentation Insight技术架构与开发历程

1,270

Published on

Published in: Technology
0 Comments
1 Like
Statistics
Notes
  • Be the first to comment

No Downloads
Views
Total Views
1,270
On Slideshare
0
From Embeds
0
Number of Embeds
0
Actions
Shares
0
Downloads
16
Comments
0
Likes
1
Embeds 0
No embeds

No notes for slide

Documentation Insight技术架构与开发历程

  1. 1. Documenta*on  Insight    
  2. 2. •  Spring  Framework  for  Delphi    •  DevJET.net    •   
  3. 3. Spring  Framework  for  Delphi
  4. 4. Technical  Writers•  Help  Authoring   –  Overview   –  GeCng  started   –  How  to   –  …  •  API  Documenta*on   –  JavaDoc   –  XMLDoc  
  5. 5. XMLDoc///  <summary>Provides  access  to  informa*on  on  a  drive.</summary>  ///  <remarks>  ///      Use  the  sta*c  <see  cref=“Spring.U*ls|TDriveInfo.GetDrives“  />  ///      method  to  retrieve  all  drives  of  the  computer.  ///      <note  type="caller">  ///      Caller  must  use  the  <see  cref="Spring.U*ls|TDriveInfo.IsReady">IsReady</see>  ///      property  to  check  whether  the  drive  is  ready  before  accessing  other  members.  Otherwise,  ///      an  <see  cref="Spring|EIOExcep*on“  />  excep*on  will  be  raised  if  ///      it  is  not  ready.  ///      </note>  ///  </remarks>  TDriveInfo  =  record  //…  end;  
  6. 6. Help  Insight
  7. 7.  •  XML,  XPath,  XSLT  •  Inline  Documenta*on   –  IDE   •    •     •   •   •   
  8. 8. •  Documenta*on  Insight  Demo
  9. 9. Documenta*on  Insight
  10. 10. Add-­‐inTransforma*ons   XML  <-­‐>  HTML Code  Model
  11. 11. Code  Model
  12. 12. Code  Model•  Lexer   –    –  Input:  Stream   –  Output:  Tokens  •  Parser   –    –  Abstract  Syntax  Tree   –  Symbols   – 
  13. 13. Transforma*ons•  XML  to  XHTML  •  XHTML  to  XML  
  14. 14. XSLT•  Extensible  Stylesheet  Language   Transforma*ons  •  Data  Presenta*on  (Style)  •  Data  Transforma*on  (Exchange)  •  Rule-­‐Based  Programming  Language  
  15. 15. <?xml  version="1.0"  encoding="UTF-­‐8"  ?>  <xsl:stylesheet  version="1.0"  xmlns:xsl="hbp://www.w3.org/1999/XSL/Transform">   <xsl:template  match="/">          <html  xmlns="hbp://www.w3.org/TR/xhtml1">                  <head>                          <*tle>Documenta*on</*tle>                  </head>                  <body>                          <div  id="mainSec*on">                                  <div  id="mainBody">                                          <xsl:call-­‐template  name="insertSec*ons"  />                                  </div>                          </div>                  </body>          </html>   </xsl:template>  </xsl:stylesheet>
  16. 16. Add-­‐in•  Extending  Delphi  IDE   –  Splash  Screen   –  Menus   –  Hotkeys   –  No*fica*ons   –  Installa*on/Uninstalla*on   –  Dockable  Form  
  17. 17. WebBrowser  Customiza*on•  designMode  vs  contentEditable  •  Execute  Script  •  External
  18. 18. •  Spring4d API  Documenta*on  •   
  19. 19. •    –    –  API  •    –  Delphi   –  Code  Library   –   
  20. 20. •  Standard   –  Delphi  Documenta*on  Guidelines  •  Documenta*on  Insight  •  Documenta*on  Generator  •  Incorpora*ons     –  H&M   –  Embarcadero  
  21. 21. •  $10-­‐15  •  $49-­‐69  •  $89-­‐99  •  >$100  
  22. 22. •  Hos*ng   –  Hostmonster   •  WordPress  •  Sales  Plamorm   –  Share  It!   •  Gross  Price/Net  Price  (VAT)   •  Margin:  4.9%  +  1  USD/EUR  per  license   •  Payment  cycle   •  Promo*ons   •  Refund  
  23. 23. •  CnPack  •  Open  Source  Projects  •   •  Licenses  •   •  Google  Ads  &SEO  •  Express Delphi  IDE  •  Help  &  Manual,  Doc-­‐O-­‐Ma*c  
  24. 24. •  Delphi  •  Visual  Studio  
  25. 25. •   •   •  V1.0  • 
  26. 26. Q  &  AEmail/MSN:  Baoquan.Zuo@gmail.com  Follow  Me:      weibo.com/zuobaoquan  
  27. 27. Email/MSN:  Baoquan.Zuo@gmail.com  Follow  Me:      weibo.com/zuobaoquan  
  1. A particular slide catching your eye?

    Clipping is a handy way to collect important slides you want to go back to later.

×