HTML 도움말로 대체

우리는 현재 간단한 텍스트 마크 업으로 문서를 만들 수있는 AsciiDoc 이라는 시스템을 사용하고 있습니다 . 이를 통해 여러 출력 형식을 생성 할 수 있습니다. pdf 출력 및 chm 출력 형식 만 사용합니다.

chm의 대안이 있는지 궁금합니다. 내가 찾고있는 것은 소프트웨어로 오프라인에서 사용할 수있는 것입니다 (우리의 사용자 중 상당수가 매우 먼 곳에 있기 때문에 중요합니다). 색인이 있어야하며 (하이퍼 링크 된 용어가있는 html 페이지만큼 간단 할 수 있음) 검색 가능해야하며 코드에서 특정 항목을 호출 할 수있는 메커니즘이 있어야합니다 (상황에 맞는 도움말과 유사 함).

이 경우 PDF와 반대되는 두 가지 사항은 다음과 같습니다.

1. 상황에 맞는 도움말은 옵션이 아닙니다
2. 일반적으로 문서는 다소 큽니다
3. 상황에 맞는 도움말보다 PDF가 인쇄 된 문서에 더 적합합니다

내가 원하는 것은 html을 사용하는 것입니다. html의 유일한 문제는 자동으로 키워드 검색을 제공하는 방법을 알 수 없다는 것입니다 (브라우저 ctrl + f 기능 이외의 것-더 분명한 것을 원합니다). 또한 하이퍼 링크로 연결된 키워드 색인을 자동으로 생성하는 방법을 찾지 못하는 것 같습니다. 섹션 태그로 인해 상황에 맞는 도움말이 간단합니다. 기본 브라우저에 관심이있는 페이지 및 섹션의 URL을 전달하면 해당 페이지가 올바른 섹션으로로드됩니다.

내 요구 사항은 chm처럼 끔찍하게 들립니다. chm에서 내 요구 사항을 모델링했습니다. 내가 chm을 싫어하는 유일한 이유는 코드가 mapid 등을 사용하여 코드와 상호 작용하는 방식 때문입니다. 내 코드가 문서의 상황에 민감한 부분에 액세스하는 데 사용할 수있는 일반 텍스트 목록 (자동으로 생성됨)을 저장하는 것이 좋습니다.

html 출력 파일을 통과하고 찾은 키워드 목록을 포함하는 색인 ​​페이지를 생성하는 스크립트를 구상하고 있습니다. 분명히 다음과 같은 단어를 무시할 수있는 단어 배제 메커니즘이 있어야합니다.이 부분은 상대적으로 쓰기 쉽습니다. 두 번째 부분은 키워드 데이터베이스와 html 텍스트 내에서의 위치를 ​​모으기 위해 일종의 스크립트가 필요합니다. 나는 이것이 브라우저 내에서 검색 메커니즘을 제공하는 것과 함께 까다로운 부분이라고 생각합니다.

대안에 대한 아이디어가 있으면 감사하겠습니다. 웹 서버에서 호스팅되는 위키 또는 정적 HTML 페이지 세트를 사용하고 싶지만 중요한 오프라인 사용 요구 사항이 있습니다. 단순히 html을 로컬 드라이브에 배치한다고해서 필요한 검색 요구 사항이 제공되지는 않습니다.

편집하다:

광산업에서 사용하는 소프트웨어를 디자인합니다. 많은 광산은 매우 멀리 떨어져 있으며 의미있는 방식으로 인터넷에 액세스 할 수 없습니다. pdf 또는 html 또는 chm에는 아무런 문제가 없습니다 (노후화는 제외). 올바른 위치에 pdf 파일을 표시 할 수 있으면 (예 : 상황에 맞는 도움말) 사용할 것입니다. 나는 거의 내 자신의 글을 쓰고 싶어한다. 기본적으로 휴대용 위키 일 것이다. 말하자면, 휴대용 위키를 제안한다면, 그러한 도구를 사용해 본 경험이없는 최종 사용자를 생각해야합니다. 간단하게 죽어야한다. 그것은 chm의 아름다움이었습니다. 작업하기가 쉽지 않지만 최종 사용자는 그것을 좋아합니다.

