对于格式化语言(HTML,MarkDown,reStructuredText,PlantUML等),如果能实时看到其显示效果,则能提高工作效率,避免出错。
所见即所得:What you see is what you get。
1. Review reStructuredText
reStructuredText是Sphinx的文本格式。有一个在线的编辑器,访问速度很快:http://rst.ninjs.org/
2. Review plantUML
plantUML是用文本来描述UML图。使用Chrome插件,便可浏览plantUML对应的图。
2.1 安装”PlantUML Viewer”
搜索”PlantUML Viewer”,点击安装。
2.2 允许PlantUML viewer访问文件网址
2.3 文件以@startuml开头
定义一个sample1.plantuml文件。
@startuml Bob -> Alice : Hello, how are you Alice -> Bob : Fine, thank you, and you?
2.4 浏览器中访问该文件
3. reStructuredText中嵌入plantUML
=========== Chapter 1 =========== Draw a diagram. .. uml:: uml/sample1.plantUML
这段文本,没法解析。因为含有plantUML,所以添加个转义符(”\”),不解析plantUML.
\.. uml:: uml/sample1.plantUML
plantUML是一个单独文件,所以单独测试。如果都没有问题,再去掉转义符”\”,用Sphinx生成完整的文档。