ReST Editor - Eclipse Demo Camp Grenoble 2011

7,297
-1

Published on

Presentation of the ReST Edito

Published in: Technology, Education
0 Comments
0 Likes
Statistics
Notes
  • Be the first to comment

  • Be the first to like this

No Downloads
Views
Total Views
7,297
On Slideshare
0
From Embeds
0
Number of Embeds
1
Actions
Shares
0
Downloads
29
Comments
0
Likes
0
Embeds 0
No embeds

No notes for slide

ReST Editor - Eclipse Demo Camp Grenoble 2011

  1. 1. reStructuredText ReST Editor Questions ? ReST Editor Thomas Calmant isandlaTechThomas Calmant isandlaTech ReST Editor
  2. 2. Outline 1 reStructuredText A documentation language Sample code How to provide documents ? Compilation process Known users Existing editors 2 ReST Editor reStructuredText edition in Eclipse Open source plug-in The Run configuration A word about wrapping
  3. 3. A documentation language Sample code reStructuredText How to provide documents ? ReST Editor Compilation process Questions ? Known users Existing editorsA documentation language Designed for Python documentation (code and references) Thomas Calmant isandlaTech ReST Editor
  4. 4. A documentation language Sample code reStructuredText How to provide documents ? ReST Editor Compilation process Questions ? Known users Existing editorsA documentation language Designed for Python documentation (code and references) Defined at docutils.sourceforge.net by David Goodger Thomas Calmant isandlaTech ReST Editor
  5. 5. A documentation language Sample code reStructuredText How to provide documents ? ReST Editor Compilation process Questions ? Known users Existing editorsA documentation language Designed for Python documentation (code and references) Defined at docutils.sourceforge.net by David Goodger Plain text mark-up language Thomas Calmant isandlaTech ReST Editor
  6. 6. A documentation language Sample code reStructuredText How to provide documents ? ReST Editor Compilation process Questions ? Known users Existing editorsA documentation language Designed for Python documentation (code and references) Defined at docutils.sourceforge.net by David Goodger Plain text mark-up language Easy to read / write without specific tools Thomas Calmant isandlaTech ReST Editor
  7. 7. A documentation language Sample code reStructuredText How to provide documents ? ReST Editor Compilation process Questions ? Known users Existing editorsA documentation language Designed for Python documentation (code and references) Defined at docutils.sourceforge.net by David Goodger Plain text mark-up language Easy to read / write without specific tools Compilable into many output formats (HTML, LaTex, CHM, man, QtDoc, ...) Thomas Calmant isandlaTech ReST Editor
  8. 8. A documentation language Sample code reStructuredText How to provide documents ? ReST Editor Compilation process Questions ? Known users Existing editorsSample code How to provide documents ? ========================== With |rest| : .. image:: _static/workflow-rst.png :align: center :height: 3cm * One source format * Can be an aggregation of multiple .rst files * Plain text, so complete version control can be done with Git, Subversion, ... Thomas Calmant isandlaTech ReST Editor
  9. 9. A documentation language Sample code reStructuredText How to provide documents ? ReST Editor Compilation process Questions ? Known users Existing editorsHow to provide documents ? The old way : Time wasting Thomas Calmant isandlaTech ReST Editor
  10. 10. A documentation language Sample code reStructuredText How to provide documents ? ReST Editor Compilation process Questions ? Known users Existing editorsHow to provide documents ? The old way : Time wasting Possible update errors Thomas Calmant isandlaTech ReST Editor
  11. 11. A documentation language Sample code reStructuredText How to provide documents ? ReST Editor Compilation process Questions ? Known users Existing editorsHow to provide documents ? The old way : Time wasting Possible update errors May need to have the document in different source formats Thomas Calmant isandlaTech ReST Editor
  12. 12. A documentation language Sample code reStructuredText How to provide documents ? ReST Editor Compilation process Questions ? Known users Existing editorsHow to provide documents ? The old way : Time wasting Possible update errors May need to have the document in different source formats Nearly impossible to have a correct version control Thomas Calmant isandlaTech ReST Editor
  13. 13. A documentation language Sample code reStructuredText How to provide documents ? ReST Editor Compilation process Questions ? Known users Existing editorsHow to provide documents ? With reStructuredText : One source format Thomas Calmant isandlaTech ReST Editor
  14. 14. A documentation language Sample code reStructuredText How to provide documents ? ReST Editor Compilation process Questions ? Known users Existing editorsHow to provide documents ? With reStructuredText : One source format Can be an aggregation of multiple .rst files Thomas Calmant isandlaTech ReST Editor
  15. 15. A documentation language Sample code reStructuredText How to provide documents ? ReST Editor Compilation process Questions ? Known users Existing editorsHow to provide documents ? With reStructuredText : One source format Can be an aggregation of multiple .rst files Plain text, so complete version control can be done with Git, Subversion, ... Thomas Calmant isandlaTech ReST Editor
  16. 16. A documentation language Sample code reStructuredText How to provide documents ? ReST Editor Compilation process Questions ? Known users Existing editorsHow to provide documents ? With reStructuredText : One source format Can be an aggregation of multiple .rst files Plain text, so complete version control can be done with Git, Subversion, ... Compiled with the same tool for major outputs : Sphinx Thomas Calmant isandlaTech ReST Editor
  17. 17. A documentation language Sample code reStructuredText How to provide documents ? ReST Editor Compilation process Questions ? Known users Existing editorsCompilation process Sphinx : generates major outputs (HTML, LaTex, man, QtDoc, ...) Thomas Calmant isandlaTech ReST Editor
  18. 18. A documentation language Sample code reStructuredText How to provide documents ? ReST Editor Compilation process Questions ? Known users Existing editorsCompilation process Sphinx : generates major outputs (HTML, LaTex, man, QtDoc, ...) Some other tools exist : Thomas Calmant isandlaTech ReST Editor
  19. 19. A documentation language Sample code reStructuredText How to provide documents ? ReST Editor Compilation process Questions ? Known users Existing editorsCompilation process Sphinx : generates major outputs (HTML, LaTex, man, QtDoc, ...) Some other tools exist : rst2pdf : generates PDF without LaTex (uses ReportLab library) Thomas Calmant isandlaTech ReST Editor
  20. 20. A documentation language Sample code reStructuredText How to provide documents ? ReST Editor Compilation process Questions ? Known users Existing editorsCompilation process Sphinx : generates major outputs (HTML, LaTex, man, QtDoc, ...) Some other tools exist : rst2pdf : generates PDF without LaTex (uses ReportLab library) rst2beamer : generates a LaTex Beamer presentation Thomas Calmant isandlaTech ReST Editor
  21. 21. A documentation language Sample code reStructuredText How to provide documents ? ReST Editor Compilation process Questions ? Known users Existing editorsCompilation process Sphinx : generates major outputs (HTML, LaTex, man, QtDoc, ...) Some other tools exist : rst2pdf : generates PDF without LaTex (uses ReportLab library) rst2beamer : generates a LaTex Beamer presentation rst2odt : generates Open/LibreOffice documents Thomas Calmant isandlaTech ReST Editor
  22. 22. A documentation language Sample code reStructuredText How to provide documents ? ReST Editor Compilation process Questions ? Known users Existing editorsCompilation process Sphinx : generates major outputs (HTML, LaTex, man, QtDoc, ...) Some other tools exist : rst2pdf : generates PDF without LaTex (uses ReportLab library) rst2beamer : generates a LaTex Beamer presentation rst2odt : generates Open/LibreOffice documents rst2a : an on-line styled PDF generator Thomas Calmant isandlaTech ReST Editor
  23. 23. A documentation language Sample code reStructuredText How to provide documents ? ReST Editor Compilation process Questions ? Known users Existing editorsCompilation process Sphinx : generates major outputs (HTML, LaTex, man, QtDoc, ...) Some other tools exist : rst2pdf : generates PDF without LaTex (uses ReportLab library) rst2beamer : generates a LaTex Beamer presentation rst2odt : generates Open/LibreOffice documents rst2a : an on-line styled PDF generator All are based on Python, using the official docutils parser. Thomas Calmant isandlaTech ReST Editor
  24. 24. A documentation language Sample code reStructuredText How to provide documents ? ReST Editor Compilation process Questions ? Known users Existing editorsKnown users Guides & References Thomas Calmant isandlaTech ReST Editor
  25. 25. A documentation language Sample code reStructuredText How to provide documents ? ReST Editor Compilation process Questions ? Known users Existing editorsKnown users Guides & References Python Thomas Calmant isandlaTech ReST Editor
  26. 26. A documentation language Sample code reStructuredText How to provide documents ? ReST Editor Compilation process Questions ? Known users Existing editorsKnown users Guides & References Python Bazaar Thomas Calmant isandlaTech ReST Editor
  27. 27. A documentation language Sample code reStructuredText How to provide documents ? ReST Editor Compilation process Questions ? Known users Existing editorsKnown users Guides & References Python Bazaar Blender Thomas Calmant isandlaTech ReST Editor
  28. 28. A documentation language Sample code reStructuredText How to provide documents ? ReST Editor Compilation process Questions ? Known users Existing editorsKnown users Guides & References Python Bazaar Blender OpenERP Thomas Calmant isandlaTech ReST Editor
  29. 29. A documentation language Sample code reStructuredText How to provide documents ? ReST Editor Compilation process Questions ? Known users Existing editorsKnown users Guides & References Python Bazaar Blender OpenERP Zope Thomas Calmant isandlaTech ReST Editor
  30. 30. A documentation language Sample code reStructuredText How to provide documents ? ReST Editor Compilation process Questions ? Known users Existing editorsKnown users Guides & References Python Bazaar Blender OpenERP Zope Many others Python and non-Python projects Thomas Calmant isandlaTech ReST Editor
  31. 31. A documentation language Sample code reStructuredText How to provide documents ? ReST Editor Compilation process Questions ? Known users Existing editorsKnown users Guides & References Python Bazaar Blender OpenERP Zope Many others Python and non-Python projects Books Thomas Calmant isandlaTech ReST Editor
  32. 32. A documentation language Sample code reStructuredText How to provide documents ? ReST Editor Compilation process Questions ? Known users Existing editorsKnown users Guides & References Python Bazaar Blender OpenERP Zope Many others Python and non-Python projects Books C/C++ Software Development with Eclipse (on-line book) Thomas Calmant isandlaTech ReST Editor
  33. 33. A documentation language Sample code reStructuredText How to provide documents ? ReST Editor Compilation process Questions ? Known users Existing editorsKnown users Guides & References Python Bazaar Blender OpenERP Zope Many others Python and non-Python projects Books C/C++ Software Development with Eclipse (on-line book) The repoze.bfg Web Application Framework (printed book) Thomas Calmant isandlaTech ReST Editor
  34. 34. A documentation language Sample code reStructuredText How to provide documents ? ReST Editor Compilation process Questions ? Known users Existing editorsExisting editors Few editors with a real support (vim, emacs, JED, ...) Thomas Calmant isandlaTech ReST Editor
  35. 35. A documentation language Sample code reStructuredText How to provide documents ? ReST Editor Compilation process Questions ? Known users Existing editorsExisting editors Few editors with a real support (vim, emacs, JED, ...) Often with only a syntax coloration support Thomas Calmant isandlaTech ReST Editor
  36. 36. Outline 1 reStructuredText A documentation language Sample code How to provide documents ? Compilation process Known users Existing editors 2 ReST Editor reStructuredText edition in Eclipse Open source plug-in The Run configuration A word about wrapping
  37. 37. reStructuredText edition in Eclipse reStructuredText Open source plug-in ReST Editor The Run configuration Questions ? A word about wrappingreStructuredText edition in Eclipse Syntax coloration Thomas Calmant isandlaTech ReST Editor
  38. 38. reStructuredText edition in Eclipse reStructuredText Open source plug-in ReST Editor The Run configuration Questions ? A word about wrappingreStructuredText edition in Eclipse Syntax coloration Document hierarchy edition using the Outline view Thomas Calmant isandlaTech ReST Editor
  39. 39. reStructuredText edition in Eclipse reStructuredText Open source plug-in ReST Editor The Run configuration Questions ? A word about wrappingreStructuredText edition in Eclipse Syntax coloration Document hierarchy edition using the Outline view Directives help on mouse hover Thomas Calmant isandlaTech ReST Editor
  40. 40. reStructuredText edition in Eclipse reStructuredText Open source plug-in ReST Editor The Run configuration Questions ? A word about wrappingreStructuredText edition in Eclipse Syntax coloration Document hierarchy edition using the Outline view Directives help on mouse hover Basic context assistance Thomas Calmant isandlaTech ReST Editor
  41. 41. reStructuredText edition in Eclipse reStructuredText Open source plug-in ReST Editor The Run configuration Questions ? A word about wrappingreStructuredText edition in Eclipse Syntax coloration Document hierarchy edition using the Outline view Directives help on mouse hover Basic context assistance A Sphinx/Makefile run configuration Thomas Calmant isandlaTech ReST Editor
  42. 42. reStructuredText edition in Eclipse reStructuredText Open source plug-in ReST Editor The Run configuration Questions ? A word about wrappingreStructuredText edition in Eclipse Syntax coloration Document hierarchy edition using the Outline view Directives help on mouse hover Basic context assistance A Sphinx/Makefile run configuration Spell checking with Hunspell4Eclipse Thomas Calmant isandlaTech ReST Editor
  43. 43. reStructuredText edition in Eclipse reStructuredText Open source plug-in ReST Editor The Run configuration Questions ? A word about wrappingOpen source plug-in Open source plug-in, hosted at SourceForge.net. Thomas Calmant isandlaTech ReST Editor
  44. 44. reStructuredText edition in Eclipse reStructuredText Open source plug-in ReST Editor The Run configuration Questions ? A word about wrappingOpen source plug-in Open source plug-in, hosted at SourceForge.net. Project site : resteditor.sourceforge.net Thomas Calmant isandlaTech ReST Editor
  45. 45. reStructuredText edition in Eclipse reStructuredText Open source plug-in ReST Editor The Run configuration Questions ? A word about wrappingOpen source plug-in Open source plug-in, hosted at SourceForge.net. Project site : resteditor.sourceforge.net Update site : resteditor.sourceforge.net/eclipse Thomas Calmant isandlaTech ReST Editor
  46. 46. reStructuredText edition in Eclipse reStructuredText Open source plug-in ReST Editor The Run configuration Questions ? A word about wrappingOpen source plug-in Open source plug-in, hosted at SourceForge.net. Project site : resteditor.sourceforge.net Update site : resteditor.sourceforge.net/eclipse Available on the Marketplace Thomas Calmant isandlaTech ReST Editor
  47. 47. reStructuredText edition in Eclipse reStructuredText Open source plug-in ReST Editor The Run configuration Questions ? A word about wrappingOpen source plug-in Open source plug-in, hosted at SourceForge.net. Project site : resteditor.sourceforge.net Update site : resteditor.sourceforge.net/eclipse Available on the Marketplace Contributors are welcome ! Thomas Calmant isandlaTech ReST Editor
  48. 48. reStructuredText edition in Eclipse reStructuredText Open source plug-in ReST Editor The Run configuration Questions ? A word about wrappingThe Run configuration Needs Python and Sphinx to be installed on the system Thomas Calmant isandlaTech ReST Editor
  49. 49. reStructuredText edition in Eclipse reStructuredText Open source plug-in ReST Editor The Run configuration Questions ? A word about wrappingThe Run configuration Needs Python and Sphinx to be installed on the system Works on Unix-like (Makefile) and Windows (make.bat) Thomas Calmant isandlaTech ReST Editor
  50. 50. reStructuredText edition in Eclipse reStructuredText Open source plug-in ReST Editor The Run configuration Questions ? A word about wrappingThe Run configuration Needs Python and Sphinx to be installed on the system Works on Unix-like (Makefile) and Windows (make.bat) Allows to run any Makefile Thomas Calmant isandlaTech ReST Editor
  51. 51. reStructuredText edition in Eclipse reStructuredText Open source plug-in ReST Editor The Run configuration Questions ? A word about wrappingThe Run configuration Needs Python and Sphinx to be installed on the system Works on Unix-like (Makefile) and Windows (make.bat) Allows to run any Makefile Allows to provide an environment to the command Thomas Calmant isandlaTech ReST Editor
  52. 52. reStructuredText edition in Eclipse reStructuredText Open source plug-in ReST Editor The Run configuration Questions ? A word about wrappingA word about wrapping No line wrapping support in built-in TextEditor Thomas Calmant isandlaTech ReST Editor
  53. 53. reStructuredText edition in Eclipse reStructuredText Open source plug-in ReST Editor The Run configuration Questions ? A word about wrappingA word about wrapping No line wrapping support in built-in TextEditor ReST Editor hard line wrapping inspired from Texlipse method Thomas Calmant isandlaTech ReST Editor
  54. 54. reStructuredText edition in Eclipse reStructuredText Open source plug-in ReST Editor The Run configuration Questions ? A word about wrappingA word about wrapping No line wrapping support in built-in TextEditor ReST Editor hard line wrapping inspired from Texlipse method Modifies the document with an auto-edit strategy Thomas Calmant isandlaTech ReST Editor
  55. 55. reStructuredText edition in Eclipse reStructuredText Open source plug-in ReST Editor The Run configuration Questions ? A word about wrappingA word about wrapping No line wrapping support in built-in TextEditor ReST Editor hard line wrapping inspired from Texlipse method Modifies the document with an auto-edit strategy Detects blocks of similar lines, then wrap and replace the whole block Thomas Calmant isandlaTech ReST Editor
  56. 56. reStructuredText edition in Eclipse reStructuredText Open source plug-in ReST Editor The Run configuration Questions ? A word about wrappingA word about wrapping No line wrapping support in built-in TextEditor ReST Editor hard line wrapping inspired from Texlipse method Modifies the document with an auto-edit strategy Detects blocks of similar lines, then wrap and replace the whole block Soft line wrapping support : Thomas Calmant isandlaTech ReST Editor
  57. 57. reStructuredText edition in Eclipse reStructuredText Open source plug-in ReST Editor The Run configuration Questions ? A word about wrappingA word about wrapping No line wrapping support in built-in TextEditor ReST Editor hard line wrapping inspired from Texlipse method Modifies the document with an auto-edit strategy Detects blocks of similar lines, then wrap and replace the whole block Soft line wrapping support : Uses the hard line wrapping, but storing information about wrapped blocks Thomas Calmant isandlaTech ReST Editor
  58. 58. reStructuredText edition in Eclipse reStructuredText Open source plug-in ReST Editor The Run configuration Questions ? A word about wrappingA word about wrapping No line wrapping support in built-in TextEditor ReST Editor hard line wrapping inspired from Texlipse method Modifies the document with an auto-edit strategy Detects blocks of similar lines, then wrap and replace the whole block Soft line wrapping support : Uses the hard line wrapping, but storing information about wrapped blocks Un-wraps blocks on save Thomas Calmant isandlaTech ReST Editor
  59. 59. reStructuredText edition in Eclipse reStructuredText Open source plug-in ReST Editor The Run configuration Questions ? A word about wrappingA word about wrapping No line wrapping support in built-in TextEditor ReST Editor hard line wrapping inspired from Texlipse method Modifies the document with an auto-edit strategy Detects blocks of similar lines, then wrap and replace the whole block Soft line wrapping support : Uses the hard line wrapping, but storing information about wrapped blocks Un-wraps blocks on save Problem : implied modifications on save always set the document state to dirty Thomas Calmant isandlaTech ReST Editor
  60. 60. reStructuredText ReST Editor Questions ?Questions ? Any question ? Thomas Calmant isandlaTech ReST Editor

×