Tornado帮助文档组织(zt)

2024-02-26 17:48
文章标签 文档 组织 帮助 zt tornado

本文主要是介绍Tornado帮助文档组织(zt),希望对大家解决编程问题提供一定的参考价值,需要的开发者们随着小编来一起学习吧!

帮助文档
在docs目录下存放各种帮助手册,主要是Tornado和VxWorks相关的,也有特殊组件相关的,如TrueFFS,WindView。帮助文档有html格式或pdf格式,建议使用html格式,方便交叉关联。

如果使用html格式的手册,book.html为手册总入口,进入能看见各种手册列表,选择就能进入相关手册。Docs根目录下还包含其他几个入口文件,如下表:
book.html                                                 手册总入口
Tornado_Reference.html                     分项描述各主机工具,如WindSh,elfToBin等
Tornado_API_Reference.html             描述Tornado&nbspAPI,一般用户不用,按结构层次分类
l    ibIndex.html                                            描述Tornado&nbspAPI,按库名分类,类似VxWorks的库参考
BSP_Reference.html                            一般与自己硬板不符,可以看看sysLib
VxWorks_Reference_Manual.html     VxWorks 库手册,以库名排序描述,开发者经常参考
rtnIndex.html                                           VxWorks 库手册,以函数名排序描述,开发者经常参考

在开发中遇到问题需要帮助时,应选择合适的文件入口进入,可以加快资料查询速度。比如我们想查一个已知名称函数的原型参数或归属库,可以选择rtnIndex.html进入,可以直接找到该函数,具体帮助文档在相应的库描述中。

WindRiver的帮助文档很多,且归类不是太清晰,有些文档是直接从源代码中提取的。所以阅读帮助时需要讲究一定的顺序和方法。对 于初学者可以先看 “Tornado 2.0 Getting Started Guide”,该手册在有些版本中没有,可以到网上找找。通过该手册,用户可以建立对Tornado开发环境的基本印象,熟悉基本工具的操作等。 该手册用VxSim进行例程讲解,不需要具体的硬件目标板,这对初学者也很方便。

接下来用户可以看看WindRiver的培训资料,Workshop系列,包括4部分。以PowerPoint讲稿形式,内容比较简洁,快速阅读后可以建立对Tornado和VxWorks更深层次理解。

如果你觉得对VxWorks这个RTOS的概念还比较模糊,或没有嵌入式系统开发的从业经验,可以阅读VxWorks编程指南,它对VxWorks基本概念作了全面的描述。若该手册和VxWorks的最新版本有不符的地方,应该以VxWorks的库参考手册为准。

如果你不知道如何Tornado的功能,或在使用中遇到问题,可以参考Tornado用户指南,它对Tornado的直接用户使用有很大的帮助。

当你阅读完上面的各手册后,基本概念已经建立,可以进行实际系统开发。在实际开发过程中,用户最常用的手册为VxWorks库参考手册,不用仔细通读该手 册,只在平时遇问题时查询用。VxWorks库参考手册中文档直接由代码中提取,与VxWorks实际库情况最为吻合。

当然你在开发中会遇到自己专用组件的使用,如TureFFS、WindView、dosFs2.0、VxDCOM、VxFusion等,它们有专门的手册帮助你如何使用。

在开发过程中查询文档与初学时阅读文档不同,不追求全面的概貌,只需要局部的细节。这时我们要善于利用各手册的index部分,直接查询自己关心的关键词,可以快速找到需要的资料。这也是为什么我推荐使用html格式帮助的原因。

在你已能熟练使用Tornado和VxWorks后,若想再深层次求索细节,源代码文件将是你最好的文档。不但可以帮助明白工作机制细节,也学到一些编程技巧和规范。

除了WindRiver提供的正式文档,还有很多参考资源。如WindSurf,邮件组,论坛,中文书籍等。具体索引可以参考本书后附录。

这篇关于Tornado帮助文档组织(zt)的文章就介绍到这儿,希望我们推荐的文章对编程师们有所帮助!



