Flare là một công cụ giúp tạo trực tuyến bởi Madcap phần mềm. Flare dự án web tạo ra trong XML và HTML, trong đó có thể được sửa trong bất kỳ văn bản thường hoặc trình soạn thảo HTML. Chúng tôi sẽ chi tiết làm thế nào để thêm, chỉnh sửa, và gỡ bỏ nội dung từ trang web dựa trên một cuốn sách chạy bằng cách sử dụng một trình soạn thảo văn bản.
Để bắt đầu, đó là một ý tưởng tốt để có một nắm trên cấu trúc cơ cấu sản lượng được tạo ra bởi Flare. Một Flare điển hình giúp sản lượng sẽ chứa một tệp HTML như là điểm bắt đầu của nó có tiêu đề ApplicationHelp.htm. Một ví dụ của một hệ thống giúp Flare là System100 giúp trực tuyến hiện có tại http://www.system100.com/demo/help/ApplicationHelp.htm (mà tôi cũng đã xảy ra với tác giả).
Các tập tin ApplicationHelp.htm, khi mở ở một trình duyệt web, sẽ mở các hệ thống giúp đỡ và kéo trong stylesheet cần thiết, các trang web, XML, vv Các tập tin ApplicationHelp.htm nằm trong thư mục phụ huynh cho hệ thống giúp đỡ. Ngoài các thư mục mẹ, ba thư mục con chính được tìm thấy bên trong các thư mục mẹ. Ba thư mục con là:
Chúng tôi sẽ bao gồm các thư mục con sau này và giúp bạn hiểu được tính hữu dụng của họ. Để bây giờ, chúng ta nên đề cập đến các tập tin hỗ trợ thêm rằng cũng có chứa trong thư mục mẹ, trong đó bao gồm:
- Default.js
- Default.mcwebhelp
- Default.xml
- Default_CSH.htm
- Default_Left.htm
Deafult.js
Tập tin này JavaScript chứa hướng dẫn liên quan đến điểm bắt đầu / chủ đề mặc định của hệ thống trợ giúp. Nó cũng chứa các ghi chú (đã được nhận xét trên trong mã của tập tin này) liên quan đến các ID, da Tên, Truy vấn Tìm kiếm và đầu Pick của sách chạy.
Chú ý: Nếu bạn đổi tên mặc định / khởi điểm của hệ thống trợ giúp, bạn phải sửa đổi một khoản mục trong Default.js tập tin để phù hợp với tên mới. Dòng cụ thể trong các câu hỏi trong file Default.js là đường số 54, trong đó hiển thị như:
var gHelpSystemName = "default.htm";
Vì vậy nếu bạn đã được đổi tên mặc định điểm khởi đầu của một hệ thống giúp đỡ từ default.htm để index.htm, bạn sẽ cần phải chỉnh sửa số dòng 54 của Default.js để đọc như sau:
var gHelpSystemName = "index.htm";
Lưu các thay đổi của bạn vào tập tin Default.js.
Default.mcwebhelp
Đây là một WebHelp Madcap tập tin mà không cần phải chỉnh sửa.
Default.xml
Tệp tin XML này chứa hướng dẫn để cài đặt các chủ đề / mặc định bất cứ khi nào bắt đầu chạy là cuốn sách đầu tiên ra mắt. Nó cũng xác định vị trí và tên file cho Mục lục, Index, khái niệm, Thuật ngữ, tìm kiếm Cơ sở dữ liệu, Alias, Synonyms, và da.
Default_CSH.htm
Tệp HTML có chứa các cài đặt mà không cần phải chỉnh sửa.
Default_Left.htm
Đây tệp HTML có chứa mã cho TOC xuất hiện ở phía bên trái của hệ thống trợ giúp trực tuyến và được sử dụng để di chuyển từ chủ đề chủ đề bằng cách nhấn vào danh sách cá nhân TOC.
Bây giờ mà chúng tôi đã giới thiệu các tập tin khác nhau trong thư mục mẹ, hãy chuyển sự chú ý của chúng tôi để ba thư mục con được đề cập trước đó:
Nội dung Dữ liệu Da Nội dung thư mục
Nội dung thư mục chứa các tập tin HTML của mỗi cá nhân về các chủ đề của hệ thống trợ giúp. Ngoài các tập tin HTML, các thư mục nội dung có chứa nguyên (Hình ảnh và Stylesheets), SkinSupport (có thể chỉnh sửa các tập tin JavaScript mà hỗ trợ giúp hệ thống da, và một tập tin Bảng thuật ngữ.
Thư mục dữ liệu
Các thư mục dữ liệu chứa các tập tin liên quan đến dữ liệu trong hệ thống giúp đỡ. Dữ liệu này được sử dụng để xây dựng và hiển thị các trợ giúp trong một thời trang sử dụng được. Một trong những tập tin nằm trong thư mục dữ liệu đó có tầm quan trọng là tập Toc.xml. Bạn có thể thay đổi TOC (Mục lục) của một hệ thống trợ giúp bằng cách thay đổi tập tin Toc.xml. Chúng tôi sẽ bao gồm phiên bản cho TOC trong các chủ đề sau đó.
Da Folder
Các thư mục chứa các tập tin da được sử dụng cho da của hệ thống trợ giúp. Da Một định nghĩa các màu sắc, phông chữ, và hình ảnh liên quan đến việc trình bày của các hệ thống giúp đỡ. Ngoài các thư da, có da có liên quan tập tin chứa trong các dữ liệu và Nội dung thư mục.