builddocsearchdb

검색 가능한 문서 데이터베이스 작성

구문

builddocsearchdb(folder)

설명

builddocsearchdb(folder)는 HTML 파일을 기반으로, 지정된 폴더에 검색 가능한 데이터베이스(검색 색인이라고도 함)를 작성합니다.

builddocsearchdb 함수는 데이터베이스 파일을 포함시킬 하위 폴더 helpsearch-v3을 만듭니다. MATLAB^® 버전이 데이터베이스를 만드는 데 사용된 것과 동일한 버전으로 간주하는 경우, MATLAB에서 이 데이터베이스로 HTML 파일에 있는 내용을 검색할 수 있습니다.

MATLAB R2014b부터는 검색 인덱스를 나란히 유지할 수 있습니다. 예를 들어, MATLAB R2014a 이하 버전에 대한 검색 색인이 이미 있는 경우에도 MATLAB R2014b 이상 버전을 사용하여 도움말 파일에 대해 builddocsearchdb를 실행할 수 있습니다. 그런 다음, 아무 MATLAB 릴리스나 실행하면 도움말 브라우저가 문서 데이터베이스를 검색하는 데 적합한 인덱스를 자동으로 사용합니다.

예제

모두 축소

사용자 지정 도움말 파일 검색

사용자 지정 도움말 파일의 검색 데이터베이스를 작성합니다.

MATLAB에는 사용자 지정 툴박스와 지원 문서를 만드는 방법을 보여주는 일련의 샘플 파일이 포함되어 있습니다. 이 샘플 툴박스를 Upslope Area Toolbox라고 합니다. upslope 폴더에는 사용자 지정 문서를 표시하는 데 필요한 info.xml이라는 파일과, HTML 문서 및 지원 파일이 들어 있는 html이라는 하위 폴더가 들어 있습니다.

이 샘플 파일들을 임시 폴더에 복사하고 복사된 파일을 경로에 추가합니다.

sample = fullfile(...
         matlabroot,'help','techdoc','matlab_env',...
         'examples','upslope');
tmp = tempname;
mkdir(tmp);
copyfile(sample,tmp);
addpath(tmp);

검색 데이터베이스를 만듭니다.

folder = fullfile(tmp,'html');
builddocsearchdb(folder)

도움말 브라우저를 열고 tarboton이라는 단어를 검색합니다. 이 단어는 여러 도움말 파일에 들어 있습니다. MathWorks^® 문서에서 검색 결과가 반환됩니다.

페이지 왼쪽의 출처별 상세 검색 아래에서 추가 소프트웨어를 선택하여 Upslope Area Toolbox에 대한 결과를 확인합니다.

임시 예제 파일을 제거합니다.

rmpath(tmp)
rmdir(tmp,'s')

입력 인수

모두 축소

`folder` — HTML 파일이 있는 폴더의 전체 경로
문자형 벡터

HTML 파일이 있는 폴더의 전체 경로로, 문자형 벡터로 지정됩니다. 폴더는 다음 위치에 있어야 합니다.

MATLAB 검색 경로 내
matlabroot 폴더 외부
설치된 하드웨어 지원 패키지 도움말 폴더 외부

builddocsearchdb 함수를 사용할 때 검색 데이터베이스에 특정 HTML 문서를 포함시키려면 다음 조건이 요구됩니다.

문서에 제목이 있어야 합니다.
내용이 제목과 달라야 합니다.

예: builddocsearchdb('c:\myfiles\html')

버전 내역

R2007a에 개발됨

참고 항목

doc | help

도움말 항목

사용자 지정 문서 표시하기