4 Star 11 Fork 3

Applied Navigation Algorithms / Open Navigation Toolbox

加入 Gitee
与超过 1200万 开发者一起发现、参与优秀开源项目,私有仓库也完全免费 :)
免费加入
克隆/下载
makehelp.m 2.29 KB
一键复制 编辑 原始数据 按行查看 历史
organ820 提交于 2022-01-09 17:21 . 将.m文件转码为UTF-8,内容未变
function [] = makehelp()
%MAKEHELP 制作帮助文档
%% 切换至工具箱根目录
tbkRootFolder = getdirandfilenamefrompath(mfilename('fullpath'));
oldFolder = cd(tbkRootFolder);
%% 删除html\autogen目录中原有文件
if isdir([tbkRootFolder filesep 'html' filesep 'autogen'])
rmdir([tbkRootFolder filesep 'html' filesep 'autogen'], 's');
end
%% 调用M2HTML工具箱(http://www.artefact.tk/software/matlab/m2html/)生成函数参考页
% NOTE: 使用的M2HTML工具箱版本为1.5 01-May-2005,包含142个文件,总大小425169(未修改状态)
% NOTE: 将M2HTML工具箱根目录(m2html)放到本工具箱根目录下,然后添加到路径
% NOTE: 需要将m2html\templates\blue\*.tpl中的“iso-8859-1”替换为“GBK”,否则参考页中文显示乱码
m2html('mfiles', {'inertial' 'radio' 'util'}, 'htmldir', ['html' filesep 'autogen'], ...
'recursive', 'on', 'source', 'off', 'globalHypertextLinks', 'on', ...
'todo', 'on', 'template', 'blue', 'ignoredDir', {'private' 'vld'}, 'save', 'on', ... % TODO: save改为off
'helptocxml', 'on', 'language', 'chinese'); % NOTE: 本行为在m2html帮助中未说明的选项
%% 生成帮助目录
% 读入手工编辑的目录
templDoc = xmlread([tbkRootFolder filesep 'helptoc_noautogen.xml']);
templTocItems = templDoc.getElementsByTagName('tocitem');
templTopTocItem = templTocItems.item(0);
% 读入自动生成的目录(函数参考部分)
fcnDoc = xmlread([tbkRootFolder filesep 'html' filesep 'autogen' filesep 'helptoc.xml']);
fcnTocItems = fcnDoc.getElementsByTagName('tocitem');
fcnTopTocItem = fcnTocItems.item(0);
% 将自动生成的目录合并入手工编辑目录
fcnTopTocItemCopy = templDoc.importNode(fcnTopTocItem, true);
fcnTopTocItemCopy.getFirstChild.setData('Function Reference');
fcnTopTocItemCopy.setAttribute('image', 'HelpIcon.FUNCTION');
templTopTocItem.appendChild(fcnTopTocItemCopy);
% 写目录文件
xmlwrite([tbkRootFolder filesep 'html' filesep 'helptoc.xml'], templDoc);
% 删除自动生成的helptoc.xml
delete([tbkRootFolder filesep 'html' filesep 'autogen' filesep 'helptoc.xml']);
%% 生成文档搜索数据库
try
builddocsearchdb([tbkRootFolder filesep 'html']); % TODO: 无法搜索中文
catch ME
warning(ME.identifier, '%s', ME.message);
end
%% 切换至原目录
cd(oldFolder);
end
Matlab
1
https://gitee.com/app-nav-alg/open-navigation-toolbox.git
git@gitee.com:app-nav-alg/open-navigation-toolbox.git
app-nav-alg
open-navigation-toolbox
Open Navigation Toolbox
master

搜索帮助