HTML이 아닌 DocBook XML 마크 업에서 도움말을 작성할 준비가되어있는 경우 DocBook은 WebHelp 생성을 지원합니다. http://wiki.docbook.org/WebHelp

WebHelp 설명서는 다음과 같은 출력 데모입니다. http://docbook.sourceforge.net/release/xsl/current/webhelp/docs/content/ch01.html

다음을 포함하는 웹 기반 HTML 도움말 형식을 제공합니다.

• 다음을 사용하여 전체 텍스트 검색 :
  • 영어, 프랑스어 및 독일어를 지원합니다. 형태소 분석기를 구현하여 다른 언어에 대한 형태소 지원을 추가 할 수 있습니다.
  • Lucene 검색 엔진의 코드를 사용하여 중국어, 일본어 및 한국어를 지원합니다.
  • 검색된 용어가 결과에서 나타나는 위치를 나타내는 검색 강조 표시.
  • 검색 결과에는 대상에 대한 간단한 설명이 포함될 수 있습니다.
• 접을 수있는 TOC 트리가있는 목차 창.
• 컨텐츠 분할 창과 TOC의 자동 동기화
• 프레임 세트를 사용하지 않고 TOC 및 검색 창을 구현했습니다.
• 출력을 생성하는 Ant build.xml 파일

RoboHelp의 제작자는 다른 것들로 넘어 갔으며 더 나은 대안을 만들기 위해 돌아 왔습니다. MadCap의 Flare를 확인하십시오 -다양한 출력 형식을 지원하고 색인을 생성하며 로컬로 (JavaScript를 통해) 작동하는 검색 기능을 제공합니다.

우리는 Adobe RoboHelp 를 사용하여 다양한 스타일의 오프라인 도움말 문서를 생성했습니다. 컨텐츠에 대한 많은 출력 및 통합 옵션을 제공합니다. 이 도구의 가장 큰 장점은 개발자가 아닌 사람에게 도구를 전달하고 적은 노력으로 솔루션에 통합 할 수있어 훌륭한 컨텐츠를 얻을 수 있다는 것입니다.

CHM 자체는 오래되었고 Microsoft는 다음과 같은 새로운 것들로 넘어갔습니다. http://msdn.microsoft.com/en-us/library/bb164608(v=vs.80).aspx

그러나 도움말을 기존 시스템으로 변환하지 않고 정적 도움말 파일에서 검색 및 키워드 조회를 제공하는 방법을 찾고 있다면 다음 두 가지 아이디어가 있습니다.

• 작은 localhost 전용 HTTP 서버를 프로젝트에 추가하여 문서와 함께 웹 사이트를 제공하십시오. 문제는이 HTTP 서버를 시작 / 중지하고 /하거나 계속 실행하는시기 또는 방법입니다. 대안은 사용자 정의 URL 체계를 구현하는 것이지만 이것은 하나의 브라우저에 연결되어 훨씬 더 많은 작업입니다 ( 그리고 말할 수 있습니다 )

• JavaScript 검색 엔진을 작성하십시오. 요즘 모든 브라우저의 JavaScript가 매우 빨라지고 성능이 향상되고 있습니다. 키워드 색인은 JSON에 쉽게 저장할 수 있으며 로컬 파일에서 정규 표현식을 실행하여 꽤 좋은 결과를 얻었습니다.

내가 찾고있는 것은 소프트웨어로 오프라인에서 사용할 수있는 것입니다 (우리의 사용자 중 상당수가 매우 먼 곳에 있기 때문에 중요합니다).

우리 회사에서 RoboHelp를 사용하고 있으며 네트워크에 액세스 할 수없는 영역에서 사용자가없는 영역으로 이동하는 사용자가 종종 있기 때문에 도움말 파일을 오프라인에서 사용할 수있게되기를 바랍니다.

검색 가능해야하며 특정 항목을 호출 할 수있는 메커니즘이 있어야합니다.

RoboHelp의 일부 페이지를 사용하여 화면에서 특정 필드의 사용을 설명합니다. 클릭 후 나타나는 해당 필드에 대한 팝업을 가질 수 있습니다. RoboHelp에는 매우 훌륭한 검색 기능과 자동 생성 색인이 있습니다. 나는 항상 행운을 빕니다. RoboHelp는 사용하기 쉬운 프로그램이므로 문서를 업데이트 할 수 있습니다.