http://www.chinasem.cn/article/749653

相关文章

Android实现在线预览office文档的示例详解

《Android实现在线预览office文档的示例详解》在移动端展示在线Office文档(如Word、Excel、PPT)是一项常见需求,这篇文章为大家重点介绍了两种方案的实现方法,希望对大家有一定的... 目录一、项目概述二、相关技术知识三、实现思路3.1 方案一:WebView + Office Onl

Python实现word文档内容智能提取以及合成

《Python实现word文档内容智能提取以及合成》这篇文章主要为大家详细介绍了如何使用Python实现从10个左右的docx文档中抽取内容,再调整语言风格后生成新的文档,感兴趣的小伙伴可以了解一下... 目录核心思路技术路径实现步骤阶段一:准备工作阶段二:内容提取 (python 脚本)阶段三:语言风格调

使用Java将DOCX文档解析为Markdown文档的代码实现

《使用Java将DOCX文档解析为Markdown文档的代码实现》在现代文档处理中,Markdown(MD)因其简洁的语法和良好的可读性,逐渐成为开发者、技术写作者和内容创作者的首选格式,然而,许多文... 目录引言1. 工具和库介绍2. 安装依赖库3. 使用Apache POI解析DOCX文档4. 将解析

Java利用docx4j+Freemarker生成word文档

《Java利用docx4j+Freemarker生成word文档》这篇文章主要为大家详细介绍了Java如何利用docx4j+Freemarker生成word文档,文中的示例代码讲解详细,感兴趣的小伙伴... 目录技术方案maven依赖创建模板文件实现代码技术方案Java 1.8 + docx4j + Fr

使用C#代码在PDF文档中添加、删除和替换图片

《使用C#代码在PDF文档中添加、删除和替换图片》在当今数字化文档处理场景中,动态操作PDF文档中的图像已成为企业级应用开发的核心需求之一,本文将介绍如何在.NET平台使用C#代码在PDF文档中添加、... 目录引言用C#添加图片到PDF文档用C#删除PDF文档中的图片用C#替换PDF文档中的图片引言在当

详解C#如何提取PDF文档中的图片

《详解C#如何提取PDF文档中的图片》提取图片可以将这些图像资源进行单独保存,方便后续在不同的项目中使用,下面我们就来看看如何使用C#通过代码从PDF文档中提取图片吧... 当 PDF 文件中包含有价值的图片,如艺术画作、设计素材、报告图表等,提取图片可以将这些图像资源进行单独保存,方便后续在不同的项目中使

Python实现合并与拆分多个PDF文档中的指定页

《Python实现合并与拆分多个PDF文档中的指定页》这篇文章主要为大家详细介绍了如何使用Python实现将多个PDF文档中的指定页合并生成新的PDF以及拆分PDF,感兴趣的小伙伴可以参考一下... 安装所需要的库pip install PyPDF2 -i https://pypi.tuna.tsingh

Python批量调整Word文档中的字体、段落间距及格式

《Python批量调整Word文档中的字体、段落间距及格式》这篇文章主要为大家详细介绍了如何使用Python的docx库来批量处理Word文档,包括设置首行缩进、字体、字号、行间距、段落对齐方式等,需... 目录关键代码一级标题设置  正文设置完整代码运行结果最近关于批处理格式的问题我查了很多资料,但是都没

Python自动化Office文档处理全攻略

《Python自动化Office文档处理全攻略》在日常办公中,处理Word、Excel和PDF等Office文档是再常见不过的任务,手动操作这些文档不仅耗时耗力,还容易出错,幸运的是,Python提供... 目录一、自动化处理Word文档1. 安装python-docx库2. 读取Word文档内容3. 修改

使用Python快速实现链接转word文档

《使用Python快速实现链接转word文档》这篇文章主要为大家详细介绍了如何使用Python快速实现链接转word文档功能,文中的示例代码讲解详细,感兴趣的小伙伴可以跟随小编一起学习一下... 演示代码展示from newspaper import Articlefrom docx import