使用xml文件生成在线帮助文档

目前,很多系统或工具都会提供相应的在线帮助文档,在线帮助文档包括对各个功能的操作步骤演示、功能说明等。为了能实时对帮助文档进行修改,有些系统提供在线编辑功能,该功能固然好,但实现相比直接采用xml文档存储要复杂。

以下是我采用xml文档实现在线帮助文档的过程:

  • 第一步:定义所需要展示的xml文档结构。
帮助文档一般包括文字描述和图片展示。xml文档以功能为主体,每个功能可以有多段文字描述,每段文字可以附件多幅图片。定义的xml文档结构如下:
<?xml version="1.0" encoding="UTF-8"?>
<content>
<function method="功能">
<h title="功能描述">
<p info="通过该功能可以实现xxx操作,其中需要注意xxx。">
<img>app/3.png</img>
</p>
</h>
<h title="操作步骤">
<p info="第一步,如何操作。">
<img >app/4.png</img></p>
<p info="第二步,在xxx中找到xxx,确定xxx。">
<img >app/5.png</img>
<img>app/6.png</img>
</p>
<p info="第三步,选择'xxx',点击xxx。">
<img>app/7.png</img>
</p>
<p info="第四步,xxxx。">
<img>app/8.png</img>
</p>
<p info="第五步,xxxx。">
<img>app/9.png</img>
</p>
<p info="第六步,xxxx。">
<img>app/10.png</img>
<img>app/11.png</img>
</p>
<p info="最后,退出查看结果。">
<img>app/12.png</img>
</p>
</h>
</function>
</content>
  • 第二步:xml文档读取
xml文档读取之前,需要定义文档存储结构,通过分析以上文档结构可以得到如下结论。一个xml文件中包含多个function,即List<function>。每个function包含多个标题,即List<h>。每个h包含多个p,即List<p>,最后就是每个p包含多个img。如此得到整个xml文档数据结构。
根据结构编写代码如下:
/*
	 * 获取xml文件内容
	 * */
	public List<Func
  • 0
    点赞
  • 1
    收藏
    觉得还不错? 一键收藏
  • 1
    评论
评论 1
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值