Initial import of the CDE 2.1.30 sources from the Open Group.

This commit is contained in:
Peter Howkins
2012-03-10 18:21:40 +00:00
commit 83b6996daa
18978 changed files with 3945623 additions and 0 deletions

View File

@@ -0,0 +1,105 @@
<!-- $XConsortium: BEntity.sgm /main/2 1996/12/17 05:37:44 cde-hit $ -->
<!ENTITY HRDC.Intro.fig.1 SYSTEM "./helpGuide/graphics/HelpMenu.tif" NDATA TIFF>
<!ENTITY HRDC.Intro.fig.2 SYSTEM "./helpGuide/graphics/GenHelp.tif" NDATA TIFF>
<!ENTITY HRDC.Intro.fig.3 SYSTEM "./helpGuide/graphics/HyperFmt.tif" NDATA TIFF>
<!ENTITY HRDC.Intro.fig.4 SYSTEM "./helpGuide/graphics/Topics.tif" NDATA TIFF>
<!ENTITY HRDC.Intro.fig.5 SYSTEM "./helpGuide/graphics/IndxSrch.tif" NDATA TIFF>
<!ENTITY HRDC.Intro.fig.6 SYSTEM "./helpGuide/graphics/IndexNum.tif" NDATA TIFF>
<!ENTITY HRDC.Intro.fig.7 SYSTEM "./helpGuide/graphics/PrintDlg.tif" NDATA TIFF>
<!ENTITY HRDC.Intro.fig.8 SYSTEM "./helpGuide/graphics/HelpOrg.tif" NDATA TIFF>
<!ENTITY HRDC.Intro.fig.9 SYSTEM "./helpGuide/graphics/HelpMgr.tif" NDATA TIFF>
<!ENTITY HRDC.OrgH.fig.1 SYSTEM "./helpGuide/graphics/HelpVol.tif" NDATA TIFF>
<!ENTITY HRDC.OrgH.fig.2 SYSTEM "./helpGuide/graphics/FMhelpfs.tif" NDATA TIFF>
<!ENTITY HRDC.OrgH.fig.3 SYSTEM "./helpGuide/graphics/BuildDir.tif" NDATA TIFF>
<!ENTITY HRDC.OrgH.fig.4 SYSTEM "./helpGuide/graphics/ExHTopic.tif" NDATA TIFF>
<!ENTITY HRDC.OrgH.fig.5 SYSTEM "./helpGuide/graphics/GrEntity.tif" NDATA TIFF>
<!ENTITY HRDC.WrTop.fig.1 SYSTEM "./helpGuide/graphics/ExBuList.tif" NDATA TIFF>
<!ENTITY HRDC.WrTop.fig.2 SYSTEM "./helpGuide/graphics/ExNuList.tif" NDATA TIFF>
<!ENTITY HRDC.WrTop.fig.3 SYSTEM "./helpGuide/graphics/ExLalst1.tif" NDATA TIFF>
<!ENTITY HRDC.WrTop.fig.4 SYSTEM "./helpGuide/graphics/ExLaLstH.tif" NDATA TIFF>
<!ENTITY HRDC.WrTop.fig.5 SYSTEM "./helpGuide/graphics/ExProced.tif" NDATA TIFF>
<!ENTITY HRDC.WrTop.fig.6 SYSTEM "./helpGuide/graphics/ExComput.tif" NDATA TIFF>
<!ENTITY HRDC.WrTop.fig.7 SYSTEM "./helpGuide/graphics/Icons.tif" NDATA TIFF>
<!ENTITY HRDC.WrTop.fig.8 SYSTEM "./helpGuide/graphics/ExTHyper.tif" NDATA TIFF>
<!ENTITY HRDC.WrTop.fig.9 SYSTEM "./helpGuide/graphics/ExInliGr.tif" NDATA TIFF>
<!ENTITY HRDC.WrTop.fig.10 SYSTEM "./helpGuide/graphics/ExWrapGr.tif" NDATA TIFF>
<!ENTITY HRDC.CrHV.fig.1 SYSTEM "./helpGuide/graphics/Process.tif" NDATA TIFF>
<!ENTITY HRDC.CrHV.fig.2 SYSTEM "./helpGuide/graphics/ViewVol.tif" NDATA TIFF>
<!ENTITY HRDC.CrHV.fig.3 SYSTEM "./helpGuide/graphics/FMCompil.tif" NDATA TIFF>
<!ENTITY HRDC.CrHV.fig.4 SYSTEM "./helpGuide/graphics/HelpMgr.tif" NDATA TIFF>
<!ENTITY HRDC.CrHV.fig.5 SYSTEM "./helpGuide/graphics/FPanel.tif" NDATA TIFF>
<!ENTITY HRDC.CrHV.fig.6 SYSTEM "./helpGuide/graphics/PrintDlg.tif" NDATA TIFF>
<!ENTITY HRDC.Ref.fig.1 SYSTEM "./helpGuide/graphics/ExAnnot.tif" NDATA TIFF>
<!ENTITY HRDC.Ref.fig.2 SYSTEM "./helpGuide/graphics/ExCautio.tif" NDATA TIFF>
<!ENTITY HRDC.Ref.fig.3 SYSTEM "./helpGuide/graphics/ExEx.tif" NDATA TIFF>
<!ENTITY HRDC.Ref.fig.4 SYSTEM "./helpGuide/graphics/ExListHd.tif" NDATA TIFF>
<!ENTITY HRDC.Ref.fig.5 SYSTEM "./helpGuide/graphics/ExNoteHd.tif" NDATA TIFF>
<!ENTITY HRDC.Ref.fig.6 SYSTEM "./helpGuide/graphics/ExKeycap.tif" NDATA TIFF>
<!ENTITY HRDC.Ref.fig.7 SYSTEM "./helpGuide/graphics/ExLalstW.tif" NDATA TIFF>
<!ENTITY HRDC.Ref.fig.8 SYSTEM "./helpGuide/graphics/ExLaNowr.tif" NDATA TIFF>
<!ENTITY HRDC.Ref.fig.9 SYSTEM "./helpGuide/graphics/ExInliGr.tif" NDATA TIFF>
<!ENTITY HRDC.Ref.fig.10 SYSTEM "./helpGuide/graphics/ExLists.tif" NDATA TIFF>
<!ENTITY HRDC.Ref.fig.11 SYSTEM "./helpGuide/graphics/ExOthrHd.tif" NDATA TIFF>
<!ENTITY HRDC.Ref.fig.12 SYSTEM "./helpGuide/graphics/ExPHead.tif" NDATA TIFF>
<!ENTITY HRDC.Ref.fig.13 SYSTEM "./helpGuide/graphics/ExProc2.tif" NDATA TIFF>
<!ENTITY HRDC.Ref.fig.14 SYSTEM "./helpGuide/graphics/ExVex.tif" NDATA TIFF>
<!ENTITY HRDC.Ref.fig.15 SYSTEM "./helpGuide/graphics/ExXref.tif" NDATA TIFF>
<!ENTITY HRDC.ChEnt.fig.1 SYSTEM "./helpGuide/graphics/CharEntV.tif" NDATA TIFF>
<!ENTITY HRDC.ChEnt.fig.2 SYSTEM "./helpGuide/graphics/CharEntU.tif" NDATA TIFF>
<!ENTITY HRDC.CrDia.fig.1 SYSTEM "./helpGuide/graphics/GHelpLB.tif" NDATA TIFF>
<!ENTITY HRDC.CrDia.fig.2 SYSTEM "./helpGuide/graphics/QuickHlp.tif" NDATA TIFF>
<!ENTITY HRDC.Inst.fig.1 SYSTEM "./helpGuide/graphics/Approot.tif" NDATA TIFF>
<!ENTITY HRDC.Inst.fig.2 SYSTEM "./helpGuide/graphics/BldInst.tif" NDATA TIFF>
<!ENTITY HRDC.Lang.fig.1 SYSTEM "./helpGuide/graphics/FmtTable.tif" NDATA TIFF>

View File

@@ -0,0 +1,3 @@
/* $XConsortium: Title.tmpl /main/2 1996/06/19 16:03:46 drk $ */
/* TOC title, only what's between quotes should be modified. */
title = "共通デスクトップ環境 ヘルプ・システム設計者およびプログラマのためのガイド"

View File

@@ -0,0 +1,188 @@
<!DOCTYPE Book PUBLIC "-//HaL and O'Reilly//DTD DocBook V2.2.1//EN" [
<!ENTITY HRDC.Intro.fig.1 SYSTEM "./helpGuide/graphics/H_HelpMenu.eps" NDATA eps>
<!ENTITY HRDC.Intro.fig.2 SYSTEM "./helpGuide/graphics/H_GeneralHelp.eps" NDATA eps>
<!ENTITY HRDC.Intro.fig.3 SYSTEM "./helpGuide/graphics/H_HyperFormats.eps" NDATA eps>
<!ENTITY HRDC.Intro.fig.4 SYSTEM "./helpGuide/graphics/H_Topics.eps" NDATA eps>
<!ENTITY HRDC.Intro.fig.5 SYSTEM "./helpGuide/graphics/H_IndexSearch.eps" NDATA eps>
<!ENTITY HRDC.Intro.fig.6 SYSTEM "./helpGuide/graphics/H_IndexNum.eps" NDATA eps>
<!ENTITY HRDC.Intro.fig.7 SYSTEM "./helpGuide/graphics/H_PrintDialog.eps" NDATA eps>
<!ENTITY HRDC.Intro.fig.8 SYSTEM "./helpGuide/graphics/H_HelpOrg.eps" NDATA eps>
<!ENTITY HRDC.Intro.fig.9 SYSTEM "./helpGuide/graphics/H_HelpManager.eps" NDATA eps>
<!ENTITY HRDC.OrgH.fig.1 SYSTEM "./helpGuide/graphics/H_HelpVolume.eps" NDATA eps>
<!ENTITY HRDC.OrgH.fig.2 SYSTEM "./helpGuide/graphics/H_FMhelpfiles.eps" NDATA eps>
<!ENTITY HRDC.OrgH.fig.3 SYSTEM "./helpGuide/graphics/H_BuildDir.eps" NDATA eps>
<!ENTITY HRDC.OrgH.fig.4 SYSTEM "./helpGuide/graphics/H_ExHomeTopic.eps" NDATA eps>
<!ENTITY HRDC.OrgH.fig.5 SYSTEM "./helpGuide/graphics/H_GraphicEntity.eps" NDATA eps>
<!ENTITY HRDC.WrTop.fig.1 SYSTEM "./helpGuide/graphics/H_ExBulletList.eps" NDATA eps>
<!ENTITY HRDC.WrTop.fig.2 SYSTEM "./helpGuide/graphics/H_ExNumList.eps" NDATA eps>
<!ENTITY HRDC.WrTop.fig.3 SYSTEM "./helpGuide/graphics/H_ExLablist1.eps" NDATA eps>
<!ENTITY HRDC.WrTop.fig.4 SYSTEM "./helpGuide/graphics/H_ExLabListHd.eps" NDATA eps>
<!ENTITY HRDC.WrTop.fig.5 SYSTEM "./helpGuide/graphics/H_ExProcedure.eps" NDATA eps>
<!ENTITY HRDC.WrTop.fig.6 SYSTEM "./helpGuide/graphics/H_ExComputer.eps" NDATA eps>
<!ENTITY HRDC.WrTop.fig.7 SYSTEM "./helpGuide/graphics/H_Icons.eps" NDATA eps>
<!ENTITY HRDC.WrTop.fig.8 SYSTEM "./helpGuide/graphics/H_ExTextHyperlink.eps" NDATA eps>
<!ENTITY HRDC.WrTop.fig.9 SYSTEM "./helpGuide/graphics/H_ExInlineGraphic.eps" NDATA eps>
<!ENTITY HRDC.WrTop.fig.10 SYSTEM "./helpGuide/graphics/H_ExWrapGraphic.eps" NDATA eps>
<!ENTITY HRDC.CrHV.fig.1 SYSTEM "./helpGuide/graphics/H_Process.eps" NDATA eps>
<!ENTITY HRDC.CrHV.fig.2 SYSTEM "./helpGuide/graphics/H_ViewVolume.eps" NDATA eps>
<!ENTITY HRDC.CrHV.fig.3 SYSTEM "./helpGuide/graphics/H_FMCompile.eps" NDATA eps>
<!ENTITY HRDC.CrHV.fig.4 SYSTEM "./helpGuide/graphics/H_HelpManager.eps" NDATA eps>
<!ENTITY HRDC.CrHV.fig.5 SYSTEM "./helpGuide/graphics/H_FrontPanel.eps" NDATA eps>
<!ENTITY HRDC.CrHV.fig.6 SYSTEM "./helpGuide/graphics/H_PrintDialog.eps" NDATA eps>
<!ENTITY HRDC.Ref.fig.1 SYSTEM "./helpGuide/graphics/H_ExAnnot.eps" NDATA eps>
<!ENTITY HRDC.Ref.fig.2 SYSTEM "./helpGuide/graphics/H_ExCaution.eps" NDATA eps>
<!ENTITY HRDC.Ref.fig.3 SYSTEM "./helpGuide/graphics/H_ExEx.eps" NDATA eps>
<!ENTITY HRDC.Ref.fig.4 SYSTEM "./helpGuide/graphics/H_ExListHd.eps" NDATA eps>
<!ENTITY HRDC.Ref.fig.5 SYSTEM "./helpGuide/graphics/H_ExNoteHd.eps" NDATA eps>
<!ENTITY HRDC.Ref.fig.6 SYSTEM "./helpGuide/graphics/H_ExKeycap.eps" NDATA eps>
<!ENTITY HRDC.Ref.fig.7 SYSTEM "./helpGuide/graphics/H_ExLablistWrap.eps" NDATA eps>
<!ENTITY HRDC.Ref.fig.8 SYSTEM "./helpGuide/graphics/H_ExLabNowrap.eps" NDATA eps>
<!ENTITY HRDC.Ref.fig.9 SYSTEM "./helpGuide/graphics/H_ExInlineGraphic.eps" NDATA eps>
<!ENTITY HRDC.Ref.fig.10 SYSTEM "./helpGuide/graphics/H_ExLists.eps" NDATA eps>
<!ENTITY HRDC.Ref.fig.11 SYSTEM "./helpGuide/graphics/H_ExOtherHead.eps" NDATA eps>
<!ENTITY HRDC.Ref.fig.12 SYSTEM "./helpGuide/graphics/H_ExPHead.eps" NDATA eps>
<!ENTITY HRDC.Ref.fig.13 SYSTEM "./helpGuide/graphics/H_ExProced2.eps" NDATA eps>
<!ENTITY HRDC.Ref.fig.14 SYSTEM "./helpGuide/graphics/H_ExVex.eps" NDATA eps>
<!ENTITY HRDC.Ref.fig.15 SYSTEM "./helpGuide/graphics/H_ExXref.eps" NDATA eps>
<!ENTITY HRDC.ChEnt.fig.1 SYSTEM "./helpGuide/graphics/H_CharEntVEllip.eps" NDATA eps>
<!ENTITY HRDC.ChEnt.fig.2 SYSTEM "./helpGuide/graphics/H_CharEntU.eps" NDATA eps>
<!ENTITY HRDC.CrDia.fig.1 SYSTEM "./helpGuide/graphics/H_GenHelpLB.eps" NDATA eps>
<!ENTITY HRDC.CrDia.fig.2 SYSTEM "./helpGuide/graphics/H_QuickHelp.eps" NDATA eps>
<!ENTITY HRDC.Inst.fig.1 SYSTEM "./helpGuide/graphics/H_Approot.eps" NDATA eps>
<!ENTITY HRDC.Inst.fig.2 SYSTEM "./helpGuide/graphics/H_BuildInstall.eps" NDATA eps>
<!ENTITY HRDC.Lang.fig.1 SYSTEM "./helpGuide/graphics/H_FormatTable.eps" NDATA eps>
<!ENTITY Pref SYSTEM "./helpGuide/preface.sgm">
<!ENTITY part1 SYSTEM "./helpGuide/part1.sgm">
<!ENTITY Intro SYSTEM "./helpGuide/ch01.sgm">
<!ENTITY part2 SYSTEM "./helpGuide/part2.sgm">
<!ENTITY OrgH SYSTEM "./helpGuide/ch02.sgm">
<!ENTITY WrTop SYSTEM "./helpGuide/ch03.sgm">
<!ENTITY CrHV SYSTEM "./helpGuide/ch04.sgm">
<!ENTITY ChEnt SYSTEM "./helpGuide/ch05.sgm">
<!ENTITY CmdS SYSTEM "./helpGuide/ch06.sgm">
<!ENTITY Sgml SYSTEM "./helpGuide/ch07.sgm">
<!ENTITY part3 SYSTEM "./helpGuide/part3.sgm">
<!ENTITY CrDia SYSTEM "./helpGuide/ch08.sgm">
<!ENTITY HReq SYSTEM "./helpGuide/ch09.sgm">
<!ENTITY DiaEv SYSTEM "./helpGuide/ch10.sgm">
<!ENTITY H4Hlp SYSTEM "./helpGuide/ch11.sgm">
<!ENTITY Inst SYSTEM "./helpGuide/ch12.sgm">
<!ENTITY part4 SYSTEM "./helpGuide/part4.sgm">
<!ENTITY Lang SYSTEM "./helpGuide/ch13.sgm">
<!ENTITY Gloss SYSTEM "./helpGuide/glossary.sgm">
<!ENTITY existential "[existential]" >
<!ENTITY florin "[florin]" >
<!ENTITY guillemetleft "[guillemetleft]" >
<!ENTITY guillemetright "[guillemetright]" >
<!ENTITY Rfraktur "[Rfraktur]" >
<!ENTITY lfraktur "[lfraktur]" >
]>
<!-- ____________________________________________________________________________ -->
<!-- <DocBook> -->
<Book>
<Title>共通デスクトップ環境 ヘルプ・システム設計者およびプログラマのためのガイド</Title>
&Pref;
<Part Id="HRDC.part1.div.1">
&part1;
&Intro;
</Part>
<Part Id="HRDC.part2.div.1">
&part2;
&OrgH;
&WrTop;
&CrHV;
&ChEnt
&CmdS;
&Sgml;
</Part>
<Part Id="HRDC.part3.div.1">
&part3;
&CrDia;
&HReq;
&DiaEv;
&H4Hlp;
&Inst;
</Part>
<Part Id="HRDC.part4.div.1">
&part4;
&Lang;
</Part>
&Gloss;
</Book>
<!-- </DocBook> -->

View File

@@ -0,0 +1,127 @@
<!DOCTYPE Book PUBLIC "-//HaL and O'Reilly//DTD DocBook//EN" [
<!ENTITY % ISOpublishing PUBLIC "ISO 8879-1986//ENTITIES Publishing//EN">
%ISOpublishing;
<!ENTITY % ISOnumeric PUBLIC "ISO 8879-1986//ENTITIES Numeric and Special Graphic//EN">
%ISOnumeric;
<!ENTITY % ISOAMSAR PUBLIC "ISO 8879-1986//ENTITIES Added Math Symbols: Arrow Relations//EN">
%ISOAMSAR;
<!ENTITY % ISOAMSBO PUBLIC "ISO 8879-1986//ENTITIES Added Math Symbols: Binary Operators//EN">
%ISOAMSBO;
<!ENTITY % ISOAMSO PUBLIC "ISO 8879-1986//ENTITIES Added Math Symbols: Ordinary//EN">
%ISOAMSO;
<!ENTITY % ISOAMSR PUBLIC "ISO 8879-1986//ENTITIES Added Math Symbols: Relations//EN">
%ISOAMSR;
<!ENTITY % ISOdiacritical PUBLIC "ISO 8879-1986//ENTITIES Diacritical Marks//EN">
%ISOdiacritical;
<!ENTITY % ISOgeneraltech PUBLIC "ISO 8879-1986//ENTITIES General Technical//EN">
%ISOgeneraltech;
<!ENTITY % ISOalatin1 PUBLIC "ISO 8879-1986//ENTITIES Added Latin 1//EN">
%ISOalatin1;
<!ENTITY % ISOalatin2 PUBLIC "ISO 8879-1986//ENTITIES Added Latin 2//EN">
%ISOalatin2;
<!ENTITY % ISOgreek PUBLIC "ISO 8879-1986//ENTITIES Greek Symbols//EN">
%ISOgreek;
<!ENTITY % ISOgreekletters PUBLIC "ISO 8879-1986//ENTITIES Greek Letters//EN">
%ISOgreekletters;
<!ENTITY % ISOboxandline PUBLIC "ISO 8879-1986//ENTITIES Box and Line Drawing//EN">
%ISOboxandline;
<!ENTITY % BEntities SYSTEM "./helpGuide/BEntity.sgm">
%BEntities;
<!ENTITY Pref SYSTEM "./helpGuide/preface.sgm">
<!ENTITY part1 SYSTEM "./helpGuide/part1.sgm">
<!ENTITY Intro SYSTEM "./helpGuide/ch01.sgm">
<!ENTITY part2 SYSTEM "./helpGuide/part2.sgm">
<!ENTITY OrgH SYSTEM "./helpGuide/ch02.sgm">
<!ENTITY WrTop SYSTEM "./helpGuide/ch03.sgm">
<!ENTITY CrHV SYSTEM "./helpGuide/ch04.sgm">
<!ENTITY ChEnt SYSTEM "./helpGuide/ch05.sgm">
<!ENTITY CmdS SYSTEM "./helpGuide/ch06.sgm">
<!ENTITY Sgml SYSTEM "./helpGuide/ch07.sgm">
<!ENTITY part3 SYSTEM "./helpGuide/part3.sgm">
<!ENTITY CrDia SYSTEM "./helpGuide/ch08.sgm">
<!ENTITY HReq SYSTEM "./helpGuide/ch09.sgm">
<!ENTITY DiaEv SYSTEM "./helpGuide/ch10.sgm">
<!ENTITY H4Hlp SYSTEM "./helpGuide/ch11.sgm">
<!ENTITY Inst SYSTEM "./helpGuide/ch12.sgm">
<!ENTITY part4 SYSTEM "./helpGuide/part4.sgm">
<!ENTITY Lang SYSTEM "./helpGuide/ch13.sgm">
<!ENTITY Gloss SYSTEM "./helpGuide/glossary.sgm">
<!ENTITY existential "[existential]" >
<!ENTITY florin "[florin]" >
<!ENTITY guillemetleft "[guillemetleft]" >
<!ENTITY guillemetright "[guillemetright]" >
<!ENTITY Rfraktur "[Rfraktur]" >
<!ENTITY lfraktur "[lfraktur]" >
]>
<!-- ____________________________________________________________________________ -->
<Book>
<Title>共通デスクトップ環境 ヘルプ・システム設計者およびプログラマのためのガイド</Title>
&Pref;
<Part Id="HRDC.part1.div.1">
&part1;
&Intro;
</Part>
<Part Id="HRDC.part2.div.1">
&part2;
&OrgH;
&WrTop;
&CrHV;
&ChEnt;
&CmdS;
&Sgml;
</Part>
<Part Id="HRDC.part3.div.1">
&part3;
&CrDia;
&HReq;
&DiaEv;
&H4Hlp;
&Inst;
</Part>
<Part Id="HRDC.part4.div.1">
&part4;
&Lang;
</Part>
&Gloss;
</Book>

View File

@@ -0,0 +1,416 @@
<!-- $XConsortium: ch01.sgm /main/12 1996/10/22 12:20:04 rws $ -->
<!-- (c) Copyright 1995 Digital Equipment Corporation. -->
<!-- (c) Copyright 1995 Hewlett-Packard Company. -->
<!-- (c) Copyright 1995 International Business Machines Corp. -->
<!-- (c) Copyright 1995 Sun Microsystems, Inc. -->
<!-- (c) Copyright 1995 Novell, Inc. -->
<!-- (c) Copyright 1995 FUJITSU LIMITED. -->
<!-- (c) Copyright 1995 Hitachi. -->
<chapter id="HRDC.Intro.div.1">
<title id="HRDC.Intro.mkr.1">ヘルプ・システムの概要</title>
<para>この章では、ヘルプ・システムの概要を述べ、ユーザ・インタフェースを簡単に説明します。ここでは、ヘルプ情報の構成を示し、ヘルプ・モジュールの作成および処理の方法を解説し、アプリケーション・ヘルプの設計およぴ作成における設計者と開発者の役割を説明します。</para>
<informaltable id="HRDC.Intro.itbl.1" frame="All">
<tgroup cols="1">
<colspec colname="1" colwidth="4.0 in">
<tbody>
<row rowsep="1">
<entry><para><!--Original XRef content: 'Developer's Toolkit2'--><xref role="JumpText"
linkend="HRDC.Intro.mkr.3"></para></entry></row>
<row rowsep="1">
<entry><para><!--Original XRef content: 'Overview of Online Help2'--><xref
role="JumpText" linkend="HRDC.Intro.mkr.4"></para></entry></row>
<row rowsep="1">
<entry><para><!--Original XRef content: 'Help Information Model3'--><xref
role="JumpText" linkend="HRDC.Intro.mkr.5"></para></entry></row>
<row rowsep="1">
<entry><para><!--Original XRef content: 'Help User Interface5'--><xref role="JumpText"
linkend="HRDC.Intro.mkr.7"></para></entry></row>
<row rowsep="1">
<entry><para><!--Original XRef content: 'Help Topic Organization11'--><xref
role="JumpText" linkend="HRDC.Intro.mkr.14"></para></entry></row>
<row rowsep="1">
<entry><para><!--Original XRef content: 'The Author's Job14'--><xref role="JumpText"
linkend="HRDC.Intro.mkr.18"></para></entry></row>
<row rowsep="1">
<entry><para><!--Original XRef content: 'Programmer's Job19'--><xref role="JumpText"
linkend="HRDC.Intro.mkr.27"></para></entry></row></tbody></tgroup></informaltable>
<para><indexterm><primary>ヘルプ・システムの概要</primary></indexterm><indexterm>
<primary>共通デスクトップ環境ヘルプ・システム, 概要</primary></indexterm></para>
<sect1 id="HRDC.Intro.div.2">
<title id="HRDC.Intro.mkr.2">ヘルプ・システムの概要</title>
<para>ヘルプ・システムは、アプリケーション・ソフトウェアのオンライン・ヘルプを開発するための一連のツールを提供します。これにより設計者は、グラフィックとテキストの書式化、ハイパーリンク、およびアプリケーションとの通信を含むヘルプ・システムを作成することができます。 </para>
<para>また、オンライン・ヘルプをアプリケーションに統合するためのプログラマのツールキットも提供します。ヘルプ・システムのアプリケーション・プログラム・インタフェースは、2つの特別なヘルプ・ダイアログ、およびオンライン・ヘルプ・モジュールの表示、ナビゲート、検索、および印刷に使用するサポート・ルーチンを提供します。</para>
<sect2 id="HRDC.Intro.div.3">
<title id="HRDC.Intro.mkr.3">開発者のツールキット</title>
<para>ヘルプ・システム開発者のツールキットには、オンライン・ヘルプの記述、処理、および表示を行うためのツールと、アプリケーション・プログラム用のライブラリが含まれています。</para>
<sect3 id="HRDC.Intro.div.4">
<title>設計者用ツールキット</title>
<itemizedlist remap="Bullet1"><listitem><para><emphasis>DocBook マークアップ言語</emphasis> オンライン・ヘルプの構成と内容をマークするためにテキストファイルで使用するタグのセット</para>
</listitem><listitem><para><emphasis>DocBook ソフトウェア</emphasis> 作成したDocBookファイルを変換して、実行時のヘルプ・ファイルに書き込むためのソフトウェア・ツールのセット</para>
</listitem><listitem><para><emphasis>ヘルプ表示アプリケーション</emphasis> オンライン・ヘルプを表示して、ユーザと同じようにそれを読んだり対話したりできるようにするビューア・プログラム</para>
</listitem></itemizedlist>
<para>オンライン・ヘルプの作成および処理の詳細については、<!--Original XRef content: 'Chapter&numsp;2, &ldquo;Organizing and Writing a Help Volume'--><xref role="ChapNumAndTitle" linkend="HRDC.OrgH.mkr.1">を参照してください。</para>
<sect4 id="HRDC.Intro.div.5">
<title>アプリケーション開発者用ツール</title>
<itemizedlist remap="Bullet1"><listitem><para><emphasis>DtHelp プログラミング・ライブラリ</emphasis> ヘルプ・ウィンドウをユーザのアプリケーションへ統合するためのアプリケーション・プログラム・インタフェース (API)</para>
</listitem><listitem><para><emphasis>プログラム例</emphasis> ヘルプ・システムを Motif アプリケーションへ統合する方法を示す単純な例
(<!--Original XRef content: 'page&numsp;19'--><xref role="PageNum" linkend="HRDC.Intro.mkr.28">を参照してください)
</para>
</listitem></itemizedlist>
<para>アプリケーションのプログラミング・ライブラリについては、第8章から第12章で説明します。</para>
</sect4>
</sect3>
</sect2>
</sect1>
<sect1 id="HRDC.Intro.div.6">
<title id="HRDC.Intro.mkr.4">オンライン・ヘルプの概要</title>
<para>コンピュータのハードウェアおよびソフトウェアの機能を<emphasis>すべて</emphasis>覚えることは不可能です。多くのコンピュータ・ユーザは、何度かヘルプを必要とすることがあるはずです。</para>
<para>オンライン・ヘルプは印刷されたマニュアルと異なり、その場ですぐ参照できる点で優れています。もっとも重要なのは、ユーザの現在のコンテキストの情報に適応できるようにするという点です。<emphasis>コンテキスト依存</emphasis>ヘルプは、ユーザが行っている作業に対応するヘルプを提供します。 オンライン・ヘルプを開発するときは、ユーザがその場の状況に応じてあらゆるヘルプを必要とすることに注意してください。
ユーザの疑問を予測することによって、論理的かつ直観的に応答するアプリケーション・ヘルプを設計することができます。</para>
</sect1>
<sect1 id="HRDC.Intro.div.7">
<title id="HRDC.Intro.mkr.5">ヘルプ・インフォメーション・モデル<indexterm><primary>インフォメーション・モデル、ヘルプ</primary></indexterm><indexterm><primary>モデル、ヘルプ・インフォメーション</primary></indexterm></title>
<para>オンライン・ヘルプには次の2つの形式があります。</para>
<itemizedlist remap="Bullet1"><listitem><para><emphasis>アプリケーション・ヘルプ</emphasis> Motifアプリケーションに統合されたヘルプの一部として機能します。
<indexterm><primary>Motif</primary></indexterm><indexterm><primary>Motif</primary></indexterm></para>
</listitem><listitem><para><emphasis>スタンドアロン・ヘルプ</emphasis> あらゆるアプリケーション・ソフトウェアに依存せずに、タスク、リファレンス、チュートリアル情報にオンラインでアクセスできるようにします。<indexterm><primary>スタンドアロン・ヘルプ</primary></indexterm></para>
</listitem></itemizedlist>
<para>アプリケーションのオンライン・ヘルプを開発する場合、情報をアプリケーションでのみアクセスできるように構成できます。あるいはスタンドアロン・ヘルプのように、アプリケーションの外からでも情報をブラウズできるように設定できます。</para>
<sect2 id="HRDC.Intro.div.8">
<title>アプリケーションの一部</title>
<para>ヘルプ機能により、アプリケーションとそのオンライン・ヘルプを高度に統合できます。ユーザの見地からみれば、ヘルプはアプリケーションの一部ということになります。これによって、ユーザとユーザが参照するヘルプとの間にあるアプリケーションの「距離」が縮まります。</para>
<para>アプリケーションの近くにあるということは、オンライン・ヘルプが使いやすく、要求に迅速に対応できるということです。</para>
</sect2>
<sect2 id="HRDC.Intro.div.9">
<title id="HRDC.Intro.mkr.6">ヘルプの種類<indexterm><primary>ヘルプの獲得</primary></indexterm><indexterm><primary>ヘルプ、ユーザによる獲得方法</primary></indexterm></title>
<para>オンライン・ヘルプは、次の3種類に分類されます。</para>
<itemizedlist remap="Bullet1"><listitem><para><emphasis>自動ヘルプ</emphasis> ヘルプが必要なとき、および表示する内容をアプリケーションが決定します。システム起動ヘルプとも呼ばれます。</para>
</listitem><listitem><para><emphasis>半自動ヘルプ</emphasis> ヘルプが必要かどうかはユーザが判断しますが、表示する内容はシステムが決定します。このヘルプはユーザの操作または[F1]キーを押すなどのヘルプ要求によって起動されます。どの情報を表示するかはユーザの現在のコンテキストによって決められるため、こうしたシステムの応答はコンテキスト・ヘルプと呼ばれます。</para>
</listitem><listitem><para><emphasis>自動ヘルプ</emphasis> ヘルプ・メニューなどからユーザが特定の情報を要求します。</para>
</listitem></itemizedlist>
</sect2>
<sect2 id="HRDC.Intro.div.10">
<title>ユーザがヘルプを獲得する方法</title>
<para>ユーザはいくつかの方法でヘルプを要求できます。多くのアプリケーションが、ヘルプ・メニュー、ヘルプ・キー、およびダイアログ・ボックスのヘルプ・ボタンを提供しています。</para>
<sect3 id="HRDC.Intro.div.11">
<title>ヘルプ・キー</title>
<para>多くのアプリケーションでユーザがまず使用するのは、<emphasis>ヘルプ・キー</emphasis>を押す方法です。最近では、多くのワークステーションおよびパーソナル・コンピュータにおいて、[F1]ファンクション・キーが事実上の標準ヘルプ・キーとなっています。</para>
<para>『CDE/Motif スタイル・ガイドおよび認証チェックリスト』では、ヘルプ・キーとして[F1]キーを使用することと、Motif アプリケーションでのヘルプ・キーの使用を容易にするような内部処理を提供する Motif プログラマ・ツールキットを使用することを推奨しています。
</para>
<para>一部のコンピュータは、キーボード上にヘルプ・キーを備えています。</para>
</sect3>
<sect3 id="HRDC.Intro.div.12">
<title>ヘルプ・メニュー</title>
<para>ヘルプ・メニューはヘルプ情報にアクセスするための一般的な方法です。Motif アプリケーションは、ヘルプ・メニューを提供しており、メニュー・バーの右端に表示されます。<citetitle>CDE/Motif スタイル・ガイドおよび認証チェックリスト</citetitle>では、ヘルプ・メニューに含めるコマンドについて推奨しています。</para>
<figure>
<title>アプリケーションのヘルプ・メニュー</title>
<graphic id="HRDC.Intro.grph.1" entityref="HRDC.Intro.fig.1"></graphic>
</figure>
</sect3>
<sect3 id="HRDC.Intro.div.13">
<title>ヘルプ・ボタン</title>
<para>ほとんどのダイアログ・ボックスに、ダイアログでヘルプを表示するためのヘルプ・ボタンがあります。<citetitle>CDE/Motif スタイル・ガイドおよび認証チェックリスト</citetitle>では、ダイアログ・ボックスでヘルプ・ボタンを選択することは、そのダイアログ・ボックスを使用中にヘルプ・キーを押すのと同じであると述べています。ただし、複雑なダイアログ、すなわちダイアログ・ボックス内で個々のコントロールがヘルプを持つような場合は例外です。
</para>
</sect3>
</sect2>
</sect1>
<sect1 id="HRDC.Intro.div.14">
<title id="HRDC.Intro.mkr.7">ヘルプ・ユーザ・インタフェース<indexterm><primary>概要</primary><secondary>ヘルプ・グラフィカル・ユーザ・インタフェース</secondary></indexterm></title>
<para>この節では、ヘルプ・システムが提供するグラフィカル・インタフェースの概要を説明します。ヘルプの機能の詳細については、<citetitle>共通デスクトップ環境 ユーザーズ・ガイド</citetitle>を参照してください。対応するオンライン・ヘルプを表示するには、デスクトップのフロントパネルのヘルプ・ビューア (<!--Original XRef content: '&ldquo;To Display the Help Index Volume&rdquo--><!--r; on page&numsp;97'--><xref role="SecTitleAndPageNum" linkend="hrdc.crhv.mkr.12">を参照してください) を開きます。それから、[デスクトップの紹介]および[ヘルプの使い方]を選択します。</para>
<para>アプリケーションの使用中、ヘルプ・キーを押すかアプリケーションのヘルプ・メニューを選択することにより、ユーザはヘルプを要求できます。また、ヘルプ・システムを統合したアプリケーションをインストールできるので、デスクトップのヘルプ・ビューアからそれぞれのヘルプ・モジュールにアクセスできます。これにより、複数のアプリケーションが提供するヘルプ情報をブラウズする場合でも、各アプリケーションを実行せずに行うことができます。</para>
<sect2 id="HRDC.Intro.div.15">
<title>ヘルプ・ウィンドウ</title>
<para>ユーザが要求すると、ヘルプ・システムはヘルプ・ウィンドウを表示します。ヘルプ・ウィンドウには、一般ヘルプと簡易ヘルプの2種類があります。一般ヘルプ・ウィンドウは、メニュー・バー、トピック・ツリー、およびトピック表示領域から構成されます。トピック・ツリーはユーザが選択できるヘルプ・トピックの一覧です。ウィンドウの下部(トピック表示領域)には選択されたトピックが表示されます。</para>
<para>簡易ヘルプ・ウィンドウは無駄を省いたヘルプ・ウィンドウです。トピック表示領域とひとつ以上のダイアログ・ボタンしか表示されません。このウィンドウは、定義などの短い組み込み情報の表示によく利用されます。</para>
<figure>
<title>一般ヘルプ・ウィンドウと簡易ヘルプ・ウィンドウ</title>
<graphic id="HRDC.Intro.grph.2" entityref="HRDC.Intro.fig.2"></graphic>
</figure>
</sect2>
<sect2 id="HRDC.Intro.div.16">
<title>ハイパーリンク</title>
<para>ヘルプ・トピックには、関連するヘルプ情報へ「ジャンプ」するハイパーリンクがしばしば含まれています。テキストとグラフィックの両方をハイパーリンクとして使用できます。
<!--Original XRef content: 'Figure&numsp;1&hyphen;3 on page&numsp;7'--><xref role="CodeOrFigOrTabAndPNum" linkend="HRDC.Intro.mkr.8">は、ハイパーリンクの識別に使用されるスタイルのフォーマットを示しています。</para>
<para><indexterm><primary>ハイパーリンク</primary><secondary>表示形式</secondary></indexterm>
実線の下線または破線の下線は、ハイパーリンクである語または句を示します。実線の下線、つまり標準ハイパーリンクがもっとも一般的です。ハイパーリンクを選択すると、関連するトピックが表示されます。ハイパーリンク・トピックを現在のヘルプ・ウィンドウと新規ウィンドウのどちらに表示するかは、設計者が指定します。破線の下線は定義リンクを示します。これを選択すると、関連するトピックが簡易ヘルプ・ウィンドウに表示されます。グレーの隅の開いている枠(破線または実線の枠)は、グラフィック・ハイパーリンクを示します。</para>
<figure>
<title id="HRDC.Intro.mkr.8">グラフィック・ハイパーリンクとテキスト・ハイパーリンクの形式</title>
<graphic id="HRDC.Intro.grph.3" entityref="HRDC.Intro.fig.3"></graphic>
</figure>
</sect2>
<sect2 id="HRDC.Intro.div.17">
<title>ヘルプ・ナビゲーション<indexterm><primary>トピック・ツリー</primary><secondary>トピックの選択</secondary></indexterm></title>
<para><!--Original XRef content: 'Figure&numsp;1&hyphen;4'--><xref role="CodeOrFigureOrTable" linkend="HRDC.Intro.mkr.9">のトピック・ツリー<indexterm><primary>トピック・ツリー</primary><secondary>一般ヘルプ・ダイアログ</secondary></indexterm>は、現在のヘルプ・ボリュームのトピックのリストです。リスト最上部にある最初のトピックは、<emphasis>ホーム・トピック</emphasis>で、ヘルプ・ボリュームの先頭です。矢印(→)は現在のトピックを指し、ヘルプ・ボリュームにおけるユーザの位置を示します。</para>
<figure>
<title id="HRDC.Intro.mkr.9">一般ヘルプ・ダイアログ・ボックスのトピック・ツリー</title>
<graphic id="HRDC.Intro.grph.4" entityref="HRDC.Intro.fig.4"></graphic>
</figure>
<para>ヘルプ・トピックを表示するには、トピック・ツリーのタイトルか、トピック表示位置のハイパーリンクを選択します。表示をスクロールして任意のトピックを選択することにより、トピックの概要をブラウズできます。ナビゲーション・コマンドにより、前のトピックまたはヘルプ・ボリュームの先頭に戻ることができます。</para>
<sect3 id="HRDC.Intro.div.18">
<title>ヘルプ・ナビゲーション・ボタン<indexterm><primary>ナビゲーション、ヘルプ・ボタン</primary></indexterm></title>
<para><indexterm><primary>ボタン、ナビゲーション</primary></indexterm>一般ヘルプ・ダイアログには、[前のトピックへ]、[ヒストリ]、[索引]の3つのダイアログ・ボタンがあります。これらの機能は、メニュー項目の選択にも使用できます。</para>
<itemizedlist remap="Bullet1"><listitem><para><emphasis>[前のトピックへ]</emphasis> 前のトピックに戻ります。先に参照したトピックに戻るには、希望のトピックが表示されるまで[前のトピック]ボタンを繰り返し押します。</para>
</listitem><listitem><para><emphasis>[ヒストリ]</emphasis> <emphasis>[ヒストリ]</emphasis>ダイアログ・ボックスを表示します。これはヘルプ・ボリュームとすでに参照したトピックをリストします。リストにある任意のトピックに戻るには、そのタイトルを選択します。 </para>
</listitem><listitem><para><emphasis>[索引]</emphasis> <emphasis>[索引検索]</emphasis>ダイアログ・ボックスを表示します。これは設計者が索引エントリとしてマークした語句をすべてリストします。索引エントリを選択し、表示されたトピックのいずれかを選択すると、一般ヘルプ・ダイアログにそのトピックが表示されます。
<!--Original XRef content: ''--><xref role="CodeOrFigureOrTable"
linkend="HRDC.Intro.mkr.10"></para>
</listitem></itemizedlist>
<para>デスクトップのフロントパネルからヘルプ・ビューアを使用する場合、一般ヘルプ・ダイアログに[トップレベル]という追加ダイアログ・ボタンがあります。別のヘルプ・ボリュームを参照した後、このボタンを選択してデスクトップ・ブラウザ・ヘルプ・ボリュームのトップレベルに戻ることができます。</para>
</sect3>
</sect2>
<sect2 id="HRDC.Intro.div.19">
<title>ヘルプ・メニュー</title>
<para><indexterm><primary>ホーム・トピック</primary><secondary>メニュー・コマンド</secondary>
</indexterm>一般ヘルプ・ダイアログのメニュー・バーには、[ファイル]、[編集]、[検索]、[ナビゲート]、[ヘルプ]の5つのメニューが表示されます。[検索]メニューと[ナビゲート]メニューには、前記した[索引]ボタンとナビゲーション・ボタンで使用するコマンドがあります。また、[ナビゲート]メニューには、ヘルプ・ボリュームの先頭に戻るための[ホーム・トピック]コマンドがあります。その他のメニューは次の機能を提供します。</para>
<itemizedlist remap="Bullet1"><listitem><para><emphasis>[ファイル]メニュー</emphasis> ヘルプ・ウィンドウの複製、ヘルプ・トピックまたは現在のヘルプ・ボリュームの印刷、ヘルプ・ウィンドウのクローズ</para>
<indexterm><primary>メニュー</primary><secondary>[ファイル]</secondary></indexterm>
<indexterm><primary>メニュー</primary><secondary>[編集]</secondary></indexterm>
<indexterm><primary>メニュー</primary><secondary>[ヘルプ]</secondary></indexterm>
<indexterm><primary>メニュー</primary><secondary>[ナビゲート]</secondary></indexterm>
</listitem><listitem><para><emphasis>[編集]メニュー</emphasis> ヘルプ・ウィンドウから他のアプリケーションへのテキストのコピー</para>
</listitem><listitem><para><emphasis>[ヘルプ]メニュー</emphasis> ヘルプ・ダイアログの機能とその使い方に関するヘルプ情報の提供</para>
</listitem></itemizedlist>
</sect2>
<sect2 id="HRDC.Intro.div.20">
<title id="HRDC.Intro.mkr.10">ヘルプ索引</title>
<para><indexterm><primary>索引</primary><secondary>[索引検索]ダイアログ索引</secondary></indexterm>ヘルプ・ボリュームには、ユーザがサブジェクトのヘルプ・トピックを検索できるように、重要な語句の索引が入っています。ユーザは現在のボリューム、選択したボリューム、またはシステムで使用できるすべてのヘルプ・ボリュームの索引をブラウズまたは検索できます。*(アスタリスク)および ?(疑問符)などの正規表現もトピックの検索に使用できます。対応するヘルプ・トピックを表示するには、索引エントリを選択します。</para>
<figure>
<title id="HRDC.Intro.mkr.11">[索引検索]ダイアログ・ボックス</title>
<graphic id="HRDC.Intro.grph.5" entityref="HRDC.Intro.fig.5"></graphic>
</figure>
<para>[ヘルプ索引]は一度に表示するには多すぎるる場合があるので、表示されていない索引エントリがまだあったり、全部が表示されている場合もあります。+(プラス)または -(マイナス)の符号は表示されていない索引エントリがまだあるのかないのかを示します。マイナス符号はエントリのすべてが表示されていることを示し、プラス符号はまだ表示されていないエントリがあり、索引エントリを表示できることを示します。</para>
<para>図<!--Original XRef content: 'Figure&numsp;1&hyphen;6 on page&numsp;10'--><xref role="CodeOrFigOrTabAndPNum" linkend="HRDC.Intro.mkr.12">において、-36の符号は、36個の索引エントリが表示されていることを意味しています。+3の符号は、表示されていないエントリがまだあることを示します。表示されていないエントリを選択するとリストが展開され、+ 符号が - 符号に変わります。この図の最後の索引エントリは、このようにして表示されたエントリです。</para>
<figure>
<title id="HRDC.Intro.mkr.12">索引エントリ符号</title>
<graphic id="HRDC.Intro.grph.6" entityref="HRDC.Intro.fig.6"></graphic>
</figure>
</sect2>
<sect2 id="HRDC.Intro.div.21">
<title>ヘルプからの印刷<indexterm><primary>印刷</primary><secondary>ヘルプ情報</secondary></indexterm></title>
<figure>
<title id="HRDC.Intro.mkr.13">[印刷]ダイアログ・ボックス</title>
<graphic id="HRDC.Intro.grph.7" entityref="HRDC.Intro.fig.7"></graphic>
</figure>
</sect2>
</sect1>
<sect1 id="HRDC.Intro.div.22">
<title id="HRDC.Intro.mkr.14">ヘルプ・トピックの構成<indexterm><primary>ヘルプ</primary><secondary>トピックの構成</secondary></indexterm></title>
<para>設計者は、ヘルプ情報を論理フレームワークで構成します。例外はありますが、トピックの概略または階層を示す形式がほとんどです。
<!--Original XRef content: 'Figure&numsp;1&hyphen;8'--><xref role="CodeOrFigureOrTable" linkend="HRDC.Intro.mkr.15">に示すトピックの階層は、メイン・レベル、3つのセクション、およびそれに従属するトピックから構成されています。 [ヘルプ]は、階層から成る情報に最適化されていますが、必要に応じて任意の構成にすることができます。</para>
<figure>
<title id="HRDC.Intro.mkr.15">トピックの階層</title>
<graphic id="HRDC.Intro.grph.8" entityref="HRDC.Intro.fig.8"></graphic>
</figure>
<sect2 id="HRDC.Intro.div.23">
<title>ヘルプ・トピック<indexterm><primary>トピック</primary><secondary>定義された</secondary>
</indexterm><indexterm><primary>ヘルプ・トピック</primary><secondary>定義された</secondary></indexterm></title>
<para id="HRDC.Intro.mkr.16"><emphasis>ヘルプ・トピック</emphasis>は固有のIDで識別される情報の単位です。ヘルプ・システムが提供する一連のタグは、ヘルプ・トピックをマークし、構造的なフレームワークを作成するために使用されます。ヘルプ・ビューアは、ヘルプ・システムの一部で、ヘルプ・トピックに直接アクセスし、それを表示することができます。</para>
</sect2>
<sect2 id="HRDC.Intro.div.24">
<title><indexterm><primary>ヘルプ・ボリューム</primary><secondary>定義された</secondary>
</indexterm><indexterm><primary>ボリューム</primary><secondary>定義された</secondary>
</indexterm>ヘルプ・ボリューム<indexterm><primary>ボリューム</primary><secondary>トピックの集まりとしての</secondary></indexterm><indexterm><primary>トピック</primary><secondary>~の集まりとしてのボリューム</secondary></indexterm></title>
<para><emphasis>ヘルプ・ボリューム</emphasis>は、アプリケーションまたは特定のサブジェクトを記述するトピックの集まりです。アプリケーションのヘルプを開発する場合、一般にはアプリケーションごとにひとつのヘルプ・ボリュームがあります。ただし、複雑なアプリケーション、または関連するアプリケーションの集まりについては、複数のヘルプ・ボリュームを使用することもあります。</para>
</sect2>
<sect2 id="HRDC.Intro.div.25">
<title><indexterm><primary>ヘルプ・ファミリ</primary><secondary>定義された</secondary></indexterm>ヘルプ・ファミリ<indexterm><primary>ファミリ</primary><secondary>~の定義</secondary></indexterm><indexterm><primary>関連するボリュームのグループ、~としてのファミリ</primary></indexterm><indexterm><primary>関連するボリューム、~のグループとしてのファミリ</primary></indexterm><indexterm><primary>ボリューム</primary><secondary>ボリュームのファミリ</secondary></indexterm></title>
<para>ソフトウェアは、<emphasis>プロダクト・ファミリ</emphasis>として認識される一連の関連アプリケーションとして使用できます。たとえば、オフィスで使用されるアプリケーションには、ワードプロセッサ、スプレッドシート、描画プログラムなどがあります。各アプリケーションには独自のヘルプ・ボリュームがあるので、関連するヘルプ・ボリュームを<emphasis>ヘルプ・ファミリ</emphasis>としてグループ化するようになっています。ヘルプ・ファミリには、単一のヘルプ・ボリュームまたは複数のボリュームが入っています。</para>
<para>ヘルプ・ボリュームをヘルプ・ファミリにまとめるかどうかは任意です。フロントパネルのヘルプ・ビューアなどの<emphasis>ヘルプ・ブラウザ</emphasis>でヘルプをブラウズできるようにする場合にのみ必要です。</para>
<para>ヘルプ・ファミリ・ファイルとその使い方については、<!--Original XRef content: '&ldquo;To Create a Help Family&rdquo; on page&numsp;95'--><xref role="SecTitleAndPageNum" linkend="HRDC.CrHV.mkr.11">を参照してください。</para>
</sect2>
<sect2 id="HRDC.Intro.div.26">
<title>ヘルプ索引ボリューム<indexterm><primary>ボリューム</primary><secondary>デスクトップ索引ボリューム</secondary></indexterm><indexterm><primary>ヘルプ索引</primary>
</indexterm><indexterm><primary>ヘルプ索引ボリューム</primary><secondary>定義された</secondary></indexterm></title>
<para>デスクトップは、システムにインストールされたヘルプを表示する<emphasis>検索</emphasis>ボリュームと呼ばれる特別なヘルプ・ボリュームを提供します。フロントパネルのヘルプ・ビューアをクリックすると、
<!--Original XRef content: 'page&numsp;13'--><xref role="PageNum" linkend="HRDC.Intro.mkr.17">の
<!--Original XRef content: 'Figure&numsp;1&hyphen;9'--><xref role="CodeOrFigureOrTable" linkend="HRDC.Intro.mkr.17">に示す検索ボリュームが表示されます。</para>
<para>これは、ヘルプ・ファミリ(下線の付いた名前)とヘルプ・ファミリのメンバである任意のボリュームを表示します。</para>
<figure>
<title id="HRDC.Intro.mkr.17">索引ヘルプ・ボリューム</title>
<graphic id="HRDC.Intro.grph.9" entityref="HRDC.Intro.fig.9"></graphic>
</figure>
<para>索引ボリュームにより、アプリケーションを使用せずにアプリケーション固有のヘルプにアクセスできます。また、スタンドアロン・ヘルプを書く場合は、ヘルプを使用するための唯一の手段がこの索引ボリュームを使用する方法です。ヘルプ・ボリュームがひとつしかない場合は、ヘルプ・ビューアでブラウズできるヘルプ・ファミリに属していなければなりません。</para>
<para><!--Original XRef content: '&ldquo;Adding Your Help to the Browser
Volume&rdquo; on page&numsp;94'--><xref role="SecTitleAndPageNum" linkend="HRDC.CrHV.mkr.8">では、ファミリ・ファイルの作成方法と、索引ボリュームからヘルプ・ボリュームにアクセスできるようにするためにユーザが行うべき作業について説明しています。</para>
</sect2>
</sect1>
<sect1 id="HRDC.Intro.div.27">
<title id="HRDC.Intro.mkr.18">設計者が行う作業<indexterm><primary>設計者</primary><secondary>責任</secondary></indexterm><indexterm>
<primary>設計者が行う作業</primary></indexterm><indexterm><primary>責任</primary><secondary>設計者</secondary></indexterm></title>
<para>オンライン・ヘルプの記述は紙のマニュアルの記述とは異なるため、対象ユーザ、情報へのアクセス方法、アプリケーションと情報との合致という点に留意することが重要です。</para>
<sect2 id="HRDC.Intro.div.28">
<title>オンライン・ヘルプの目的<indexterm><primary>オンライン・ヘルプの目標</primary></indexterm><indexterm><primary>オンライン・ヘルプ</primary><secondary>目的</secondary></indexterm></title>
<para>良質のオンライン・ヘルプの設計には、次の2つの重要な目的があります。</para>
<itemizedlist remap="Bullet1"><listitem><para><emphasis>ユーザができるだけ早く、かつ正常に作業に戻ることができるようにすること。</emphasis></para>
</listitem><listitem><para><emphasis>ユーザがいずれヘルプなしでも作業できるように教育すること。</emphasis></para>
</listitem></itemizedlist>
<para>これらに目標を置けば、最適なヘルプは何か、必要な情報は何かを判断するのに役立ちます。</para>
</sect2>
<sect2 id="HRDC.Intro.div.29">
<title id="HRDC.Intro.mkr.19">対象となるユーザ<indexterm><primary>ユーザ</primary><secondary>対象となる</secondary></indexterm></title>
<para>何を書く場合でも、対象となるユーザとそのユーザが必要としている情報を理解することが大切です。特に、オンライン・ヘルプでは、ユーザが行おうとしている作業と、起こりうる問題について認識しておくことが重要です。</para>
</sect2>
<sect2 id="HRDC.Intro.div.30">
<title id="HRDC.Intro.mkr.20">ヘルプへのアクセス方法<indexterm>
<primary>ヘルプ</primary><secondary>アクセスのタイプ</secondary></indexterm><indexterm>
<primary>アプリケーションのヘルプ</primary></indexterm></title>
<para>ユーザを正しく認識するのと同時に、ユーザがどのようにヘルプにアクセスするのかを理解することが重要です。</para>
<sect3 id="HRDC.Intro.div.31">
<title>アプリケーションのヘルプ</title>
<para>アプリケーションのヘルプを記述する場合は、ブラウズできるトピックと、<emphasis>コンテキスト・ヘルプ</emphasis>としてアプリケーションから使用できるトピックをそれぞれ決めることが必要です。トピックをナビゲートできる場合は、トピック・ツリーまたはハイパーリンクを使用してトピックをブラウズできます。排他的なコンテキスト・ヘルプに指定されているトピックは、アプリケーションの特定のコンテキストからしかトピックを表示できないため、ブラウズできません。</para>
<para>アプリケーションのヘルプ・ボリュームを<emphasis>登録する</emphasis>かどうかも決める必要があります。登録されたヘルプ・ボリュームは、他のアプリケーション(ヘルプ・ビューアなど)によっても表示でき、より広範囲な情報へのアクセスが可能になります。ヘルプ・ボリュームにあるトピックへの別のヘルプ・ボリュームからのハイパーリンクが含まれている場合は、そのヘルプ・ボリュームを登録してください。</para>
<para>アプリケーションのインストールと登録の詳細については、<!--Original XRef content: '&ldquo;Registering Your Application and Its Help&rdquo; on page&numsp;247'--><xref role="SecTitleAndPageNum" linkend="HRDC.Inst.mkr.9">を参照してください。</para>
</sect3>
<sect3 id="HRDC.Intro.div.32">
<title>スタンドアロン・ヘルプ・ボリューム<indexterm><primary>スタンドアロン・ヘルプ</primary>
</indexterm><indexterm><primary>ボリューム</primary><secondary>スタンドアロン・ヘルプ</secondary></indexterm></title>
<para>スタンドアロン・ヘルプ・ボリューム(アプリケーションに対応付けられていないヘルプ・ボリューム)を記述する場合は、別の方法で行うことができます。</para>
<para>まず記述したすべてのトピックをユーザが使用できるようパスを設定しなければなりません。つまり、すべてのトピックが、少くともひとつのハイパーリンクによってブラウズできなければなりません。また、ヘルプに対応付けられているアプリケーションがないため、ヘルプ・ボリュームの表示は、([ヘルプ・ビューア]のような)ヘルプ・ビューアに依存しなければなりません。</para>
</sect3>
</sect2>
<sect2 id="HRDC.Intro.div.33">
<title>ヘルプの表示方法の評価</title>
<para>アプリケーションは種類が異なるヘルプを取り入れることができます。この場合、アプリケーションに最適なヘルプの種類がどれかを判断することが重要になります。たとえば、同じヘルプ情報でもさまざまな方法で表示されることがあります。その選択には、主要な機能、チュートリアル、例、作業指示、ショートカット、トラブルシューティング、リファレンス情報、用語集、ハード・コピーの参照、またはその他のオンライン・マニュアルがあります。ヘルプ・ボリュームは、異なる表示を組み合わせることもあります。</para>
</sect2>
<sect2 id="HRDC.Intro.div.34">
<title id="HRDC.Intro.mkr.21">アプリケーション・プログラマとの協力<indexterm>
<primary>設計者</primary><secondary>アプリケーション・プログラマとの協力</secondary></indexterm><indexterm><primary>アプリケーション・プログラマ、~との協力</primary></indexterm><indexterm><primary>プログラマ、アプリケーション</primary>
<secondary>との協力</secondary></indexterm></title>
<para>アプリケーションのヘルプを記述する場合は、アプリケーション・プログラマと密に連絡をとるべきです。ヘルプ・システムをどの程度アプリケーションに統合するかは設計仕様によります。</para>
<para>アプリケーションとそのヘルプの結び付きが弱い場合には、アプリケーションが直接表示できるトピックはほんの一握りです。しかし、簡単に実装できます。</para>
<para>対照的に、アプリケーションのあらゆる状況に対応する特定のヘルプを提供できるアプリケーションもあります。これには多くの作業を必要としますが、それさえできればユーザにとっては非常に便利です。</para>
<para>ヘルプの結合レベルを決定するのは、設計者とそのプロジェクト・チームです。</para>
</sect2>
</sect1>
<sect1 id="HRDC.Intro.div.35">
<title id="HRDC.Intro.mkr.22">設計者のワークフロー<indexterm><primary>設計者</primary><secondary>ワークフロー</secondary></indexterm></title>
<para>ヘルプの設計が終わったなら、ヘルプ・ボリュームを作成するためのヘルプ・トピックを作成し、処理します。必要な作業は、次のとおりです。</para>
<itemizedlist remap="Bullet1"><listitem><para>ヘルプ・トピックの記述</para>
</listitem><listitem><para>実行時のヘルプ・ファイルの作成</para>
</listitem><listitem><para>ヘルプ・ボリュームの表示</para>
</listitem></itemizedlist>
<sect2 id="HRDC.Intro.div.36">
<title id="HRDC.Intro.mkr.23">DocBook によるヘルプ・トピックの記述</title>
<para>オンライン・ヘルプは通常のテキスト・ファイルで記述されます。情報の<symbol role="Variable">要素</symbol>をマークアップするには、特別なコード、すなわち<symbol role="Variable">タグ</symbol>を使用します。タグは、DocBook と呼ばれるマークアップ言語を形成します。</para>
<para>DocBook マークアップ言語は、章、セクション、サブセクションなどハイレベルの<symbol role="Variable">要素</symbol>と、段落、リスト、強調語などロウレベルの要素とを判別する、要素の階層を定義します。</para>
<para><!--Original XRef content: '&ldquo;General Markup Guidelines&rdquo;
on page&numsp;28'--><xref role="SecTitleAndPageNum" linkend="HRDC.OrgH.mkr.4">
では、マークアップの使い方について簡単に示しています。</para>
<sect3 id="HRDC.Intro.div.38">
<title id="HRDC.Intro.mkr.24">正規マークアップ<indexterm><primary>正規マークアップ</primary><secondary>定義された</secondary></indexterm><indexterm><primary>マークアップ</primary><secondary>正規 (SGML)</secondary></indexterm><indexterm>
<primary>構造化エディタ</primary></indexterm><indexterm><primary>エディタ、構造化</primary></indexterm></title>
<para><emphasis><indexterm><primary>マークアップ言語</primary><secondary>正規マークアップ、SGML準拠</secondary></indexterm>正規マークアップ</emphasis>とは、設計者が使用できる SGML (Standard Generalized Markup Language) によって、完全に SGML に準拠したヘルプ・トピックを作成することです。この場合は、<emphasis>すべての</emphasis>要素の最初と最後にタグを付けなければなりません。また、各要素の構造にも明示的にタグを付けなければなりません。したがって、正規マークアップを使用するとタグの数が非常に多くなります。標準エディタで正規マークアップを入力することもできますが、構造化エディタの使用を推奨します。</para>
<sect4 id="HRDC.Intro.div.39">
<title>構造化エディタ</title>
<para>構造化エディタと呼ばれる新しいツールが、SGML マークアップを効率よく作成するために使用できるようになりつつあります。典型的には、構造化エディタではコンテキスト・メニューを提供します。つまり、メニューに表示される要素が、ドキュメントのカーソルの位置に基づいて動的に変更されます。</para>
<para>たとえば、リストを入力する場合は、メニューにはリスト要素のコンテキストで有効な要素だけが含まれます。この組み込み「知能」によって、設計者は簡単にマークすることができます。</para>
<para>設計者が、セクション、ヘッダ、リストなどの要素を選択すると、エディタはそれに対応する開始、終了、および任意の中間構造タグを生成します。たとえば、設計者が章という要素を選択すると、この要素が必要とする中間タグをエディタが自動的に挿入します。編集者は、単に章のタイトルを入力すればよいのです。生成されたタグの表示は任意であり、設計者はタグを表示しないようにすることもできます。</para>
</sect4>
<sect4 id="HRDC.Intro.div.40">
<title>正規マークアップの使い方</title>
<para>正規マークアップを使う場合は、最初に<citetitle>第2部 設計者が行う作業</citetitle>を読んで、DocBook 要素の設定を理解してください。</para>
<para><!--Original XRef content: ''--><xref role="Blank" linkend="HRDC.Sgml.mkr.1"> <!--Original XRef content: 'Chapter&numsp;8, &ldquo;Reading the DocBook Document Type Definition'--><xref role="ChapNumAndTitle" linkend="HRDC.Sgml.mkr.1">では、文書型定義 (DTD) の主要なコンポーネントを説明し、正規マークアップの作成方法を示します。完全な DocBook 文書型定義 (DTD) は、<citetitle>共通デスクトップ環境 DocBook 文書型定義ガイド</citetitle>にあります。</para>
<note>
<para>開発者キットには、DocBook 文書型定義 (DTD) が入っています。ファイルは、<filename>/usr/dt/dthelp/dtdocbook/SGML/docbook.dtd</filename>ディレクトリにあり、<filename>DocBook.dtd</filename>という名前です。</para>
</note>
</sect4>
</sect3>
<sect3 id="HRDC.Intro.div.41">
<title>関連項目</title>
<itemizedlist><listitem><para><citetitle>共通デスクトップ環境 DocBook 文書型定義ガイド</citetitle>は、主要なタグの詳細な説明を、アルファベット順で示しています。</para>
</listitem><listitem><para><!--Original XRef content: 'Chapter&numsp;8, &ldquo;Reading the DocBook Document Type Definition'--><xref role="ChapNumAndTitle" linkend="HRDC.Sgml.mkr.1">は、正規マークアップについて説明しています。</para>
</listitem>
<listitem><para><filename moreinfo="RefEntry">docbook.dtd(4)</filename> マニュアル・ページ</para>
</listitem></itemizedlist>
</sect3>
</sect2>
<sect2 id="HRDC.Intro.div.42">
<title>形式ではなく構造を考える</title>
<para>他のパブリッシング・システムに精通している場合は、情報を好きな形式にすることに慣れているはずです。DocBook を用いて設計するときは、形式ではなく構造と内容を考慮することが重要です。</para>
<para>記述するときは、ある種の情報をマークするのにタグを使います。マークするときには、<emphasis>どのような</emphasis>情報であるかを識別しますが、それをどうフォーマットすべきかは識別しません。</para>
<para>たとえば、次のようなマークアップ行を含む本のタイトルを参照するとします。</para>
<programlisting>&lt;CiteTitle>System Administrator's Reference Guide&lt;/CiteTitle>
</programlisting>
<para>ここでは、構造と内容が形式とは関係ないので、異なるシステムが同じ情報を異なる形式で使用できるようになります。たとえば、ヘルプは本のタイトルをイタリック体で表示します。しかし、システムによっては、イタリック体は使えず、本のタイトルにはアンダーラインが引かれます。</para>
</sect2>
<sect2 id="HRDC.Intro.div.43">
<title id="HRDC.Intro.mkr.25">実行時のヘルプ・ファイルの作成<indexterm><primary>作成</primary><secondary>実行時のヘルプ・ファイル</secondary></indexterm><indexterm>
<primary>実行時のファイル</primary><secondary>作成</secondary></indexterm><indexterm>
<primary>ファイル、実行時のヘルプ</primary><secondary>作成</secondary></indexterm></title>
<para><emphasis>実行時のヘルプ・ファイル</emphasis>を作成するには、記述したテキスト・ファイルを DocBook ソフトウェアで「コンパイル」しなければなりません。それは、ユーザがヘルプを要求したときにアクセスする実行時のヘルプ・ファイルとなります。実行時のファイルは、Semantic Delivery Language (SDL) 形式を使用します。この言語は、オンライン情報のデリバリ専用に設計された SGML 文書型定義に基づいています。
<indexterm><primary>Semantic Delivery Language (SDL)</primary></indexterm><indexterm>
<primary>SDL (Semantic Delivery Language)</primary></indexterm></para>
<para>ヘルプ・システムは、デスクトップの動作と、ヘルプ固有のファイルのデータ型を定義します。これにより、ヘルプ・ソース・ファイルのアイコンを選択し、ファイルを処理するメニュー・コマンドを選択することにより、デズクトップから簡単に実行時のファイルを作成できます。実行時のヘルプ・ファイルの識別には、
<indexterm><primary>ヘルプ</primary><secondary>アクション</secondary>
</indexterm><indexterm><primary>アクション、ヘルプ</primary></indexterm><indexterm><primary>ヘルプ</primary><secondary>データ型</secondary></indexterm><indexterm><primary>データ型、ヘルプ</primary></indexterm><filename>.sdl</filename> という拡張子を使用します。処理中にエラーが発生すると、エラー・ファイル (<symbol role="Variable">volume</symbol><filename>.log</filename>) に通知されます。</para>
<para>実行時のヘルプ・ファイルの作成の詳細については、<!--Original XRef content: '&ldquo;Creating Run-Time Help Files&rdquo; on page&numsp;89'--><xref role="SecTitleAndPageNum" linkend="HRDC.CrHV.mkr.2">を参照してください。デスクトップの動作とデータ型に関する一般的な情報については、<citetitle>共通デスクトップ環境 上級ユーザおよびシステム管理者ガイド</citetitle>を参照してください。</para>
</sect2>
<sect2 id="HRDC.Intro.div.44">
<title id="HRDC.Intro.mkr.26">ユーザを想定したヘルプのレビュー<indexterm>
<primary>レビュー</primary><secondary>ユーザを想定したヘルプ</secondary>
</indexterm><indexterm><primary>ユーザの</primary></indexterm><indexterm><primary>ユーザの視点、~からヘルプをみる</primary></indexterm><indexterm><primary>視点、ユーザを想定したヘルプ</primary></indexterm><indexterm><primary>&sigma;</primary></indexterm></title>
<para>設計中に、ヘルプを表示させて読者と同じように対話する必要が生じることがあります。その場合、デスクトップからヘルプ・ボリュームを表示させるには、実行時のヘルプ・ボリューム (<symbol role="variable">volume</symbol>.<filename>sdl</filename>) のアイコンをダブルクリックします。あるいは、<command>dthelpview</command> コマンドを使用して任意のトピックを表示することもできます。
<!--Original XRef content: 'Chapter&numsp;4, &ldquo;Processing and Displaying
a Help Volume'--><xref role="ChapNumAndTitle" linkend="HRDC.CrHV.mkr.1">で、両方の方法を説明します。</para>
<para>アプリケーション・ヘルプを書いていて、ヘルプ・システムがアプリケーションに統合されている場合は、アプリケーションを実行して、ユーザと同じ方法でヘルプを要求することにより、ヘルプを表示することができます。</para>
</sect2>
</sect1>
<sect1 id="HRDC.Intro.div.45">
<title id="HRDC.Intro.mkr.27">プログラマが行う作業<indexterm><primary>プログラマ、アプリケーション</primary><secondary>責任</secondary></indexterm><indexterm>
<primary>責任</primary><secondary>プログラマ</secondary></indexterm></title>
<para>プログラマは、ユーザがコンテキスト・ヘルプを要求したときに、そのときのアプリケーションの動作に関するヘルプ情報が表示されるように、アプリケーションにコードを追加します。</para>
<note>
<para id="HRDC.Intro.mkr.28"><filename>/usr/dt/share/examples/dthelp</filename> ディレクトリには、<command>dthelpdemo</command> というプログラム例のソースコードがあります。Motif アプリケーションへのヘルプ・ダイアログを追加する方法を示すものです。
<indexterm>
<primary>アプリケーション例、統合されたヘルプ</primary></indexterm></para>
</note>
<sect2 id="HRDC.Intro.div.46">
<title id="HRDC.Intro.mkr.29">ヘルプのアクセス方法</title>
<para>ユーザに役立つ情報を提供するには、次のことを考慮することが必要です。
</para>
<itemizedlist remap="Bullet1"><listitem><para>一般に起こりうる混乱状況は何か。このような状況で、有効なヘルプを提供すれば、ユーザは時間を浪費せずに済みます。
</para>
</listitem><listitem><para>後でも先でもなく今、ユーザがヘルプを必要としているのはなぜか。実行するステップが複数あり、ユーザがその最初のステップにない場合は、そのステップに固有のヘルプ情報へ分岐しなければなりません。こうしたほうが、各ステップごとに同じヘルプ情報を表示するよりずっと役立ちます。ユーザが最初のステップにある場合は、最初のステップの詳細な情報も、全ステップの概要もわかるようにしなければなりません。
</para>
</listitem><listitem><para>ユーザはコンテキスト・ヘルプを要求しているのか、それとも単にヘルプ情報をブラウズしているだけなのか。コンテキスト・ヘルプを要求している場合は、現在行われている作業に関連した情報を提供しなければなりません。
</para>
</listitem></itemizedlist>
</sect2>
<sect2 id="HRDC.Intro.div.47">
<title id="HRDC.Intro.mkr.30">ヘルプの設計者との協力</title>
<para>オンライン・ヘルプの設計者は、各コンテキスト・トピックを表示する方法を知りたがっており、プログラマは各コンテキスト・トピックの内容を知りたがっているので、プログラマは設計者と密に連絡をとることが必要です。双方の協力がないと、情報は不適切で、曖昧で、誤りのあるものとなります。
</para>
<para>こうした協力により、プログラマはアプリケーションを理解し、設計者は情報をユーザへどのように伝えたらよいかを理解できます。
</para>
</sect2>
<sect2 id="HRDC.Intro.div.48">
<title>ヘルプのエントリ・ポイントの識別</title>
<para>ヘルプの<emphasis>エントリ・ポイント</emphasis>を設定することにより、アプリケーションでオンライン・ヘルプが使えるようになります。エントリ・ポイントは、アプリケーションで定義され、特定のヘルプ・トピックに対応付けられています。ユーザが、[ヘルプ]キー、[ヘルプ]ボタン、[ヘルプ]メニューのいずれの方法によってヘルプを要求しても、エントリ・ポイントが表示されます。たとえば、[ヘルプ]ボタンを備えた印刷ダイアログ・ボックスを想定します。設計者は、ダイアログ・ボックスの内容を説明するヘルプ・トピックを記述し、トピックのIDを提供します。そこで、ユーザはコールバック・ルーチンを使用して、[ヘルプ]ボタンでヘルプ・トピックのIDを指定できます。
</para>
</sect2>
<sect2 id="HRDC.Intro.div.49">
<title id="HRDC.Intro.mkr.31">ヘルプ・ダイアログの作成と管理</title>
<para>ヘルプ・システムのアプリケーション・プログラム・インタフェースは、特に、Motif アプリケーションで使用するように設計されています。特に、このヘルプでは、次のつの新しいウィジェット・クラスおよびこれらを処理するために便利な機能を加えたものを提供することにより、Motif ウィジェット・セットを拡張しています。
</para>
<itemizedlist remap="Bullet1"><listitem><para><emphasis>一般ヘルプ・ダイアログ</emphasis>メニュー・バー、トピック・ツリー、ヘルプ・トピック表示領域を備えたヘルプ・ウィンドウを提供します。
</para>
</listitem><listitem><para><emphasis>簡易ヘルプ・ダイアログ</emphasis>トピック表示領域といくつかのダイアログ・ボタンを備えた簡素なヘルプ・ウィンドウを提供します。
</para>
</listitem></itemizedlist>
<para>アプリケーションでは、上記のいずれか、または両方を使用できます。アプリケーションを(ヘルプ・ライブラリとともに)コンパイルすると、ヘルプ・ウィンドウがアプリケーションの一部になります。
</para>
<para><!--Original XRef content: 'Chapter&numsp;9, &ldquo;Creating and Managing Help Dialog Boxes'--><xref role="ChapNumAndTitle" linkend="HRDC.CrDia.mkr.1">で、一般ヘルプ・ダイアログ・ボックスと簡易ヘルプ・ダイアログ・ボックスを説明します。
</para>
</sect2>
<sect2 id="HRDC.Intro.div.50">
<title>パッケージとヘルプの割り当て</title>
<para>プロダクト・パッケージには実行時のヘルプ・ファイル (<symbol role="variable">volume</symbol>.<filename>sdl</filename>) とグラフィック・ファイルが入っています。また、フロントパネルのヘルプ・ビューアでボリュームを表示できるようにするヘルプ・ファミリ・ファイルも作成できます。
</para>
<para>ヘルプ・ボリュームが実行リンクを使用する場合、適切な実行リンク・リソースをアプリケーションのデフォルト・リソース・ファイルに入れるよう設計者と協力しなければなりません。
<!--Original XRef content: 'Chapter&numsp;13, &ldquo;Preparing an Installation Package'--><xref role="ChapNumAndTitle" linkend="HRDC.Inst.mkr.1">で、アプリケーションに、どのヘルプ・ファイルが割り当てられるかを説明します。
</para>
</sect2>
</sect1>
</chapter>
<!--fickle 1.14 mif-to-docbook 1.7 01/02/96 16:48:20-->
<?Pub *0000050603>

View File

@@ -0,0 +1,966 @@
<!-- $XConsortium: ch02.sgm /main/16 1996/10/22 14:42:26 cdedoc $ -->
<!-- (c) Copyright 1995 Digital Equipment Corporation. -->
<!-- (c) Copyright 1995 Hewlett-Packard Company. -->
<!-- (c) Copyright 1995 International Business Machines Corp. -->
<!-- (c) Copyright 1995 Sun Microsystems, Inc. -->
<!-- (c) Copyright 1995 Novell, Inc. -->
<!-- (c) Copyright 1995 FUJITSU LIMITED. -->
<!-- (c) Copyright 1995 Hitachi. -->
<chapter id="HRDC.OrgH.div.1">
<title id="HRDC.OrgH.mkr.1">ヘルプ・ボリュームの構成および記述</title>
<para>この章では、ヘルプ・ソース・ファイルの構成とコンポーネントについて説明します。また、ヘルプ・ソース・ファイルを処理して、オンライン・ヘルプ・ボリュームを作成する方法についての手順の例を示します。</para>
<sect1 id="HRDC.OrgH.div.2">
<title id="HRDC.OrgH.mkr.2">ヘルプ・ボリュームのコンポーネント</title>
<para>ヘルプ・ボリュームには、トップレベル・ボリューム・トピックPart 要素に含まれる、メタ情報DocInfo 要素に含まれる)、ブック・コンポーネント(章、セクション、リスト、および表のような)、索引、および用語集という主要なタイプのコンポーネントがあります。</para>
<sect2 id="HRDC.OrgH.div.3">
<title>トップレベル要素: Part</title>
<para><emphasis>Part</emphasis> は、ヘルプ・ボリュームの構造におけるトップレベルの要素です。他のすべてのコンポーネントは、階層構造において、Part の下位要素です。
</para>
<para>Part の下位の階層構造を、複数の Sect1 を含む複数の Chapter、複数の Sect2 を含む複数の Sect1、複数の Sect3 を含む Sect2、などのように、数階層にすることも可能です。しかし、階層内でユーザが迷わないようにするために、階層をできる限り浅くしておくべきです。
</para>
<para>Part は、コンポーネントとして、オプションの DocInfo、必須の Title、オプションの TitleAbbrev、オプションの PartIntro、およびひとつまたは複数の Chapter のような他のブック・コンポーネントを、この順序で含むことが可能です。
</para>
<para>Part は、共通の属性およびラベル属性をもちます。</para>
</sect2>
<sect2 id="HRDC.OrgH.div.4">
<title>トピックとサブトピック</title>
<para>トピックとサブトピックは、Part の下に階層を形成します。通常、最初のレベルのトピックは、Chapter 要素を用いて、章に分割されます。章の内部では、Sect1 のサブトピックは Sect2 というタグ、Sect2 のサブトピックは Sect3 というタグ、というように、トピックはセクションとして構成されます。
</para>
<para><xref role="CodeOrFigureOrTable" linkend="HRDC.OrgH.mkr.3">では、つの章がある単純な階層を示しています。各章には、第レベルのセクションがいくつかあります。番目の章には第レベルのセクションが2つ追加されています。
</para>
<figure>
<title id="HRDC.OrgH.mkr.3">ヘルプ・ボリュームのトピック構成</title>
<programlisting>Part
DocInfo
Title
Chapter
Sect1
Sect1
Sect1
Chapter
Sect1
Sect2
Sect3
Sect2
Sect1
Sect1
Sect2
Sect2
Sect3</programlisting>
</figure>
</sect2>
<sect2 id="HRDC.OrgH.div.5">
<title>エンティティ</title>
<para>設計者定義の<emphasis>エンティティ</emphasis>は、文字列またはファイル名を指定します。<emphasis>エンティティ宣言</emphasis>は、エンティティ名とエンティティが表す文字列またはファイルを定義します。
</para>
<para>エンティティは、次の場合に有効です。</para>
<itemizedlist><listitem><para><emphasis>テキストの共通の文字列を参照する</emphasis>テキストが変更されたり、繰り返し入力したくないような場合に便利です。テキストを挿入したい場所では、エンティティ名を参照してください。
</para>
</listitem><listitem><para><emphasis>外部ファイルを参照する。</emphasis>
グラフィック・ファイルにアクセスするにはエンティティが必要です。&lt;Graphic> 要素には Entityref 属性があり、これがグラフィック・イメージ・ファイルを参照します。
</para>
</listitem></itemizedlist>
<para>ヘルプ・ボリューム内の他のマークアップの前にすべてのエンティティの宣言を入力しなければなりません。定義済みのエンティティを入れるには、<emphasis>エンティティの参照</emphasis>を使用します。</para>
<para>エンティティの参照は、ヘルプ・ボリューム内であれば、どこでも使用できます。 DocBook ソフトウェアでヘルプ・ボリュームを処理する場合、各エンティティの参照は、そのエンティティが指すテキストまたはファイルで置換されます。
<xref role="SecTitleAndPageNum" linkend="HRDC.OrgH.mkr.22">では、エンティティの定義方法と使い方について説明しています。
</para>
</sect2>
<sect2 id="HRDC.OrgH.div.6">
<title>メタ情報</title>
<para><emphasis>メタ情報</emphasis>は、<emphasis>ユーザの情報についての情報</emphasis>です。
</para>
<para>DocBook マークアップでは、ヘルプ・ボリュームに関するメタ情報は、DocInfo 要素に含まれています。
</para>
<para>DocInfo は、次の要素を次に示す順序で含むことが可能です。
</para>
<itemizedlist><listitem><para>Title (必須)</para>
</listitem><listitem><para>TitleAbbrev (任意)</para>
</listitem><listitem><para>Subtitle (任意)</para>
</listitem><listitem><para>ひとつまたは複数の AuthorGroups (必須)</para>
</listitem><listitem><para>任意の数の Abstracts (任意、ボリュームの内容に関する簡潔な記述</para>
</listitem><listitem><para>RevHistory (任意)</para>
</listitem><listitem><para>任意の数の LegalNotices (任意、登録商標、著作権などに関する情報の提供)</para>
</listitem></itemizedlist>
<para>ヘルプ・システムは、DocInfo のメタ情報を使用して、ヘルプ・ボリュームのタイトルとその著作権情報を表示します。要約の記述は、フロントパネルのデスクトップ・ヘルプ・ビューアによって表示されます。ヘルプ・ボリュームを表示できる他のアプリケーションもまたこの情報を使用できます。
</para>
<para><xref role="SecTitleAndPageNum" linkend="HRDC.OrgH.mkr.15">は、メタ情報セクションの作成方法を示しています。
</para>
</sect2>
<sect2 id="HRDC.OrgH.div.7">
<title>用語集</title>
<para>用語集には、ヘルプ・ボリュームで使用されている用語に対する定義が入っています。用語が、GlossTerm 要素を使用して入力される場合、自動的にリンクになり、選択されると、その用語に関する用語エントリを表示します。
</para>
</sect2>
</sect1>
<sect1 id="HRDC.OrgH.div.8">
<title id="HRDC.OrgH.mkr.4">一般的なマークアップの指針</title>
<para>オンライン・ヘルプは通常のテキスト・ファイルで記述されています。特殊コード、または<emphasis>タグ</emphasis>を使用して、情報内の<emphasis>要素</emphasis>にマークを付けます。タグは、DocBook と呼ばれるマークアップ言語を形成します。
</para>
<para>標準のテキスト・エディタを使用する場合、DocBook マークアップが入力されます。エディタがマクロ・パッケージを提供している場合、タグはコマンド・キーを使用すると、保存および挿入できます。DocBook マークアップは、構造化エディタを使用して生成することもできます。
(<xref role="SecTitleAndPageNum" linkend="HRDC.Intro.mkr.24">を参照してください)。</para>
<para>DocBook マークアップ言語は、章、セクション、サブセクションなどのハイレベル要素、段落、リスト、および表などのブロック単位の要素、強調された語、シンボルなどのロウレベルなインライン要素を定義する要素の階層を定義します。
</para>
<sect2 id="HRDC.OrgH.div.9">
<title id="HRDC.OrgH.mkr.5">ソース・ファイル内のマークアップ</title>
<para>ほとんどの要素のマークアップは、開始タグと終了タグで構成されます。開始タグは、三角括弧 (&lt; と >) の間に要素名を入れて入力します。終了タグも同様ですが、要素名の先頭に / (スラッシュ)が付きます。DocBook マークアップのタグでは、大文字・小文字の区別はありません。
</para>
<programlisting>&lt;Element attribute name="attribute value"> ... text ... &lt;/Element>
</programlisting>
<para>たとえば、本のタイトルの初めと終わりをマークするには、次のようにマークアップを使用します。
</para>
<programlisting>&lt;Title id="GSNW">Geographical Survey of Northern Wisconsin&lt;/Title>
</programlisting>
<para>ここで &lt;Title> は開始タグ、&lt;/Title> は終了タグ、GSNW は Title 要素のID属性の値です。要素の複数の属性に値を指定する場合は、式 <symbol>属性名</symbol>="<symbol>属性値</symbol>" をスペースで区切ります。
</para>
</sect2>
</sect1>
<sect1 id="HRDC.OrgH.div.13">
<title id="HRDC.OrgH.mkr.7">ヘルプ・ボリュームの例</title>
<para>次の標準的なマークアップは、入力に使用されるヘルプ・ボリュームとタグの重要な要素の例を示しています。インデントは、要素の階層関係を明示するためです。したがって、実際に記述するヘルプ・ファイルで、インデントを行う必要はありません。
</para>
<programlisting>DocType
Part
DocInfo
Title
AuthorGroup
Abstract
LegalNotice
Title
PartIntro
Chapter
Title
Sect1
Title
Para
Para
Sect2
Title
Para
Sect3
Title
Para
Para
Sect2
Title
Para
Chapter
Title
Sect1
Title
Para
Para
Sect2
Title
Para
Sect2
Title
Para
Glossary
</programlisting>
</sect1>
<sect1 id="HRDC.OrgH.div.14">
<title id="HRDC.OrgH.mkr.8">ヘルプ・ソース・ファイル</title>
<para>オンライン・ヘルプは、通常のテキスト・ファイルで記述されます。DocBook ソフトウェアで、これらのファイルを処理またはコンパイルし、ヘルプ・システムによって読み込むことができる実行時のヘルプ・ファイルを作成します。
</para>
<sect2 id="HRDC.OrgH.div.15">
<title>volume.sgm ファイルの作成</title>
<para>DocBook には、<symbol>volume</symbol><filename>.sgm</filename> という名前のプライマリ・コントロール・ファイルが必要です。ここで、<symbol role="Variable">volume</symbol> には、選択したボリューム名が入ります。
</para>
<para><symbol role="Variable">volume</symbol>は、必ず、一意かつ有意なものにしてください。<symbol role="Variable">volume</symbol> が、一般的すぎる場合は、他のユーザが作成した別のボリュームと重複してしまう可能性があります。アプリケーションのヘルプを記述する場合、アプリケーションのクラス名を使用することを推奨します。
</para>
<sect3 id="HRDC.OrgH.div.16">
<title>複数のソース・ファイル</title>
<para><symbol>volume</symbol><filename>.sgm</filename> には、エンティティの宣言とヘルプ・ボリュームを作成するファイルへのエンティティの参照が記述されています。DocBook は、入力として単一の <symbol role="Variable">volume</symbol><filename>.sgm</filename> ファイルを必要としますが、作業を複数のソース・ファイルに分割することができます。追加のファイルは、<emphasis>ファイル・エンティティ</emphasis>を使用して、<symbol role="Variable">volume</symbol><filename>.sgm</filename> にまとめられます。ファイル・エンティティは、他のファイルへのポインタのようなものです。そのファイルは、実際には、<symbol>volume</symbol><filename>.sgm</filename> ファイル内でエンティティの名前が表示されたところであれば、どこでも挿入されます。参照されるファイルもまた、別のファイルを参照するエンティティを含むことができます。
</para>
</sect3>
<sect3 id="HRDC.OrgH.div.17">
<title>例</title>
<para>ヘルプ・ボリュームにはつの章があり、各章は独立したファイルであるとします。ファイルには、HomeTopic, Metainfo, TOC, Tasks, Reference, および Glossary があります。ヘルプ・ボリュームの <symbol>volume</symbol><filename>.sgm</filename> ファイルには、6つのファイルそれぞれに対するファイル・エントリと、ファイルの処理を DocBook ソフトウェアに指示するエンティティ参照リストが含まれています。
</para>
<programlisting>...
&lt;!entity HomeTopic FILE &ldquo;HomeTopic&rdquo;>
&lt;!entity MetaInformation FILE &ldquo;Metainfo&rdquo;>
&lt;!entity TableOfContents FILE &ldquo;TOC&rdquo;>
&lt;!entity Tasks FILE &ldquo;Tasks&rdquo;>
&lt;!entity Reference FILE &ldquo;Reference&rdquo;>
&lt;!entity Glossary FILE &ldquo;Glossary&rdquo;>
...
&amp;HomeTopic;
&amp;MetaInformation;
&amp;TableOfContents;
&amp;Tasks;
&amp;Reference;
&amp;Glossary;
</programlisting>
<para>実行中の DocBook の詳細は、
<xref role="SecTitleAndPageNum" linkend="HRDC.CrHV.mkr.3">で説明しています。
</para>
</sect3>
</sect2>
</sect1>
<sect1 id="HRDC.OrgH.div.18">
<title id="HRDC.OrgH.mkr.9">ファイル・マネージャのヘルプ・ファイル</title>
<para>ファイル・マネージャは、ヘルプ・ファイルを疑問符付きのファイル・アイコンで表現します。<xref role="PageNum" linkend="HRDC.OrgH.mkr.10">の<xref role="CodeOrFigureOrTable" linkend="HRDC.OrgH.mkr.10">には、ひとつのソース・ファイル (<filename>.sgm</filename> 拡張子のファイル) およびひとつの実行時ファイル (<filename>.sdl</filename> 拡張子のファイル) があります。マークアップ・ファイルをダブルクリックすると、標準エディタが編集用のファイルを開きます。ファイル (<filename>.sdl</filename> 拡張子のファイル) をダブルクリックすると、ヘルプ・ビューアを使用して実行時のファイルが表示されます。
</para>
<figure>
<title id="HRDC.OrgH.mkr.10">ヘルプ・ファイルによるファイル・マネージャ表示</title>
<graphic id="HRDC.OrgH.grph.2" entityref="HRDC.OrgH.fig.2"></graphic>
</figure>
<para>実行時のヘルプ・ボリュームを作成するには、ファイル・マネージャにある <filename>.sgm</filename> ファイルを最初に選択してください。次に、ファイル・マネージャの[選択]メニューから[コンパイル]を選択してください。
</para>
<sect2 id="HRDC.OrgH.div.19">
<title>関連項目</title>
<itemizedlist remap="Bullet1"><listitem><para><filename moreinfo="RefEntry">dthelpaction(4)</filename> マニュアル・ページ</para>
</listitem></itemizedlist>
</sect2>
</sect1>
<sect1 id="HRDC.OrgH.div.20">
<title id="HRDC.OrgH.mkr.11">新規にヘルプ・ボリュームを記述する例</title>
<para>通常は、<filename>help</filename> ディレクトリの中にヘルプ・ファイルを入れます。この例では、スタンドアロンのヘルプ・ボリュームの作成および表示方法について示しています。(スタンドアロンのボリュームの場合、アプリケーションとの対話はありません。)
</para>
<para>ヘルプ・ボリュームの作成および処理を行うには、次の手順にしたがいます。
</para>
<orderedlist><listitem><para>ヘルプ・ファイル用のソース・ディレクトリを作成します。</para>
</listitem><listitem><para>マスタ DocBook ファイルを作成します。</para>
</listitem><listitem><para>実行時ヘルプ・ファイルを作成します。</para>
</listitem><listitem><para>ヘルプ・ボリュームを表示します。</para>
</listitem></orderedlist>
<para>各タスクについては、次からこの節で説明します。テキスト・ファイルで使用されているマークアップ言語については、この章で後述します。DocBook のマークアップについては、<xref role="ChapNumAndTitle" linkend="HRDC.WrTop.mkr.1">および<citetitle>共通デスクトップ環境 DocBook 文書型定義ガイド</citetitle>でさらに詳しく説明しています。</para>
<sect2 id="HRDC.OrgH.div.21">
<title>ソース・ディレクトリの作成</title>
<orderedlist><listitem><para>ヘルプ・ファイルの作成および処理を行う <filename>helpfiles</filename> という名前のディレクトリを作成します。
</para>
</listitem><listitem><para>作成したばかりのディレクトリに <filename>Commands.sgm</filename> という名前のテキスト・ファイルを作成します。
</para>
<para>この例では、すべての情報は単一のファイルに格納されます。通常、ヘルプを記述しているシステムやアプリケーションについて完全に説明するためには、複数のファイルを使用します。
</para>
<para><filename>Commands.sgm</filename> ファイルには、テキストと要素タグを格納します。&lt; と > (三角括弧) 内の要素タグは、情報の構造を示します。</para>
</listitem><listitem><para><filename>Commands.sgm</filename> ファイルに、次のマークアップ・テキストを入力します。</para>
<programlisting>
&lt;Chapter>
&lt;Title id="CommandSummary-id>Command Summary&lt;/Title>
&lt;Indexterm>&lt;Primary>commands&lt;Primary>&lt;/Indexterm>
&lt;Para>Your&amp;product; is capable of the following operations:&lt;/Para>
&lt;ItemizedList>
&lt;ListItem>&lt;Para>&lt;Link Linkend="ChannelChange-id">ChannelChange&lt;/Link>&lt;/Para>&lt;/ListItem>
&lt;ListItem>&lt;Para>&lt;Link Linkend="VolumeUp-id"> VolumeUp &lt;/Link> &lt;/Para>&lt;/ListItem>
&lt;ListItem>&lt;Para>&lt;Link Linkend="VolumeDown-id"> VolumeDown &lt;/Link>&lt;/Para>&lt;/ListItem>
&lt;ListItem>&lt;Para>&lt;Link Linkend="VolumeMute-id"> VolumeMute &lt;/Link>&lt;/Para>&lt;/ListItem>
&lt;/ItemizedList>
&lt;Para>Choose one of the hyperlinks (underlined phrases)
to find out how to perform that operation.&lt;/Para>
&lt;Sect1 id="ChannelChange-s">
&lt;Title id="ChannelChange-t">Changing the Channel&lt;/Title>
&lt;Indexterm>&lt;Primary>channel&lt;Secondary>changing&lt;/Secondary>&lt;Primary>&lt;/Indexterm>
&lt;Para>Speak the command:
&lt;Programlisting> channel&lt;/Programlisting>
followed by a number from &lt;Command>one&lt;/Command>to &lt;Command>ninety-nine&lt;/Command>.&lt;/Para>
&lt;/Sect1>
&lt;Sect1 id="VolumeUp-s">
&lt;Title id="VolumeUp-t">Turning Up the Volume&lt;/Title>
&lt;Indexterm>&lt;Primary>volume&lt;Secondary>changing&lt;/Secondary>&lt;/Primary>&lt;/Indexterm>
&lt;Para>Speak the command:
&lt;Programlisting>volume up&lt;/Programlisting>&lt;/Para>
&lt;Para>For additional volume, speak the command:
&lt;Programlisting>more&lt;/Programlisting>&lt;/para>
&lt;Para>(See also &lt;Link Linkend="VolumeDown-id">VolumeDown&lt;/Link>)&lt;/Para>
&lt;/Sect1>
&lt;Sect1 id="VolumeDown-s">
&lt;Title id="VolumeDown-t">Turning Down the Volume&lt;/Title>
&lt;Indexterm>&lt;Primary>volume&lt;Secondary>changing&lt;/Secondary>&lt;/Primary>&lt;/Indexterm>
&lt;Para>Speak the command:
&lt;Programlisting>volume down&lt;/Programlisting>&lt;/Para>
&lt;Para>To reduce the volume further, speak the command:
&lt;Programlisting>more&lt;/Programlisting>&lt;/Para>
&lt;Para>(See also &lt;Link Linkend="VolumeUp-id"> VolumeUp &lt;/Link> and &lt;Link Linkend="VolumeMute-id">VolumeMute&lt;/Link>)&lt;/Para>
&lt;/Sect1>
&lt;Sect1 id="VolumeMute-s">
&lt;Title id="VolumeMute-t">Turning Off the Sound&lt;/Title>
&lt;Indexterm>&lt;Primary>volume&lt;Secondary>changing&lt;/Secondary>&lt;/Primary>&lt;/Indexterm>
&lt;Indexterm>&lt;Primary>sound&lt;Secondary>on/off&lt;/Secondary>&lt;/Primary>&lt;/Indexterm>
&lt;Para>Speak the command:
&lt;Programlisting>sound off&lt;/Programlisting>&lt;/Para>
&lt;Para>To restore the sound, speak the command:
&lt;Programlisting>sound on&lt;/Programlisting>&lt;/Para>
&lt;Para>(See also &lt;Link Linkend="VolumeDown-id">VolumeDown&lt;/Link> and &lt;Link Linkend="VolumeUp-id">VolumeUp&lt;/Link>&lt;/Para>
&lt;/Sect1>
&lt;/Chapter>
</programlisting>
</listitem><listitem><para>情報にタイトルを付け、著作権情報とオンライン・ヘルプに関する他の情報を提供するテキスト・ファイルを作成します。
</para>
<para>この例では、<filename>Commands.sgm</filename> ファイルと同じディレクトリにある <filename>Metainfo.sgm</filename> という名前のファイルに次のテキストが格納されます。
</para>
<programlisting>&lt;DocInfo>
&lt;Title> Using the &amp;product;&lt;/Title>
&lt;AuthorGroup>&lt;Author>Jim Jonas&lt;/Author>
&lt;/AuthorGroup>
&lt;Abstract> Help for Using the &amp;product;.
&lt;/Abstract>
&lt;LegalNotice>
&lt;BlockQuote>
&lt;para>&amp;copy; 1995 Voice Activation Company.
All rights reserved.&lt;/para>
&lt;/BlockQuote>
&lt;/LegalNotice>
&lt;/DocInfo>
</programlisting>
</listitem></orderedlist>
</sect2>
<sect2 id="HRDC.OrgH.div.23">
<title>マスタ DocBook ファイルの作成</title>
<orderedlist><listitem><para>名前が <symbol role="Variable">volume</symbol><filename>.sgm</filename> の形式になるテキスト・ファイルを作成します。この例では、<filename>voiceact.sgm</filename> というファイル名になっています。</para>
</listitem><listitem><para><filename>voiceact.sgm</filename> ファイルで、<filename>Commands.sgm</filename> ファイルと <filename>Metainfo.sgm</filename> ファイルの名前とエンティティ名を関連付ける<emphasis>エンティティ</emphasis>を定義します。また、<filename>Commands.sgm</filename> ファイルと <filename>Metainfo.sgm</filename> ファイルで、(直接的または間接的に)使用されているエンティティも定義します。最後に、それぞれのエンティティ名で、<filename>Commands.sgm</filename> ファイルと <filename>Metainfo.sgm</filename> を参照します。</para>
</listitem></orderedlist>
<para>この例では、<filename>voiceact.sgm</filename> の内容は、次のようになります。<literal>&lt;!--&hellip;--></literal>内の要素はコメントなので、無視されます。
</para>
<programlisting>&lt;!-- Declare an entity for each of the source text files. -->
&lt;!entity MetaInformation FILE &ldquo;Metainfo&rdquo;>
&lt;!entity Commands FILE &ldquo;Commands&rdquo;>
&lt;!-- Define an entity that names the product and includes
the trademark symbol (&amp;tm;). -->
&lt;!entity product &ldquo;VoAc&amp;tm; Voice-Activated Remote Control&rdquo;>
&lt;!-- Include the text files. -->
&lt;Part>
&amp;MetaInformation;
&amp;Commands;
&lt;/Part></programlisting>
</sect2>
<sect2 id="hrdc.orgh.div.25">
<title>実行時のヘルプ・ファイルの作成</title>
<orderedlist><listitem><para>端末エミュレータで、次のコマンドを入力し、<filename>/usr/dt/bin</filename> ディレクトリが、検索パスに含まれていることを確認してください。
</para>
<para><command>echo $PATH</command></para>
<para>ディレクトリが検索パスに含まれていない場合には、環境変数PATHに追加してください。やり方がわからない場合には、システムのドキュメンテーションを参照するか、あるいはシステム管理者に問い合わせてください。
</para>
</listitem><listitem><para>ファイル・マネージャを開き、<filename>helpfiles</filename> ディレクトリに移動します。<filename>voiceact.sgm</filename> ファイルのアイコンを選択し、ファイル・マネージャの[選択]メニューから[コンパイル]を選択します。
</para>
<para>この手順により、実行時のバージョンのオンライン・ヘルプ・ボリューム (<filename>voiceact.sdl</filename>) を作成する DocBook ソフトウェアが実行されます。ステータスとエラー・メッセージが新規ファイルに格納され、<symbol>volume</symbol><filename>.log</filename> という形式の名前付けられます。</para>
</listitem><listitem><para><filename>voiceact.log</filename> ファイルを開き、エラーもなくファイルが処理されていることを確認します。エラーが発生している場合、必要に応じてテキスト・ファイルの編集および名前の変更を行って修正します。
</para>
</listitem></orderedlist>
<note>
<para>端末エミュレータで、DocBook を手動で実行することもできます。
</para>
<para>そのためには、次のコマンドを実行します。</para>
<para><command>dtdocbook voiceact.sgm</command></para>
</note>
</sect2>
<sect2 id="hrdc.orgh.div.26">
<title>ヘルプ・ボリュームの表示</title>
<para><filename>helpfiles</filename> ディレクトリから、<filename>voiceact.sdl</filename> ファイルのアイコンをダブルクリックします。</para>
<para>これにより、デスクトップのヘルプ・ビューアを使用してヘルプ・ボリュームが表示されます。情報をスクロールしたり、ハイパーリンクを選択して、関連情報へジャンプできます。
</para>
<note>
<para>端末エミュレータで、ヘルプ・ビューアを手動で実行することもできます。
</para>
<para>そのためには、次のコマンドを実行します。新しいヘルプ・ボリュームが表示されます。
</para>
<para><command>dthelpview -h voiceact.sdl</command></para>
</note>
<sect3 id="hrdc.orgh.div.27">
<title>関連項目</title>
<itemizedlist>
<listitem><para><xref role="PageNum" linkend="hrdc.crhv.mkr.1">の
<xref role="ChapNumAndTitle" linkend="hrdc.crhv.mkr.1"></para></listitem>
<listitem><para><xref role="PageNum" linkend="hrdc.cmds.mkr.1">の
<xref role="ChapNumAndTitle" linkend="hrdc.cmds.mkr.1"></para></listitem>
</itemizedlist>
</sect3>
</sect2>
</sect1>
<sect1 id="HRDC.OrgH.div.28">
<title id="HRDC.OrgH.mkr.12">トピック階層の作成</title>
<para>ヘルプ・ボリューム内のトピック階層は、<emphasis>Part</emphasis> から始まります。各ヘルプ・ボリュームには、Part が必ずひとつなければなりません。Part の下にある第1レベルのサブトピックは、&lt;Chapter> タグを付けて入力しなければなりません。</para>
<para>サブトピックのレベルを追加する場合は、&lt;Sect1>、&lt;Sect2>、&lt;Sect3>、&lt;Sect4>、および &lt;Sect5> のように入力します。DocBook のマークアップ言語は、つのトピック・レベルをサポートしています。しかし、第3または第4レベルよりも下にある情報は、多くの読者にとってみつけにくいものです。
</para>
<para>ヘルプ・ボリュームが表示されたら、ヘルプ・ウィンドウはそのトピック・ツリーにトピックのリストを表示します。&lt;Chapter>、&lt;Sect1>、&lt;Sect2>、&lt;Sect3>、&lt;Sect4>、または &lt;Sect5> がタグが入力されているトピックは、トピック・ツリーに自動的に表示されます。トピックをブラウズし表示するには、この方法が簡単です。
</para>
<para>トピック内から他の関連情報を表示するには、ハイパーリンクを作成します。そのためには、それぞれのトピックに固有のIDを割り当て、ハイパーリンクが、ヘルプ情報内のどこでも特定のIDを参照できるようにします。
</para>
<sect2 id="HRDC.OrgH.div.29">
<title>例</title>
<para>このサンプルに一致する階層を作成したとします。
</para>
<programlisting>Tutorial for New Users
Module 1: Getting Started
Module 2: Creating Your First Report
Module 3: Printing the Report
Module 4: Saving Your Work and Quitting
Task Reference
Starting and Stopping
To Start the Program
To Quit the Program
Creating Reports
To Create a Detailed Report
To Create a Summary Report
Concepts for Advanced Users
Using Report Hot Links
Sharing Reports within a Workgroup
Reference
Command Summary
Report Attributes Summary</programlisting>
<para>その場合、ヘルプ・ボリュームのマークアップの概要は、次のようになります。各トピックの本文や各トピックのIDは省略します。
</para>
<programlisting>&lt;Part>
&lt;title>Welcome to ReportMaster&lt;/title>
&lt;chapter>
&lt;title>Tutorial for New Users&lt;/title>
overview of chapter topic
&lt;sect1>
&lt;title>Module 1: Getting Started&lt;/title>
body of topic
&lt;/sect1>
&lt;sect1>
&lt;title>Module 2: Creating Your First Report&lt;/title>
body of topic
&lt;/sect1>
&lt;sect1>
&lt;title>Module 3: Printing the Report&lt;/title>
body of topic
&lt;/sect1>
&lt;sect1>
&lt;title>Module 4: Saving Your Work and Quitting&lt;/title>
body of topic
&lt;/sect1>
&lt;/chapter>
&lt;chapter>
&lt;title>Task Reference&lt;/title>
overview of chapter topic
&lt;sect1>
&lt;title>Starting and Stopping&lt;/title>
body of topic
&lt;sect2>
&lt;title>To Start the Program&lt;/title>
body of topic
&lt;/sect2>
&lt;sect2>
&lt;title>To Quit the Program&lt;/title>
body of topic
&lt;/sect2>
&lt;sect1>
&lt;title>Creating Reports&lt;/title>
body of topic
&lt;sect2>
&lt;title>To Create a Detailed Report&lt;/title>
body of topic
&lt;/sect2>
&lt;sect2>
&lt;title>To Create a Summary Report&lt;/title>
body of topic
&lt;/sect2>
&lt;/sect1>
&lt;/chapter>
&lt;chapter>
&lt;title>Concepts for Advanced Users&lt;/title>
overview of chapter topic
&lt;sect1>
&lt;title>Using Report Hot Links&lt;/title>
body of topic
&lt;/sect1>
&lt;sect1>
&lt;title>Sharing Reports within a Workgroup&lt;/title>
body of topic
&lt;/sect1>
&lt;/chapter>
&lt;chapter>
&lt;title>Reference&lt;/title>
overview of chapter topic
&lt;sect1>
&lt;title>Command Summary&lt;/title>
body of topic
&lt;/sect1>
&lt;sect1>
&lt;title>Report Attributes Summary&lt;/title>
body of topic
&lt;/sect1>
&lt;/chapter>
&lt;/part></programlisting>
<para>各トピックの本体およびトピックのIDは、示していません。空白およびインデントは、読みやすくするためであり、実効性はありません。
</para>
<sect3 id="HRDC.OrgH.div.30">
<title>関連項目</title>
<itemizedlist><listitem><para><xref role="SecTitleAndPageNum" linkend="HRDC.OrgH.mkr.18">では、トピックへのIDの割り当てについて説明しています。
</para>
</listitem><listitem><para><xref role="SecTitleAndPageNum" linkend="HRDC.WrTop.mkr.14">では、ハイパーリンクの作成方法について説明しています。
</para>
</listitem></itemizedlist>
</sect3>
</sect2>
<sect2 id="hrdc.orgh.div.31" role="Procedure">
<title id="hrdc.orgh.mkr.13">パートを作成するには</title>
<itemizedlist><listitem><para>次のように Part 要素を使用します。</para>
</listitem></itemizedlist>
<programlisting>&lt;Part>
&lt;DocInfo>
&lt;Title>Volume Title&lt;/Title>
&lt;AuthorGroup>
&lt;Author>author's name here&lt;/Author>
&lt;/AuthorGroup>
&lt;Abstract>
&lt;Para>abstract here&lt;/Para>
&lt;/Abstract>
&lt;LegalNotice>
&lt;BlockQuote>
&lt;Para>copyrights etc. &lt;/Para>
&lt;/BlockQuote>
&lt;/LegalNotice>
&lt;/DocInfo>
&lt;Title>Volume Title&lt;/Title>
&lt;/PartIntro>&lt;Para>This is the home topic.&lt;/Para>&lt;/PartIntro>
&lt;Chapter Id="chapid">
&lt;Title>This Chapter&lt;/Title>
&lt;Sect1 Id="sect1id">
&lt;Title>Sect1 Heading&lt;/Title>
&lt;Sect2 Id="sect2id">
&lt;Title>Sect2 Heading&lt;/Title>
...
...
...
&lt;/sect2>
&lt;/sect1>
&lt;/chapter>
&lt;/Part>
</programlisting>
<para>パートには、オプションの DocInfo、必須の Title、オプションの TitleAbbrev、オプションの PartIntro、および Chapter または Section のような他のブック・コンポーネントをひとつまたはそれ以上、この順序で、含めることが可能です。
</para>
<para>DocInfo が存在する場合、ヘルプ・ボリュームの Title は、回現われることに注意してください。ひとつは、DocInfo 中であり、DocInfo に続く最初の要素として、もう一度現われます。
</para>
<sect3 id="hrdc.orgh.div.32">
<title>例</title>
<para>ここに示すのは、パートのつのサブトピックへのハイパーリンクがある、PartIntro 付きの Part の例です。
</para>
<programlisting>
&lt;/Part>
&lt;title>Report Master&lt;/title>
&lt;PartIntro>
&lt;Para>Welcome to the online help for Report Master. Please choose one of the following hyperlinks:&lt;/Para>
&lt;itemizedlist>
&lt;listitem>&lt;para>&lt;Link Linkend="Tutorial-id">Tutorial&lt;/Link> &lt;/para>&lt;/listitem>
&lt;listitem>&lt;para>&lt;Link Linkend="Tasks-id">Tasks&lt;/Link>&lt;/para>&lt;/listitem>
&lt;listitem>&lt;para>&lt;Link Linkend="Concepts-id">VolumeDown&lt;/Link>&lt;/para>&lt;/listitem>
&lt;listitem>&lt;para>&lt;Link Linkend="Reference-id">VolumeMute&lt;/Link>&lt;/para>&lt;/listitem>
&lt;/itemizedlist>.
&lt;Para>If you need help, press F1.&lt;/Para>
&lt;/PartIntro>
...
&lt;/Part></programlisting>
<para>上記のマークアップの出力は、次のとおりです。
</para>
<graphic id="hrdc.orgh.igrph.2" entityref="HRDC.OrgH.fig.4"></graphic>
</sect3>
</sect2>
<sect2 id="hrdc.orgh.div.33" role="Procedure">
<title id="hrdc.orgh.mkr.14">トピックを階層に追加するには</title>
<itemizedlist><listitem><para>別のトピックを同じレベルに追加するには、その終了タグで要素を閉じ、その開始タグで開くことによって同じ要素を繰り返します。
</para>
<para>サブトピック(階層内でさらに1レベル下のトピック)を追加するには、前のトピックよりも1レベル下にある要素を使用します。
</para>
</listitem></itemizedlist>
<sect3 id="hrdc.orgh.div.34">
<title>例</title>
<para>現在のトピックが &lt;Sect1> である場合、&lt;Sect2> を使用してサブトピックを入力します。
</para>
<programlisting>&lt;sect1>
&lt;title>Creating Reports&lt;/title>
body of the topic
&lt;sect2>
&lt;title>To Create a Detailed Report&lt;/title>
body of the first subtopic
&lt;/sect2>
&lt;sect2>
&lt;title>To Create a Summary Report&lt;/title>
body of the second subtopic
&lt;/sect2>
&lt;/sect1></programlisting>
<para>2番目の Sect2 も Sect1 のサブトピックです。</para>
<note>
<para>親子兄弟のメタファは、階層内のトピック間の関係を、記述するのに使用されることもあります。前の例では、Sect1 トピックは両方の Sect2子トピックの「親」です。つの Sect2 は、お互いに「兄弟」になります。つのすべてのトピックは、Chapter のトピックの「子孫」です。
</para>
</note>
</sect3>
</sect2>
</sect1>
<sect1 id="HRDC.OrgH.div.35">
<title id="HRDC.OrgH.mkr.15">メタ情報トピックの作成</title>
<para>DocInfo メタ情報セクションは、おもに<emphasis>情報に関する情報</emphasis>を記述しています。DocBook マークアップ言語によるヘルプ・ボリュームのメタ情報は、Part の最初のコンポーネントとして現われる DocInfo 要素に含まれます。DocInfo は、ヘルプ・ボリュームのタイトルと著者を含み、著作権と商標に関する法的な注意事項、およびボリュームの内容の要約を含むことも可能です。
</para>
<para>DocInfo は、次の要素を次の順序で含むことが可能です。</para>
<itemizedlist><listitem><para>Title (必須)</para>
</listitem><listitem><para>TitleAbbrev (任意)</para>
</listitem><listitem><para>Subtitle (任意)</para>
</listitem><listitem><para>ひとつまたは複数の AuthorGroups (必須)</para>
</listitem><listitem><para>複数の Abstracts (任意)</para>
</listitem><listitem><para>ひとつの RevHistory (任意)</para>
</listitem><listitem><para>複数の LegalNotices (任意)</para>
</listitem></itemizedlist>
<sect2 id="HRDC.OrgH.div.36" role="Procedure">
<title id="HRDC.OrgH.mkr.16">メタ情報セクションを作成するには</title>
<orderedlist><listitem><para>次に示すように、セクションを開始するために &lt;DocInfo>、続けて必須の Title 要素を入力します。
</para>
<programlisting>&lt;DocInfo>
&lt;title><symbol>Volume Title Here</symbol>&lt;/title>
</programlisting>
</listitem><listitem><para>必要ならば、オプションの TitleAbbrev および Subtitle 要素を入力します。
</para>
</listitem><listitem><para>必須の AuthorGroup 要素を入力します。これは、ひとつまたは複数の Authors、Collabs、および CorpAuthors を含みますが、順序は任意です
</para>
</listitem><listitem><para>必要ならば、シンタクス・モデルにしたがって、オプションの Abstract および LegalNotice 要素を入力します。
</para>
<programlisting>&lt;Abstract Id="SDL-RESERVED-abstract">
&lt;Para>abstract here&lt;/Para>
&lt;/Abstract>
&lt;LegalNotice Id="SDL-RESERVED-copyright">
&lt;BlockQuote>
&lt;Para>&copy; year &amp; copyright holder's name&lt;/Para>
&lt;/BlockQuote>
&lt;/LegalNotice>
</programlisting>
</listitem><listitem><para>セクションを終了させるために、DocInfo 終了タグを入力します。
</para>
</listitem></orderedlist>
<para>Abstract セクションの使用を推奨します。ヘルプ・ボリュームにアクセスするアプリケーションは、この情報を使用してボリュームの簡単な説明を行います。その抜粋は単純なテキスト・ウィンドウに表示される可能性があるので、DocBook のマークアップを取り込まないようにしてください。
</para>
<sect3 id="HRDC.OrgH.div.37">
<title>例</title>
<para>ここに示すのは、DocInfo 要素に含まれる典型的なメタ情報セクションのマックアップです。
</para>
<programlisting>
&lt;DocInfo>
&lt;title>Report Master, Version 1.0&lt;/title>
&lt;AuthorGroup>
&lt;Author>Jim Jonas&lt;/Author>
&lt;/AuthorGroup>
&lt;Abstract>
&lt;Para>This is the online help for the mythical Report Master application. This help includes a self-guided tutorial, a summary of common tasks, general concepts, and quick reference summaries.&lt;/Para>
&lt;/Abstract>
&lt;LegalNotice>
&lt;BlockQuote>
&lt;Para>
Version 1.0
&amp;copy; Copyright Reports Incorporated 1995
All rights reserved.
&lt;/Para>
&lt;/BlockQuote>
&lt;/LegalNotice>
&lt;/DocInfo></programlisting>
<para>BlockQuite 要素は、著作権表示の改行を維持するために使用されます。<literal>&amp;copy;</literal> エンティティは、著作権のシンボルを挿入します。
</para>
</sect3>
</sect2>
</sect1>
<sect1 id="HRDC.OrgH.div.39">
<title>非階層トピックの追加</title>
<para>Chapter または Sect1、Sect2、Sect3、Sect4、Sect5 の要素タグが入力されているトピックは、自動的にトピック・ツリーに表示されます。タイトルがトピック・ツリーで選択されると、対応するヘルプ・トピックが一般ヘルプ・ダイアログ・ボックスに表示されます。
</para>
<para>しかし、すでに作成されているトピック階層からは独立しているトピックを作成および表示したい場合もあります。これらの非階層トピックは、簡易ヘルプ・ダイアログ・ボックスにトピックを表示するカスタム定義リンクを作成する場合に有用です。
</para>
<para>Appendix は、Sect 階層に結合されていないフリー・フロート・ヘッディングのためのタグです。これには、インライン要素を含めることが可能です。
</para>
<para>Appendix は、ID属性、XRefLabel 属性、および Lable 属性も含む共通の属性をもちます。非階層トピックのために Appendix 要素を使用する場合、Role 属性の値は、&ldquo;notoc&rdquo; にすべきです。</para>
<sect2 id="hrdc.orgh.div.40" role="Procedure">
<title id="hrdc.orgh.mkr.17">非階層トピックを追加するには</title>
<itemizedlist><listitem><para>次のようにして、BridgeHead 要素を使用して、非階層トピックを追加します。
</para>
<programlisting>&lt;Appendix id="bh-some-id" role="notoc">
<symbol>text of the topic</symbol>
&lt;/Appendix></programlisting>
</listitem></itemizedlist>
<para>前提として、このトピックを表示する定義リンクが、ヘルプ・ボリューム中の他のトピック内に存在するものとします。
</para>
<para>リンクは、以下に示すようになります。</para>
<programlisting>Here's a sample of a pop-up &lt;link linkend="bh-some-id">
definition link.&lt;/link></programlisting>
<para>語句 &ldquo;definition link&rdquo; が実際のハイパーリンクであり、破線の下線で表示されます。リンクを選択すると、簡易ヘルプ・ダイアログ・ボックスにトピックのテキストが表示されます。
</para>
<sect3 id="hrdc.orgh.div.42">
<title>関連項目</title>
<itemizedlist><listitem><para><xref role="SecTitleAndPageNum" linkend="hrdc.wrtop.mkr.14"></para>
</listitem></itemizedlist>
</sect3>
</sect2>
</sect1>
<sect1 id="HRDC.OrgH.div.43">
<title id="HRDC.OrgH.mkr.18">トピックへのアクセス</title>
<para>DocBook 言語の多くの要素は、ID属性をサポートしています。IDは、トピックとトピック内の要素を識別するために内部的に使用される独自の名前です。IDは、DocBook の共通属性のひとつなので、共通属性をもつ要素は、すべてID属性をサポートすることができます。
</para>
<para>IDは、一度しか定義されませんが、複数のハイパーリンクと相互参照は同じIDを参照できます。IDは、ユーザには見えません。
</para>
<para>アプリケーションのヘルプを記述している場合、ユーザがヘルプを要求したときに表示される特定のトピックを識別するために、アプリケーションがIDを使用することもあります。
</para>
<para>たとえば、アプリケーションのメニューを説明するいくつかのトピックを記述する場合などです。トピックに割り当てるIDは、アプリケーションの開発者によって使用されます。アプリケーション・コード内に同一のIDを定義することにより、開発者は特定のトピックを統合することができます。これにより、アプリケーションは、特定のメニューに関してヘルプが要求されたときに正しいトピックへアクセスし、表示することができます。
</para>
<sect2 id="HRDC.OrgH.div.44">
<title>ID名に関する規則</title>
<itemizedlist><listitem><para>ID文字列は、英字AからZとaからz、数字0から9、ピリオド.)、およびマイナス記号(-から成ります。ID文字列は、必ず英字で始まり、少くともそれらが現われるドキュメント内で一意でなければなりません。
</para>
</listitem><listitem><para>ID文字列では大文字・小文字の区別が<emphasis>ありません</emphasis>が、可読性を向上させるために、しばしば使用されます。
</para>
</listitem><listitem><para>ID文字列の長さは、128文字以内です。
</para>
</listitem><listitem><para>単一のヘルプ・ボリューム内の各IDは、一意でなければなりません。
</para>
</listitem></itemizedlist>
</sect2>
<sect2 id="HRDC.OrgH.div.44a">
<title>組み込みID</title>
<para>組み込みIDをもっている要素は、数個ありますが、設計者定義IDをサポートしていません。次の要素のそれぞれも新しいトピックを開始しますが、これらの要素は定義済みID括弧内のものを持っています。
</para>
<informaltable>
<tgroup cols="2" colsep="0" rowsep="0">
<colspec colwidth="264*">
<colspec colwidth="264*">
<tbody>
<row>
<entry align="left" valign="top">&lt;PartIntro></entry>
<entry align="left" valign="top">( _hometopic)</entry></row>
<row>
<entry align="left" valign="top">&lt;LegalNotice> in &lt;DocInfo></entry>
<entry align="left" valign="top">( _copyright)</entry></row>
<row>
<entry align="left" valign="top">&lt;Abstract> in &lt;DocInfo></entry>
<entry align="left" valign="top">( _abstract)</entry></row>
<row>
<entry align="left" valign="top">&lt;Glossary></entry>
<entry align="left" valign="top">( _glossary)</entry></row>
<row>
<entry align="left" valign="top">&lt;Title> in &lt;DocInfo></entry>
<entry align="left" valign="top">( _title)</entry></row></tbody></tgroup>
</informaltable>
</sect2>
<sect2 id="HRDC.OrgH.div.45" role="Procedure">
<title id="HRDC.OrgH.mkr.19">DocBook 要素にIDを追加するには</title>
<itemizedlist><listitem><para>次のように、要素の開始タグ内にIDを指定します。</para>
<programlisting>&lt;Element ID="<symbol>id-string</symbol>"></programlisting>
<para>ID文字列の値は、引用符で囲むことに注意してください。
</para>
</listitem></itemizedlist>
<para>共通属性をもつすべての DocBook 要素は、設計者定義IDをサポートします。それらの DocBook 要素を次に示します。
</para>
<itemizedlist><listitem><para>Abbrev</para>
</listitem><listitem><para>Abstract</para>
</listitem><listitem><para>Anchor</para>
</listitem><listitem><para>Appendix</para>
</listitem><listitem><para>Author</para>
</listitem><listitem><para>BlockQuote</para>
</listitem><listitem><para>BridgeHead</para>
</listitem><listitem><para>Chapter</para>
</listitem><listitem><para>ComputerOutput</para>
</listitem><listitem><para>CorpAuthor</para>
</listitem><listitem><para>DocInfo</para>
</listitem><listitem><para>Entry</para>
</listitem><listitem><para>EntryTbl</para>
</listitem><listitem><para>Example</para>
</listitem><listitem><para>Figure</para>
</listitem><listitem><para>Glossary</para>
</listitem><listitem><para>GlossDiv</para>
</listitem><listitem><para>GlossEntry</para>
</listitem><listitem><para>GlossTerm</para>
</listitem><listitem><para>Graphic</para>
</listitem><listitem><para>Index</para>
</listitem><listitem><para>IndexDiv</para>
</listitem><listitem><para>IndexEntry</para>
</listitem><listitem><para>InformalTable</para>
</listitem><listitem><para>ItemizedList</para>
</listitem><listitem><para>KeyCap</para>
</listitem><listitem><para>LiteralLayout</para>
</listitem><listitem><para>OrderedList</para>
</listitem><listitem><para>Part</para>
</listitem><listitem><para>PrimaryIE</para>
</listitem><listitem><para>ProgramListing</para>
</listitem><listitem><para>Quote</para>
</listitem><listitem><para>RefEntry</para>
</listitem><listitem><para>Reference</para>
</listitem><listitem><para>Screen</para>
</listitem><listitem><para>Sect1 - Sect5</para>
</listitem><listitem><para>See</para>
</listitem><listitem><para>SeeAlso</para>
</listitem><listitem><para>SeeIE</para>
</listitem><listitem><para>Seg</para>
</listitem><listitem><para>SegListItem</para>
</listitem><listitem><para>SegmentedList</para>
</listitem><listitem><para>SegTitle</para>
</listitem><listitem><para>Sidebar</para>
</listitem><listitem><para>SpanSpec</para>
</listitem><listitem><para>Table</para>
</listitem><listitem><para>TBody</para>
</listitem><listitem><para>TFoot</para>
</listitem><listitem><para>TGroup</para>
</listitem><listitem><para>Term</para>
</listitem><listitem><para>Title</para>
</listitem><listitem><para>TitleAbbrev</para>
</listitem><listitem><para>ToC</para>
</listitem><listitem><para>UserInput</para>
</listitem><listitem><para>VariableList</para>
</listitem><listitem><para>VarListEntry</para>
</listitem></itemizedlist>
<para>ID指定をサポートする DocBook 要素のID指定に加えて、ドキュメント中の参照点にIDを設定するために、Anchor 要素を使用することができます。このとき、Anchor は、Linkend 属性の値として Anchor のID文字列を指定する Link のためのターゲットをマークすることができます。Anchor はインライン要素で、ほとんどすべての場所に現われることが可能です。Anchor は、空要素であり、内容はもちません。
</para>
<para>Anchor は、ID、Pagenum、Remap、Role、および XRefLabel 属性をもつことができますが、ID属性のみ必須です。最低限、Anchor の開始タグは、IDをともなって現われなければなりません。
</para>
<para>位置IDへのリンクを選択すると、ヘルプ・ビューアは、IDを含むトピックを表示し、IDの位置までウィンドウをスクロールします。
</para>
<sect3 id="HRDC.OrgH.div.45a">
<title>Anchor要素のシンタクス</title>
<programlisting>&lt;anchor id="<symbol>id-string</symbol>"></programlisting>
</sect3>
<sect3 id="HRDC.OrgH.div.45b">
<title>Anchor 要素の例</title>
<programlisting>There is an Anchor <symbol>&lt;anchor id=&ldquo;077-ch02-AN-7&rdquo;></symbol> in this sentence.</programlisting>
</sect3>
</sect2>
</sect1>
<sect1 id="HRDC.OrgH.div.49">
<title id="HRDC.OrgH.mkr.22">エンティティの使い方</title>
<para><emphasis>エンティティ</emphasis>には、文字列とファイルの内容を指定することができます。
</para>
<para><emphasis>エンティティ宣言</emphasis>は、エンティティ名と特定の文字列やファイル名とを関連付けることによりエンティティを定義します。
</para>
<para><emphasis>エンティティの参照</emphasis>は、<command>dtdocbook</command> で、ヘルプ・ボリュームを処理すると文字列やファイルの内容に置き換えられます。
</para>
<para>エンティティは、次のときに有用です。</para>
<itemizedlist><listitem><para><emphasis>テキストの共通の文字列を参照する。</emphasis>これは、引き続く類似テキストを変更したり、繰り返し入力したくないような場合に有用です。
</para>
<para>一度、テキストを表すエンティティを宣言すれば、テキストを挿入したいところで、エンティティ名を参照すれば済みます。
</para>
</listitem><listitem><para><emphasis>外部ファイル、特にグラフィック・ファイルを参照する。</emphasis>エンティティは、グラフィック・ファイルへのアクセス方法のひとつを提供します。
</para>
<para>Graphic 要素は、その属形を通じて、グラフィック・データを含む外部ファイルを指します。
</para>
<para>グラフィック・データを含むファイルは、必要ならばパス名を付加したファイル名を値とする Graphic の Fileref 属性を使用することによって、指定することができます。
</para>
<para>また、グラフィック・データを含むファイルが、エンティティを宣言している場合は、エンエィティ名を値とする Graphic の Entityref 属性を使用することによって、指定することができます。
</para>
</listitem></itemizedlist>
<para>File エンティティも、DocBook のソースを複数のファイルに分割するときに有用です。処理中のマスタ DocBook ファイルに他のファイルを取り込むには、エンティティの参照を使用します。
</para>
<sect2 id="HRDC.OrgH.div.50">
<title><emphasis>エンティティの宣言に関する規則</emphasis></title>
<itemizedlist><listitem><para>エンティティ名は、英字AからZとaからz、数字0から9、ビリオド.)、およびマイナス記号(-)から成り、必ず英字で始まります。
</para>
</listitem><listitem><para>エンティティ名は、大文字でも小文字でも<emphasis>意味は変わりません</emphasis>が、読みやすいように使い分けてください。
</para>
</listitem><listitem><para>エンティティ名の長さは、128文字以内です。
</para>
</listitem><listitem><para>各エンティティ名は、単一のボリューム内では一意でなければなりません。
</para>
</listitem></itemizedlist>
</sect2>
<sect2 id="HRDC.OrgH.div.51" role="Procedure">
<title id="HRDC.OrgH.mkr.23">テキスト・エンティティを作成するには</title>
<orderedlist><listitem><para>次のようにエンティティを宣言します。
</para>
<programlisting>&lt;!entity <symbol>Entityname</symbol> "<symbol>text string</symbol>"></programlisting>
<para><symbol>Entityname</symbol> は、エンティティの名前で、<symbol>text string</symbol> は、エンティティへの各参照に代わる文字列です。<emphasis>すべてのエンティティの宣言が、ヘルプ・ボリュームの文書型宣言に含まれなければならないことに注意してください。</emphasis></para>
</listitem><listitem><para><symbol>text string</symbol>を挿入したい各位置には、次のようにエンティティの参照を入力します。
</para>
<programlisting><symbol>&amp;Entityname;</symbol></programlisting>
<para><literal>&amp;</literal> (アンパサンド) と <literal>;</literal> (セミコロン) は、DocBook ソフトウェアがエンティティの参照を適切に認識するために必要です。
</para>
</listitem></orderedlist>
<sect3 id="HRDC.OrgH.div.52">
<title>例</title>
<para>次の行は、&ldquo;Society of Agricultural Engineers&rdquo; という文字列が入っているAssocという名前のテキスト・エンティティを宣言しています。
</para>
<programlisting>&lt;!entity Assoc "Society of Agricultural Engineers"></programlisting>
<para>次の文には、エンティティへの参照が記述されています。
</para>
<programlisting>Welcome to the &amp;Assoc;.</programlisting>
<para>ヘルプ・ボリュームが DocBook ソフトウェアで処理されると、エンティティの参照は、エンティティの値に置き換えられます。そのため、文は次のように表示されます。
</para>
<para>Welcome to the Society of Agricultural Engineers.</para>
</sect3>
</sect2>
<sect2 id="HRDC.OrgH.div.53" role="Procedure">
<title id="HRDC.OrgH.mkr.24">ファイル・エンティティを作成するには</title>
<orderedlist><listitem><para>次のようにエンティティを宣言します。
</para>
<programlisting>&lt;!entity <symbol role="Variable">Entityname</symbol> SYSTEM "<symbol role="Variable">filename</symbol>"></programlisting>
<para><symbol role="Variable">Entityname</symbol> は、エンティティの名前で、<symbol>filename</symbol> は、ファイルの名前です。キーワード <Symbol>SYSTEM</Symbol> は必須です。</para>
</listitem><listitem><para>次のようにエンティティを参照します。</para>
<itemizedlist><listitem><para>ファイルがテキスト・ファイルの場合、ファイルの内容を挿入したい各位置に次のエンティティの参照を入力します。
</para>
<programlisting><symbol>&amp;Entityname;</symbol></programlisting>
<para>&amp; (アンパサンド) と ; (セミコロン) の文字は、DocBook ソフトウェアがエンティティの参照を適切に認識するために必要です。
</para>
</listitem><listitem><para>ファイルがグラフィック・ファイルの場合、Entityref 属性の値として、次のようにエンティティの名前を入れます。
</para>
<programlisting>&lt;Graphic ID="<symbol>some-graphic-id</symbol>"Entityref=" <symbol>Entityname</symbol>">&lt;/Graphic></programlisting>
</listitem></itemizedlist>
</listitem></orderedlist>
<sect3 id="HRDC.OrgH.div.54">
<title>例:テキスト・ファイル・エンティティ</title>
<para><filename>file1</filename>、<filename>file2</filename>、および <filename>file3</filename> という名前の3つのファイルと、&lt;docinfo> &hellip; &lt;/docinfo> セクションがある4番目のファイルに、ヘルプ・ボリュームのテキストを記述したとします。次のようにして4つのファイルを <symbol>volume</symbol><filename>.sgm</filename> ファイルに取り込むことができます。
</para>
<programlisting>&lt;!DOCTYPE DOCBOOK [
&lt;!entity DocInformation SYSTEM "docinfo">
&lt;!entity MyFirstFile SYSTEM "file1">
&lt;!entity MySecondFile SYSTEM "file2">
&lt;!entity MyThirdFile SYSTEM "file3">
.<?Pub Caret>..
>]
&lt;Part>
&amp;DocInformation;
&lt;Title>My Home Title&lt;/Title>
&amp;MyFirstFile;
&amp;MySecondFile;
&amp;MyThirdFile;</programlisting>
</sect3>
<sect3 id="HRDC.OrgH.div.55">
<title>例:グラフィック・ファイル・エンティティ</title>
<para>単一のヘルプ・ボリュームのPartに図があり、図のグラフィック・イメージが <filename>picture.tif</filename> という名前のファイルに格納されているとします。次の例は、そのイメージが図でどのように使用されているかを示しています。
</para>
<programlisting>&lt;!DOCTYPE DOCBOOK [
&lt;!entity DocInformation SYSTEM &ldquo;docinfo&rdquo;>
&lt;!entity MyPicture SYSTEM &ldquo;picture.tif&rdquo;>
...
]>
&lt;Part>
&amp;DocInformation;
&lt;PartIntro>&lt;Title>A Simple Graphic&lt;/Title>
&lt;Para>Welcome to my application's help volume.&lt;/Para>
&lt;/Part>
&lt;Figure>
&lt;Title>A Picture&lt;/Title>
&lt;Graphic entityref="MyPicture"> &lt;/Graphic>
&lt;/Figure>
&lt;/PartIntro>
&lt;/Part>
</programlisting>
<para>テキスト &ldquo;A Picture&rdquo; は、図のタイトルです。
</para>
<para>マークアップの出力は、次のとおりです。
</para>
<graphic id="HRDC.OrgH.igrph.3" entityref="HRDC.OrgH.fig.5"></graphic>
</sect3>
<sect3 id="HRDC.OrgH.div.56">
<title>関連項目</title>
<itemizedlist remap="Bullet1"><listitem><para><xref role="SecTitleAndPageNum"
linkend="HRDC.WrTop.mkr.23"></para>
</listitem></itemizedlist>
</sect3>
</sect2>
</sect1>
</chapter>
<!--fickle 1.14 mif-to-docbook 1.7 01/02/96 16:48:20-->
<?Pub *0000055796>

View File

@@ -0,0 +1,673 @@
<!-- $XConsortium: ch03.sgm /main/11 1996/09/08 19:39:54 rws $ -->
<!-- (c) Copyright 1995 Digital Equipment Corporation. -->
<!-- (c) Copyright 1995 Hewlett-Packard Company. -->
<!-- (c) Copyright 1995 International Business Machines Corp. -->
<!-- (c) Copyright 1995 Sun Microsystems, Inc. -->
<!-- (c) Copyright 1995 Novell, Inc. -->
<!-- (c) Copyright 1995 FUJITSU LIMITED. -->
<!-- (c) Copyright 1995 Hitachi. -->
<chapter id="HRDC.WrTop.div.1">
<title id="HRDC.WrTop.mkr.1">ヘルプ・トピックの記述</title>
<para>この章では、テキストを構造化するためにに使用する要素を説明します。また、グラフィックの取り込み方法と、他のヘルプ・トピックへのハイパーリンクの作成方法も説明します。
</para>
<informaltable id="HRDC.WrTop.itbl.1" frame="All">
<tgroup cols="1">
<colspec colname="1" colwidth="4.0 in">
<tbody>
<row rowsep="1">
<entry><para><!--Original XRef content: 'Creating Structure within a Topic52'--><xref
role="JumpText" linkend="HRDC.WrTop.mkr.2"></para></entry></row>
<row rowsep="1">
<entry><para><!--Original XRef content: 'Entering Inline Elements62'--><xref
role="JumpText" linkend="HRDC.WrTop.mkr.9"></para></entry></row>
<row rowsep="1">
<entry><para><!--Original XRef content: 'Creating Hyperlinks64'--><xref role="JumpText"
linkend="HRDC.WrTop.mkr.14"></para></entry></row>
<row rowsep="1">
<entry><para><!--Original XRef content: 'Displaying Graphics76'--><xref role="JumpText"
linkend="HRDC.WrTop.mkr.23"></para></entry></row>
<row rowsep="1">
<entry><para><!--Original XRef content: 'Including Special Characters80'--><xref
role="JumpText" linkend="HRDC.WrTop.mkr.27"></para></entry></row>
<row rowsep="1">
<entry><para><!--Original XRef content: 'Including Comments and Writer's Memos81'--><xref
role="JumpText" linkend="HRDC.WrTop.mkr.29"></para></entry></row>
<row rowsep="1">
<entry><para><!--Original XRef content: 'Creating an Index82'--><xref role="JumpText"
linkend="HRDC.WrTop.mkr.32"></para></entry></row>
<row rowsep="1">
<entry><para><!--Original XRef content: 'Creating a Glossary83'--><xref role="JumpText"
linkend="HRDC.WrTop.mkr.34"></para></entry></row></tbody></tgroup></informaltable>
<sect1 id="HRDC.WrTop.div.2">
<title>ヘルプ・トピックの作成</title>
<para>ヘルプ・トピックは、固有のIDで識別できる情報の単位です。ヘルプ・トピックは、オンライン・ヘルプを記述しているプロダクトを最適に表現する論理的な枠組にグループ化されます。
</para>
<para>DocBook によって提供される要素の階層構造は、ユーザが記述するヘルプ・トピックを構成する枠組となります。要素の階層構造は、Chapter、Sect1、Sect2、Sect3、Sect4、および Sect5 のようになっています。</para>
<para>階層構造内のトピックの位置は、それを含む要素、およびその要素がより高位の要素にどのように埋め込まれるか、によって決定されます。たとえば、Sect2 というタグが付けられたトピックが、Sect1 というタグが付けられたトピックに続く場合、Sect1 トピックの下位トピックになります。
</para>
<para>アプリケーションアプリケーション・ヘルプを記述している場合か、ハイパーリンクのどちらかからアクセスするトピックにはIDが必要です。通常、トピックを含む要素、およびそのタイトルの両方にIDが付与されます。IDは、Chapter、Sect1、Sect2、Sect3、Sect4、Sect5、および Title という要素の属性のひとつです。</para>
<sect2 id="HRDC.WrTop.div.3">
<title>例</title>
<para>次の行は &lt;Sect1> タグを使用してトピックの開始をマークします。
</para>
<programlisting>&lt;sect1 id="HRDC.WrTop.div.2"></programlisting>
<para>タイトルは、要素 Chapter、Sect1、Sect2、Sect3、Sect4、Sect5 に必須であり、要素の開始タグにすぐ続けます。マークアップは、次のようになります。
</para>
<programlisting>&lt;sect1 id="HRDC.WrTop.div.2">
&lt;title>Help Topics&lt;/title></programlisting>
<sect3 id="HRDC.WrTop.div.4">
<title>関連項目</title>
<itemizedlist remap="Bullet1"><listitem><para><!--Original XRef content: 'Chapter&numsp;2,
&ldquo;Organizing and Writing a Help Volume'--><xref role="ChapNumAndTitle"
linkend="HRDC.OrgH.mkr.1">では、トピック階層の作成方法を含めたヘルプ・ボリュームの一般的な構造を説明しています。
</para>
</listitem></itemizedlist>
</sect3>
</sect2>
</sect1>
<sect1 id="HRDC.WrTop.div.5">
<title id="HRDC.WrTop.mkr.2">トピック内に構造を作成する</title>
<para>ヘルプ・トピックの本文には、情報を構成して提示するために選択する次のような要素があります。
</para>
<itemizedlist><listitem><para><emphasis>パラグラフ</emphasis>は、テキストの本文に使用します。
</para>
</listitem><listitem><para><emphasis>リスト</emphasis>は、箇条書きにして示す情報に使用します。リストの種類には、ItemizedList行頭文字が付いたもの、OrderedList番号の付いたもの、VariableList用語のリストの定義、および SegmentedList情報に比較のラベルが付いたセットがあります。
</para>
</listitem><listitem><para><emphasis>表</emphasis>は、情報の構造化された配列に使用します。InformalTableタイトルなしおよび Tableタイトル必須があります。
</para>
</listitem><listitem><para><emphasis>グラフィック</emphasis>は<emphasis>インライン要素</emphasis>としてテキスト内に入れたり、独立した<emphasis>ブロック指向の要素</emphasis>として段落の間に表示できます。Graphic は、グラフィック・データを含む外部ファイルを指します。
</para>
</listitem><listitem><para><emphasis>ハイパーリンク</emphasis>で、関連トピックを参照できます。ハイパーリンクは、その階層内のより深層のサブトピックに続いたり、まったく異なる部分のトピックに分岐したり、他のヘルプ・ボリュームに続いたりします。
</para>
</listitem><listitem><para><emphasis>コンピュータ・リテラル</emphasis>は、ファイル名や変数名などの、コンピュータが認識するテキストです。コンピュータ・リテラルは、それだけを分けて表示することも、インライン要素として表示することもできます。
</para>
</listitem><listitem><para><emphasis>注、注意、警告</emphasis>は、重要な情報へ読者の注意を促します。
</para>
</listitem><listitem><para><emphasis>強調表示</emphasis>は、パラグラフのテキスト内の重要な語句を強調表示するのに使用します。
</para>
</listitem></itemizedlist>
<sect2 id="HRDC.WrTop.div.6" role="Procedure">
<title id="HRDC.WrTop.mkr.3">パラグラフを開始するには</title>
<para>一般に、&lt;Para> タグを使用して、新規パラグラフの開始をマークします。DocBook DTD は、種類のパラグラフを提供します。Para はList や Figure のようなブロック指向の要素を含むことができます。SimPara は、通常のテキストとインライン要素のみを含むことができます。FormalPara には、タイトルが必須です。
</para>
<para>パラグラフで、ソース・ファイルに入力した改行を保持したい場合は、&lt;LiteralLayout> タグを使用します。</para>
<sect3 id="HRDC.WrTop.div.7">
<title>例</title>
<para>これは、通常のパラグラフの例です。</para>
<programlisting>&lt;para>The Application Builder provides an interactive, graphical environment that facilitates the development of desktop applications. &lt;/para>
</programlisting>
<para>次の LiteralLayout は、ヘルプ・ウィンドウ内の自動的なワード・ラップを上書きし、ソース・ファイルに入力された改行を正確に保持します。LiteralLayout 要素は、アドレスの作成に、特に有用です。
</para>
<programlisting>&lt;LiteralLayout>
Brown and Reed Financial Investors
100 Baltic Place Suite 40
New York, New York
&lt;/LiteralLayout></programlisting>
</sect3>
</sect2>
<sect2 id="HRDC.WrTop.div.8" role="Procedure">
<title id="HRDC.WrTop.mkr.4">ItemizedList を入力するには</title>
<para>ItemizedList は、その項目が、弾丸型、ダッシュ、または他の段落記号でマークされた、あるいは、まったくマークされないリストです。ItemizedList は、ひとつまたは複数の ListItem を含みます。
</para>
<para>ItemizedList 中の ListItem は、パラグラフおよび他へのリンクを含む他のブロック指向の要素を指定することができます。
</para>
<para>ItemizedList 中で使用したいマークを指定するために、Mark 属性を使用することができます。Mark 属性のための値の固定的なリストはありませんが、使用したい段落記号を指定する ISO のテキスト・エンティティを使用することができます。ItemizedList のために使用されるマークを、アプリケーションが提供することもあるかもしれません。
</para>
<para>これは、ItemizedList 要素のために使用するシンタクスです。
</para>
<programlisting>&lt;ItemizedList Mark="Bullet">
&lt;ListItem>
&lt;para> ... &lt;/para>
&lt;/ListItem>
&lt;ListItem>
&lt;para> ... &lt;/para>
&lt;/ListItem>
...
&lt;/ItemizedList></programlisting>
<sect3 id="HRDC.WrTop.div.9">
<title>例</title>
<para>これは、単純な ItemizedList のマークアップです。</para>
<programlisting>&lt;itemizedlist>
&lt;listitem>&lt;para>Creating a Mail Message&lt;/para>&lt;/listitem>
&lt;listitem>&lt;para>Sending a Message&lt;/para>&lt;/listitem>
&lt;listitem>&lt;para>Reading Your Mail&lt;/para>&lt;/listitem>
&lt;/itemizedlist></programlisting>
<para>このマークアップでは、ItemizedList が次のように出力されます。
</para>
<itemizedlist><listitem><para>Creating a Mail Message</para>
</listitem><listitem><para>Sending a Message</para>
</listitem><listitem><para>Reading Your Mail</para>
</listitem></itemizedlist>
</sect3>
</sect2>
<sect2 id="HRDC.WrTop.div.8a" role="Procedure">
<title id="HRDC.WrTop.mkr.4a">OrderdList を入力するには</title>
<para>OrderedList は、数字または文字でマークされた ListItem を含みます。OrderedList 中の ListItem は、パラグラフおよび ItemizedList と OrderedList を含む他のブロック指向要素を指定することができます。
</para>
<para>OrderedList は Common 属性、および Numeration、InheritNum、Continuation の各属性ももちます。
</para>
<para>Numeration 属性は、OrderedList 中の ListItem が、どのように数字付けまたは文字付けされるかを指定します。これは、値として、Arabic、Upperalpha、Loweralpha、Upperroman、または Lowerroman をとります。値を指定しないと、Arabic の数字付けが使用されます。
</para>
<para>InheritNum 属性は、値 Inherit または Ignore をとります。値が Inherit の場合、ネストされたリスト中の ListItem の数字付けが、それがネストされている ListItem の数字を含むという指定になります。すなわち、別の OrderedList が、2番目の ListItem 中にネストされていると、ネストされたリストの ListItem は、単純な a、b、c、ではなく、2a、2b、2c、というように数字付けされます。
</para>
<para>Continuation 属性は、値 Continues または Restarts をとります。値が Continues の場合、OrderedList の数字付けは、直接続く OrderedList の数字付けを続けるという指定になります。値が Restartsデフォルトの場合、OrderedList の数字付けを最初から開始するという指定になります。Continuation 属性の指定は、OrderedList が直前の数字付けを続行する場合のみ必要です。
</para>
<sect3 id="HRDC.Ref.div.8b">
<title>シンタクスの例</title>
<para>次にマークアップの例を示します。</para>
<programlisting>&lt;OrderedList>
&lt;ListItem>
&lt;para>Creating a Mail Message&lt;/para>
&lt;/ListItem>
&lt;ListItem>
&lt;para>Sending a Message&lt;/para>
&lt;/ListItem>
&lt;ListItem>
&lt;para>Reading Your Mail&lt;/para>
&lt;/ListItem>
&lt;/OrderedList></programlisting>
<para>このマークアップは、次のリストを出力します。</para>
<orderedlist><listitem><para>Creating a Mail Message</para>
</listitem><listitem><para>Sending a Message</para>
</listitem><listitem><para>Reading Your Mail</para>
</listitem></orderedlist>
</sect3>
</sect2>
<sect2 id="HRDC.WrTop.div.8c" role="Procedure">
<title id="HRDC.WrTop.mkr.4c">SegmentedListを入力するには</title>
<para>SegmentedList は、ラベル付けされた情報の列挙をマークするときに使用します。
</para>
<para>SegmentedList には、オプションで Title および TitleAbbrev を指定できます。その後に複数(いくつあってもかまいません)の SegTitle、および、ひとつまたは複数の SegListItems が続きます。各 SegListItem は、それが属す SegmentedList 中に SegTitle があるように、同じ Seg を持ちます。
</para>
<sect3 id="HRDC.Ref.div.8d">
<title>シンタクスの例</title>
<para>次に示すのは、SegmentedList のマークアップの例です。</para>
<programlisting>&lt;SegmentedList>
&lt;SegTitle>Nation&lt;/SegTitle>
&lt;SegTitle>Ethnic Groups&lt;/SegTitle>
&lt;SegTitle>Languages&lt;/SegTitle>
&lt;SegListItem>
&lt;Seg>Japan&lt;/Seg>
&lt;Seg>Japanese, Koreans, Ainu&lt;/Seg>
&lt;Seg>Japanese&lt;/Seg>
&lt;/SegListItem>
&lt;SegListItem>
&lt;Seg>Spain&lt;/Seg>
&lt;Seg>Spanish, Basques&lt;/Seg>
&lt;Seg>Castillian, Catalan, Basque&lt;/Seg>
&lt;/SegListItem>
&lt;SegListItem>
&lt;Seg>Belgium&lt;/Seg>
&lt;Seg>Flemish, Walloons&lt;&lt;/Seg>
&lt;Seg>Dutch, French&lt;/Seg>
&lt;/SegListItem>
&lt;/SegmentedList></programlisting>
<para>この例は、次のように表示されるリストを出力します。</para>
<segmentedlist>
<segtitle>Nation</segtitle>
<segtitle>Ethnic Groups</segtitle>
<segtitle>Languages</segtitle>
<seglistitem>
<seg>Japan</seg>
<seg>Japanese, Koreans, Ainu</seg>
<seg>Japanese</seg></seglistitem>
<seglistitem>
<seg>Spain</seg>
<seg>Spanish, Basques</seg>
<seg>Castillian, Catalan, Basque</seg></seglistitem>
<seglistitem>
<seg>Belgium</seg>
<seg>Flemish, Walloons</seg>
<seg>Dutch, French</seg></seglistitem>
</segmentedlist>
</sect3>
</sect2>
<sect2 id="HRDC.WrTop.div.8e" role="Procedure">
<title id="HRDC.WrTop.mkr.4e">VariableList を入力するには</title>
<para>VariableList 要素は、用語とその定義のリストを作成するときに使用します。
</para>
<para>VariableList には、オプションの Title および TitleAbbrev を指定することができます。この後に必須である VarListEntry がひとつまたは複数個続きます。
</para>
<para>VarListEntry は、VariableList の必須のコンポーネントです。VarListEntry は、定義される用語をマークする Term 要素、用語の定義を記述する ListTerm 要素を含みます。
</para>
<sect3 id="HRDC.WrTop.div.8f">
<title>例</title>
<para>次に示すのは、VariableList のマークアップのシンタクスです。</para>
<programlisting>&lt;VariableList>
&lt;varlistentry>
&lt;term>first term&lt;/term>
&lt;listitem>&lt;para>definition of first term &lt;/para>&lt;listitem>
&lt;/varlistentry>
&lt;varlistentry>
&lt;term>second term&lt;/term>
&lt;listitem>&lt;para>definition of second term &lt;/para>&lt;listitem>
&lt;/varlistentry>
...
&lt;/VariableList></programlisting>
</sect3>
</sect2>
<sect2 id="HRDC.WrTop.div.17" role="Procedure">
<title id="HRDC.WrTop.mkr.6">コンピュータ・リストを表示するには</title>
<para>挿入された空白や改行を変更せずに、プログラムのソース・コードの部分を表示するには、ProgramListing 要素を使用します。ProgramListing の内部では、改行や先頭の空白が、そのまま残されます。
</para>
<para>ProgramListing には、LineAnnotation を含むインライン要素を指定することができます。LineAnnotation は、ドキュメント設計者によるコード上のコメントであり、コードの作成者によるコードそれ自身に記述されたコメントではありません。
</para>
<para>ProgramListing は、Example 要素内部に埋め込むことが可能です。Example は、通常必須の Title と ProgramListing を含みます。
</para>
<para>ProgramListing には、内容に最大幅を示す数値をとる Width 属性を指定することができます。
</para>
<para>改行は、ソース・ファイル中で入力された位置に現われます。ヘルプ・ウィンドウに対して、プログラム例の幅が大き過ぎる場合は、すべてのプログラム例のテキストをみることができるように、水平方向のスクロール・バーが現われます。
</para>
<warning>
<para>ProgramListing の内部に、DocBook のマークアップ・タグとして解釈される文字シーケンスを含めてはいけません。この問題を回避するには、マークアップ・タグの名前を開始するときに、"&lt;" ではなく、"&amp;lt;" を使用します。
</para>
</warning>
<sect3 id="HRDC.WrTop.div.18">
<title>例</title>
<para>次に示す例では、ProgramListing 要素のマークアップが、端末ウィンドウのディレクトリ・リストを表示するために使用されています。
</para>
<programlisting>&lt;programlisting>In this tutorial, you will edit these graphics files:
H_ActionIcons.xwd H_HelpWindows.xwd
H_AppHelp.xwd H_Hyperlinks.xwd
H_Canonical.xwd H_Icons.xwd
H_FrontPanel.xwd H_InlineGraphic.xwd
&lt;/programlisting></programlisting>
<para>このマークアップは、次の内容を出力します。</para>
<programlisting>In this tutorial, you will edit these graphics files:
H_ActionIcons.xwd H_HelpWindows.xwd
H_AppHelp.xwd H_Hyperlinks.xwd
H_Canonical.xwd H_Icons.xwd
H_FrontPanel.xwd H_InlineGraphic.xwd</programlisting>
</sect3>
</sect2>
<sect2 id="HRDC.WrTop.div.20" role="Procedure">
<title id="HRDC.WrTop.mkr.7">注、注意、警告を追加するには</title>
<para>Note、Caution、および Warning 要素は次のように指定します。</para>
<programlisting>&lt;note>
<symbol>Body of note here.</symbol>
&lt;/note>
&lt;caution>
<symbol role="Variable">Body of caution here</symbol>
&lt;/caution>
&lt;warning>
<symbol role="Variable">Body of warning here.</symbol>
&lt;/warning></programlisting>
<para>Note、Caution、および Warning 要素に関連するアイコンは、ユーザの <filename>.sdl</filename> に相対的な次に示すグラフィック・ファイルが参照されます。
</para>
<para><filename>graphics/noteicon.pm</filename></para>
<para><filename>graphics/cauticon.pm</filename></para>
<para><filename>graphics/warnicon.pm</filename></para>
<para>デフォルトのアイコンは、<filename>/usr/dt/appconfig/help/C/graphics</filename> にあります。ユーザ独自のアイコンを作成するには、配置される領域に収まるように、それらを小さいものにするようにしてください。
</para>
<sect3 id="HRDC.WrTop.div.21">
<title>例</title>
<para>次に示す注、注意、および警告のマークアップは、<!--Original XRef content: 'Figure&numsp;3&hyphen;1'--><xref role="CodeOrFigureOrTable" linkend="HRDC.WrTop.mkr.8">に示される内容を出力します。</para>
<programlisting>&lt;note>
Before installing your application, complete the options checklist to determine the amount of disk space required.
&lt;/note>
&lt;warning>
This product is highly acidic and can cause skin irritation. Wearing protective gloves is mandatory when applying this product.
&lt;/warning>
&lt;caution>
Do not place your fingers near the parrot cage!
&lt;/caution>
</programlisting>
<figure>
<title id="HRDC.WrTop.mkr.8">注、警告、および注意のヘルプ・アイコン</title>
<graphic id="HRDC.WrTop.grph.1" entityref="HRDC.WrTop.fig.7"></graphic>
</figure>
</sect3>
</sect2>
</sect1>
<sect1 id="HRDC.WrTop.div.23">
<title id="HRDC.WrTop.mkr.9">インライン要素の入力</title>
<para>インライン要素は、テキストのパラグラフ中の単語や語句をマークするときに使用します。これらの要素は、特定の用語の表示に使用されるフォントに影響します。
</para>
<sect2 id="HRDC.WrTop.div.24" role="Procedure">
<title id="HRDC.WrTop.mkr.10">単語や語句を強調表示するには</title>
<para>次のように Emphasis 要素を使用します。</para>
<programlisting>&lt;emphasis><symbol role="Variable">text</symbol> &lt;/emphasis>
</programlisting>
<sect3 id="HRDC.WrTop.div.25">
<title>例</title>
<para>重要な語を強調表示するには、次のようにします。</para>
<programlisting>A thousand times &lt;emphasis>no&lt;/emphasis></programlisting>
</sect3>
</sect2>
<sect2 id="HRDC.WrTop.div.26" role="Procedure">
<title id="HRDC.WrTop.mkr.11">本のタイトルを入力するには</title>
<para>CiteTitle 要素を次のように使用します。</para>
<programlisting>&lt;CiteTitle> <symbol>title of a Book</symbol>&lt;/CiteTitle>
</programlisting>
<sect3 id="HRDC.WrTop.div.27">
<title>例</title>
<para>このガイドのタイトルを入力するには、次のようにします。</para>
<programlisting>&lt;CiteTitle>共通デスクトップ環境 ヘルプ・システム設計者およびプログラマのためのガイド&lt;CiteTitle>
</programlisting>
</sect3>
</sect2>
<sect2 id="HRDC.WrTop.div.26a" role="Procedure">
<title id="HRDC.WrTop.mkr.11a">本のタイトル、章、および節をマークするには</title>
<para>次のように Title 要素を使用します。</para>
<programlisting>&lt;Title> <symbol>title of the Book, Chapter, or Section</symbol>&lt;/Title></programlisting>
<sect3 id="HRDC.WrTop.div.27a">
<title>例</title>
<para>この節のタイトルを入力するには、次のようにします。</para>
<programlisting>&lt;Title>本のタイトル、章、および節をマークするには&lt;/Title>
</programlisting>
</sect3>
</sect2>
<sect2 id="HRDC.WrTop.div.29" role="Procedure">
<title id="HRDC.WrTop.mkr.12">コンピュータ・リテラルを表示するには</title>
<para>コンピュータによってユーザに示されるデータを表示するには、次のように ComputerOutput 要素を使用します。
</para>
<programlisting>&lt;computeroutput> <symbol>text</symbol>&lt;/computeroutput>
</programlisting>
</sect2>
<sect2 id="HRDC.WrTop.div.29a" role="Procedure">
<title id="HRDC.WrTop.mkr.12a">ファイル名を表示するには</title>
<para>コンピュータ・ファイルの名前を表示するには、次に示すように、Filename 要素を使用します。
</para>
<programlisting>&lt;filename><symbol>some filename</symbol>&lt;/filename>
</programlisting>
<sect3 id="HRDC.WrTop.div.30a">
<title>例</title>
<para>マークアップの例を示します。</para>
<programlisting>Add the entity to your &lt;filename>Volume.sgm&lt;/filename> file.
</programlisting>
<para>この例は、次にような表示になります。</para>
<para>Add the entityto your <filename>Volume.sgm</filename> file.</para>
</sect3>
</sect2>
<sect2 id="HRDC.WrTop.div.31" role="Procedure">
<title id="HRDC.WrTop.mkr.13">変数を表示するには</title>
<para>変数を表示するには、次に示すように、Symbol 要素を使用します。</para>
<programlisting>&lt;symbol Role="Variable"> <symbol>text</symbol>&lt;/symbol>
</programlisting>
<sect3 id="HRDC.WrTop.div.32">
<title>例</title>
<para>このコマンド行のシンタクスは、ユーザがファイル名を入力することを示すために変数を使用しています。
</para>
<programlisting>dtpad &lt;symbol Role="Variable">filename&lt;/symbol></programlisting>
<para>これは、次のような表示になります。</para>
<programlisting>dtpad <symbol>filename</symbol></programlisting>
<para>Symbolは、ComputerOutputやProgramListing中で使用することができます。</para>
</sect3>
</sect2>
</sect1>
<sect1 id="HRDC.WrTop.div.33">
<title id="HRDC.WrTop.mkr.14">ハイパーリンクの作成</title>
<para>ハイパーリンクは、ヘルプ・ボリュームの特定のトピックまたは位置を参照します。このためには、参照したい要素に固有のIDが指定されていなければなりません。
</para>
<para>共通の属性をもつすべての DocBook 要素は、IDを割り当てることができます。これらの要素には、Chapter、Sect、Title、List、Graphic、および Table があります。
</para>
<para>ハイパーリンクを作成するには、4つの DocBook 要素を使用します。Link、Anchor、OLink、および XRef です。</para>
<itemizedlist><listitem><para>Link は、ハイパーテキスト・リンクをマークします。Link には、インライン要素を含めることができ、Linkend および Type 属性をもつことができます。
</para>
<para>Linkend 属性は、必須です。これに、Link がリンクされる要素のIDを与えることによってリンク先を指定します。
</para>
<para>Link は、そのIDによって要素を指すことで、SGML のメカニズム IDREF を使用します。Linkend 属性に指定されたIDが処理中のドキュメント・セット中にみつからない場合は、SGML のアプリケーションが、IDREF エラーを出力します。
</para>
<para>Link は、Type 属性の値として、Jump、JumpNewView、AppDefined、および Man をとります。
</para>
<para>Jump リンクは、もっとも共通のタイプのハイパーリンクです。ユーザが Jump リンクを選択すると、置き換えられたトピックが表示されます。
</para>
<para>JumpNewView リンクはボリューム相互の参照のときに使用します。ユーザが JumpNewView リンクを選択すると、情報を含む新規のダイアログが表示されます。
</para>
<para>AppDefined リンクは、アプリケーションの機能を起動するときに使用します。この機能を起動するには、ヘルプが、アプリケーションによって作成されたダイアログ中に表示されていなければなりません。
</para>
<para>Man リンクは、選択されると、システムのコマンドの簡潔なオンラインによる説明である「マニュアル・ページ」を表示します。「マニュアル・ページ」の情報は、DocBook のシステムを通じては提供されません。
</para>
</listitem><listitem><para>Anchor は、リンク先をマークします。Anchor は、ほとんどすべての場所に現われるインライン要素です。Anchor は、内容のない空の要素です。もちろん、IDをもつすべての要素が、リンク先となることができます。
</para>
<para>Anchor には、必須のID属性があります。最低限、Anchor の開始タグは、IDをともなわなければなりません。
</para>
</listitem><listitem><para>Olink は、そのターゲットを検索するために、ある操作を実行します。
</para>
<para>OLink は、すでにユーザによって指定されたテキスト・エンティティまたはデータ・エンティティの名前を値とする TargetDocEnt 属性をもちます。
</para>
<para>OLink は、IDによって便宜的に BookInfo または DocInfo に位置付けられるModeSpec を指す LinkMode 属性をもちます。これは、TargetDocEnt 属性によって名付けられたエンティティを操作するための命令を含みます。たとえば、TargetDocEnt は、別のブックであることができ、LinkMode 属性は、特定の語句を検索するすべての第2レベルのヘッディングを呼び出す ModeSpec を指定します。
</para>
</listitem><listitem><para>XRef は、ドキュメントの別の部分 (Part) への相互参照をマークします。
</para>
<para>Link のように、XRefはLinkend 属性をもちますが、Anchor のように内容をもたないことができます。
</para>
<para>Linkend 属性によって指定される要素の Title は、相互参照のテキストとして使用されます。
</para>
</listitem></itemizedlist>
<sect2>
<title>例</title>
<para>次に示す Link の例は、ホットスポットのラベルを明示的に示します。</para>
<programlisting>To go there,&lt;Link Linkend="H1-122-ch10-1> click here.&lt;/Link>
</programlisting>
<para>このリンクは、セクションを指し、ホットスポットとしてそのタイトルを表示します。
</para>
<programlisting>Click to go to &lt;Link Linkend="S1-123-ch12-1" Endterm="T1-123-ch12-1">&lt;/Link>
</programlisting>
<para>次の例は、ID "ch05-s1" をもつドキュメントのセクションを参照し、そのタイトルを表示します。
</para>
<programlisting>See &lt;Xref Linkend="ch05-s1"> for more information.</programlisting>
<para>これは、"See <citetitle>Terminal Emulation and Terminal Type</citetitle> for more information."のように表示されます。</para>
<para>この文章には、Anchor <symbol>&lt;anchor id=&ldquo;077-ch02-AN-7&rdquo;></symbol> があります。</para>
</sect2>
<sect2 id="HRDC.WrTop.div.44" role="Procedure">
<title id="HRDC.WrTop.mkr.16">定義リンクを作成するには</title>
<para>用語集にある用語へリンクする場合は、GlossTerm 要素を、次のように使用します。
</para>
<programlisting>&lt;GlossTerm><symbol>text</symbol>&lt;/GlossTerm></programlisting>
<para>テキスト中で GlossTerm 要素を使用するときは、必ず、その用語の定義を与える GlossEntry を取り込むようにしてください。
</para>
</sect2>
</sect1>
<sect1 id="HRDC.WrTop.div.64">
<title id="HRDC.WrTop.mkr.23">グラフィックの表示</title>
<para>ヘルプは4つのグラフィック・フォーマットをサポートします。
</para>
<itemizedlist><listitem><para><emphasis>Tagged Image File Format (TIFF)</emphasis>多くの標準的な描画およびスキャン・アプリケーションによって作成される色、グレースケール、および白黒のイメージです。
(<symbol role="Variable">filename</symbol><filename>.tif</filename>)
</para>
</listitem><listitem><para><emphasis>Xウィンドウ・ダンプ</emphasis><command>xwd</command> ユーティリティによって作成される X Window System&trade; のスクリーン・ダンプです。
(<symbol role="Variable">filename</symbol><filename>.xwd</filename>)
</para>
</listitem><listitem><para><emphasis>Xピックスマップ</emphasis>カラーのアイコン・イメージです。
(<symbol role="Variable">filename</symbol><filename>.pm</filename>)
</para>
</listitem><listitem><para><emphasis>Xビットマップ</emphasis>2色のアイコン・イメージです。
(<symbol role="Variable">filename</symbol><filename>.bm</filename>)
</para>
</listitem></itemizedlist>
<para>各グラフィックは、分離されたファイルとして保守されます。ファイル形式は、上記のファイル名拡張子によって決定されます。
</para>
<para>Graphic 要素は、その属性を通じて、グラフィック・データを含む外部ファイルを指します。
</para>
<para>Graphic は、Figure 内部に含めることができます。Figure には、Title がなければならず、Link を含むことができます。
</para>
<para>Graphic は、線ではなく、オブジェクトとして描画されるべきです。インライン・オブジェクトについては、InlineGraphic 要素を使用します。
</para>
<para>Graphic は、Fileref、Entityref、およびID属性をもちます。</para>
<para>Fileref 属性の値は、必要ならばパス名を付加したファイル名でなければなりません。
</para>
<para>Entityref 属性の値は、外部データ・エンティティでなければなりません。
</para>
<sect2 id="HRDC.Ref.div.">
<title>シンタクス</title>
<para>次に示すのは、Graphic のシンタックスの例です。</para>
<programlisting>&lt;graphic id="ABUG.edprp.igrph.1" entityref="ABUG.edprp.fig.1">&lt;/graphic>
&lt;graphic id="ABUG.crobj.igrph.2" entityref="ABUG.crobj.fig.2">&lt;/graphic>
&lt;graphic id="ABUG.crobj.igrph.1" entityref="ABUG.crobj.fig.1">&lt;/graphic>
</programlisting>
</sect2>
<sect2 id="HRDC.WrTop.div.65" role="Procedure">
<title id="HRDC.WrTop.mkr.24">図を作成するには</title>
<orderedlist><listitem><para>Figure に含まれる Graphic 中に取り込むイメージ・ファイルを識別するために、ファイル・エンティティを宣言します。
</para>
<programlisting>&lt;!entity <symbol role="Variable">graphic-entity</symbol> SYSTEM &ldquo;<symbol role="Variable">filename.ext</symbol>&rdquo;></programlisting>
</listitem><listitem><para>Use the Graphic element as shown:</para>
<programlisting>&lt;Graphic id="<symbol>id</symbol>"> entityref=" <symbol>graphic-entity</symbol>"&lt;Graphic></programlisting>
<para><symbol role="Variable">graphic-entity</symbol> は、表示するグラフィック・ファイルのエンティティ名です。
</para>
</listitem></orderedlist>
<para>Figure をハイパーリンクにする場合には、Graphic の代わりに InlineGraphic を使用し、Link 要素内にそれを指定します。
</para>
</sect2>
</sect1>
<sect1 id="HRDC.WrTop.div.73">
<title id="HRDC.WrTop.mkr.27">特殊文字の表示</title>
<para>DocBook では、多くの特殊文字と記号を使用できます。適切なエンティティの参照を入力することで、特定の文字を表示できます。
</para>
<para>使用できる文字の完全なリストについては、<!--Original XRef content: 'Chapter&numsp;6, &ldquo;Summary of Special Character Entities'--><xref role="ChapNumAndTitle" linkend="HRDC.ChEnt.mkr.1">を参照してください。
</para>
<sect2 id="HRDC.WrTop.div.74" role="Procedure">
<title id="HRDC.WrTop.mkr.28">特殊文字を取り込むには</title>
<orderedlist><listitem><para>表示する文字のエンティティ名を決定するには、<!--Original XRef content: 'Chapter&numsp;6, &ldquo;Summary of Special Character Entities'--><xref role="ChapNumAndTitle" linkend="HRDC.ChEnt.mkr.1">を参照してくださいい。
</para>
</listitem><listitem><para>どの ISO エンティティ・ファイルが特殊文字を含むかを決定し、ユーザの他のエンティティ宣言中に、次の2行を追加します。(ここで <symbol>entity-name</symbol> はユーザにとって意味がある名前です。):</para>
<programlisting>&lt;!entity &amp; <symbol role="Variable">ISOset</symbol> PUBLIC "<symbol role="Variable">ISOsetpublicID</symbol>">
% ISOset;
</programlisting>
</listitem><listitem><para>特殊文字を表示する場合は、必ずそのエンティティ参照を入力するようにしてください。
</para>
<programlisting>&amp;<symbol role="Variable">entity-name</symbol>;</programlisting>
</listitem></orderedlist>
<sect3 id="HRDC.WrTop.div.75">
<title>例</title>
<para>著作権の記号 (&copy;) のエンティティは、ISO numeric set に含まれるので、まず ISO numeric set を(他のエンティティ宣言とともにヘルプ・ボリュームのトップに)、次に示すように取り込まなければなりません。
</para>
<programlisting>&lt;!ENTITY % ISOnumeric PUBLIC "ISO 8879-1986//ENTITIES Numeric and Special Graphic//EN">
%ISOnumeric;</programlisting>
<para>このようにすれば、著作権の記号が現われる場所で、次に示すエンティティ参照を指定することができます。
</para>
<programlisting>&amp;copy;</programlisting>
<para>大文字のギリシャ文字のシグマ (&sum;) を表示するには、まず ISO Greek エンティティを(他のエンティティ宣言とともにヘルプ・ボリュームのトップに)、次に示すように取り込まなければなりません。
</para>
<programlisting>&lt;!ENTITY % ISOgreek PUBLIC "ISO 8879-1986//ENTITIES Greek Symbols//EN">
%ISOgreek;</programlisting>
<para>このようにすれば、シグマ文字が現われる場所で、次に示すエンティティ参照を指定することができます。
</para>
<programlisting>&amp;Sigma;</programlisting>
<para>すべてのエンティティと同じように、特殊文字のエンティティ名についても、大文字と小文字の区別はありません。
</para>
</sect3>
</sect2>
</sect1>
<sect1 id="HRDC.WrTop.div.77">
<title id="HRDC.WrTop.mkr.29">作成者のコメントの取り込み</title>
<para>ソース・ファイルの中に、ヘルプ・テキストの一部にはならないコメントを入れておくと、とても便利です。コメント要素でマークされたテキストは、DocBook ソフトウェアには、常に無視されます。コメントは、自分自身や他の設計者への注意書きを付けたり、あるマークアップをファイルから取り出さずに除外するのに使用できます。
</para>
<para>Comment は、ドキュメント中のほとんどあらゆる場所に現われ、パラグラフや他のブロック指向の要素を含むことができますが、Comment を別の Comment の内部にネストすることはできません。
</para>
<sect2 id="HRDC.Ref.div.3">
<title>シンタクス</title>
<programlisting>&lt;comment>
<symbol role="Variable">comment text here</symbol>
&lt;/comment></programlisting>
</sect2>
<sect2 id="HRDC.WrTop.div.78" role="Procedure">
<title id="HRDC.WrTop.mkr.30">コメントを挿入するには</title>
<para>コメントの開始マーカ &lt;Comment> と終了マーカ &lt;/Comment> を、次のように使用します。
</para>
<programlisting>&lt;comment>
<symbol role="Variable">comment text here</symbol>
&lt;/comment></programlisting>
<sect3 id="HRDC.WrTop.div.79">
<title>例</title>
<para>次の例には、2つのコメントがあります。ひとつは段落の前の行で、もうひとつはパラグラフ中の語です。
</para>
<programlisting>&lt;Comment>Here is my rough draft of the introduction: &lt;/Comment>
Welcome to my application. This software
is &lt;Comment>perhaps&lt;/Comment>the fastest and most
efficient software you'll ever own.
</programlisting>
</sect3>
</sect2>
</sect1>
<sect1 id="HRDC.WrTop.div.82">
<title id="HRDC.WrTop.mkr.32">索引の作成</title>
<para>ヘルプ・ボリュームの索引は、書籍の索引と類似しています。設計者にとって、トピッックの索引エントリを作成することは大切です。それによって、ユーザがキーワードや概念で検索することができます。詳細な索引が作成されていると、ユーザはすばやく正確にトピックをみつけることができます。
</para>
<para>DocBook マークアップでは、IndexTerm が、索引に含めたいヘルプ・ボリューム中の単語や語句のためのタグです。IndexEntry は、IndexTerm への参照をもつ索引中の要素です。したがって、IndexEntry は、IndexTerm の抽出と処理によって構築されます。
</para>
<para>IndexTerm は、索引に追加する単語や語句です。IndexTerm は、テキストのほとんどあらゆる場所に現われますが、テキストそれ自身の一部ではありません。すなわち、IndexTerm の内容は、テキストそれ自身の中には表示されません。
</para>
<para>IndexTerm は、Primary を含まなければなりません。これは、Secondary の他に、See および、ひとつまたは複数の SeeAlso を含むことができます。さらに、Secondary は、Tertiary の他に、See および、ひとつまたは複数の SeeAlso を含むことができます。
</para>
<para>IndexTerm は、Common 属性をもち、SpanEnd および Significance 属性ももちます。
</para>
<para>SpanEnd 属性をともなう空の IndexEntry は、それよりも前にある内容をもつ IndexTerm の場所で開始されたテキストの範囲の終了をマークするために使用されます。SpanEnd 属性の値は、それよりも前にある IndexTerm のIDと同一でなければなりません。
</para>
<para>Significance 属性は、IndexTerm が一連の語句のもっとも重要な語句であることを示す値 Preferred または Normalデフォルトをとります。
</para>
<sect2 id="HRDC.WrTop.div.83" role="Procedure">
<title id="HRDC.WrTop.mkr.33">索引エントリをマークするには</title>
<para>索引に入れたいトピックにの中で、IndexTerm 要素を次のように使用します。
</para>
<programlisting>&lt;para>This text deals with two subjects that should be listed in the index: how to rotate your terminal and how to adjust its height.&lt;/para>
&lt;IndexTerm>
&lt;Primary>rotating your terminal&lt;/Primary>
&lt;/IndexTerm>
&lt;IndexTerm>
&lt;Primary>terminal
&lt;Secondary>rotation of&lt;/Secondary>
&lt;/Primary>
&lt;/IndexTerm>
&lt;IndexTerm>
&lt;Primary>terminal
&lt;Secondary>adjustment of&lt;/Secondary>
&lt;SeeAlso>troubleshooting&lt;/SeeAlso>
&lt;/Primary>
&lt;/IndexTerm></programlisting>
</sect2>
</sect1>
<sect1 id="HRDC.WrTop.div.85">
<title id="HRDC.WrTop.mkr.34">用語集の作成</title>
<para>書籍の用語集のように、重要な用語を定義する用語集を、ヘルプ・ボリュームに入れることができます。用語集は、Glossary 要素でマークされ、ヘルプ・ボリュームの最後のトピックになります。用語集は、&lt;GlossTerm> タグでマークされたすべての用語のための定義を含みます。
</para>
<para>Glossary は、次に示すコンポーネントを、次に示す順序で含みます。
</para>
<itemizedlist><listitem><para>Title (任意)</para>
</listitem><listitem><para>TitleAbbrev (任意)</para>
</listitem><listitem><para>ひとつまたは複数の GlossEntries</para>
</listitem></itemizedlist>
<sect2 id="HRDC.WrTop.div.87" role="Procedure">
<title id="HRDC.WrTop.mkr.35">用語集の用語をマークするには</title>
<para>GlossTerm タグは、用語集に登録されるドキュメントのテキスト中の用語をマークするために使用します。また、GlossTerm 要素は、用語集内の GlossEntry に用語が現われるように、それらの用語を含むためにも使用されます。
</para>
<para>GlossTerm 要素とともに入力する各キーワードや語句は、自動的に、用語集の用語の定義へのリンクになります。
</para>
</sect2>
<sect2 id="HRDC.WrTop.div.89" role="Procedure">
<title id="HRDC.WrTop.mkr.36">用語集の用語を定義するには</title>
<para>用語は、用語集で、GlossEntry 要素を使用することによって定義します。GlossEntry は、必須の GlossTerm、任意の Acronym、および任意の Abbrev をこの順に含みます。この後、順序には関係なく、GlossSee と GlossDef を、いくつでも続けることができます。
</para>
<para>GlossDef は、GlossEntry 中の GlossTerm の定義です。これは、順序に関係なく、Comments、GlossSeeAlso、パラグラフおよび他のブロック指向の要素を含みます。
</para>
<para>GlossDef は、Common 属性をもち、Subject 属性ももちます。Subject 属性には、空白のみで区切られたキーワードとして、サブジェクト領域のリストがあります。
</para>
<sect3 id="HRDC.WrTop.div.90">
<title>シンタクス</title>
<programlisting>&lt;Glossary>
...
&lt;GlossEntry>
&lt;GlossTerm>
<symbol>term</symbol>
&lt;/GlossTerm>
&lt;GlossDef>
<symbol>text of definition</symbol>
&lt;/GlossDef>
&lt;/GlossEntry>
...
&lt;/Glossary></programlisting>
</sect3>
</sect2>
</sect1>
</chapter>
<!--fickle 1.14 mif-to-docbook 1.7 01/02/96 16:48:20-->
<?Pub *0000043237>

View File

@@ -0,0 +1,405 @@
<!-- $XConsortium: ch04.sgm /main/15 1996/10/22 14:42:40 cdedoc $ -->
<!-- (c) Copyright 1995 Digital Equipment Corporation. -->
<!-- (c) Copyright 1995 Hewlett-Packard Company. -->
<!-- (c) Copyright 1995 International Business Machines Corp. -->
<!-- (c) Copyright 1995 Sun Microsystems, Inc. -->
<!-- (c) Copyright 1995 Novell, Inc. -->
<!-- (c) Copyright 1995 FUJITSU LIMITED. -->
<!-- (c) Copyright 1995 Hitachi. -->
<chapter id="HRDC.CrHV.div.1">
<title id="HRDC.CrHV.mkr.1">ヘルプ・ボリュームの処理と表示</title>
<para>この章では、ヘルプ・システムをオンライン形式で表示するために作成するマークアップしたヘルプ・ファイルの処理方法を説明します。また、デスクトップのフロントパネルのヘルプ・ビューアからヘルプ・ボリュームにアクセスする方法も説明します。
</para>
<informaltable id="HRDC.CrHV.itbl.1" frame="All">
<tgroup cols="1">
<colspec colname="1" colwidth="4.0 in">
<tbody>
<row rowsep="1">
<entry><para><!--Original XRef content: 'Creating Run-Time Help Files89'--><xref
role="JumpText" linkend="HRDC.CrHV.mkr.2"></para></entry>
</row>
<row rowsep="1">
<entry><para><!--Original XRef content: 'To Create a Run-Time Help Volume89'--><xref
role="JumpText" linkend="HRDC.CrHV.mkr.3"></para></entry>
</row>
<row rowsep="1">
<entry><para><!--Original XRef content: 'Viewing a Help Volume92'--><xref
role="JumpText" linkend="HRDC.CrHV.mkr.6"></para></entry>
</row>
<row rowsep="1">
<entry><para><!--Original XRef content: 'To Display a Help Volume92'--><xref
role="JumpText" linkend="HRDC.CrHV.mkr.7"></para></entry>
</row>
<row rowsep="1">
<entry><para><!--Original XRef content: 'Adding Your Help to the Index Volume94'--><xref
role="JumpText" linkend="HRDC.CrHV.mkr.8"></para></entry>
</row>
<row rowsep="1">
<entry><para><!--Original XRef content: 'Printing Help Topics98'--><xref role="JumpText"
linkend="HRDC.CrHV.mkr.13"></para></entry>
</row>
<row rowsep="1">
<entry><para><!--Original XRef content: 'Testing Your Help99'--><xref role="JumpText"
linkend="HRDC.CrHV.mkr.15"></para></entry>
</row>
</tbody>
</tgroup>
</informaltable>
<sect1 id="HRDC.CrHV.div.2">
<title>概要</title>
<para>ヘルプ・ボリュームを表示するには、DocBook ソフトウェアでファイルを処理し、実行時のヘルプ・ファイルを作成しなければなりません。実行時のファイルは、<emphasis>セマンティッック・デリバリ言語 (SDL - Semantic Delivery Language)</emphasis> と呼ばれるオンライン・プレゼンテーション形式を使用します。実行時のヘルプ・ファイルは、ファイル記述子 <filename>.sdl</filename> で識別できます。
</para>
<para>ユーティリティ <command>dtdocbook</command> は、DocBook 2.2.1 文書型定義 (DTD) の副要素 Part に準拠するドキュメントを受け取り、DtHelp ビューアの入力になることができる SDL 1.2 文書型定義 (DTD) に準拠するドキュメントを出力します。
</para>
<para>翻訳では、ドキュメントの実行時の表示速度を向上させるために、いくつかの項目が事前に処理されます。これらの項目には、目次、キーワード索引、相互参照の解決、および順序付けされたリストのラベル付けがあります。翻訳によって出力される SDL に準拠したドキュメントは、デフォルトで圧縮されます。
</para>
<graphic id="HRDC.CrHV.igrph.1" entityref="HRDC.CrHV.fig.1"></graphic>
<para>ヘルプ・システムは、ヘルプ固有ファイルのデスクトップでのアクションとデータ型を定義します。これにより、デスクトップから実行時のヘルプ・ファイルを簡単に処理および表示できます。
</para>
<sect2 id="HRDC.CrHV.div.3">
<title>DocBookソフトウェア</title>
<para>DocBookソフトウェアは、ファイル・マネージャでヘルプのソース・ファイルをダブルクリックすると自動的に起動されます。または、手動で <command>dtdocbook</command> コマンドを端末ウィンドウで実行すると起動されます。
</para>
<para><command>dtdocbook</command> には、2つの重要なタスクがあります。
</para>
<orderedlist><listitem><para>DocBook の<emphasis>パーサ</emphasis>は、マークアップされたファイルを、ヘルプ・システムが理解できる内部形式(セマンティック・デリバリ言語)に変換します。マークアップにエラーがある場合は、<symbol role="Variable">volume</symbol><filename>.log</filename> というファイルにエラーが報告されます。</para>
</listitem><listitem><para>パーサのエラーがない場合は、マスタのヘルプ・ボリューム・ファイル (<symbol role="Variable">volume</symbol><filename>.sdl</filename>) が作成されます。
</para>
</listitem></orderedlist>
</sect2>
<sect2 id="HRDC.CrHV.div.4">
<title>ボリュームの表示</title>
<para>DocBook でのソース・ファイルの処理が終了すると、いつでもヘルプ・ボリュームを表示できます。表示するには、ファイル・マネージャで、<symbol role="Variable">volume</symbol><filename>.sdl</filename> のファイル・アイコンをダブルクリックするか、端末ウィンドウで <command>dthelpview</command> コマンドを使用します。
</para>
<graphic id="HRDC.CrHV.igrph.2" entityref="HRDC.CrHV.fig.2"></graphic>
<para>アプリケーション用のヘルプを記述していて、そのアプリケーションが使用できる状態であれば、アプリケーションを実行してヘルプを呼び出せば、ヘルプを表示できます。
</para>
</sect2>
</sect1>
<sect1 id="HRDC.CrHV.div.5">
<title id="HRDC.CrHV.mkr.2">実行時のヘルプ・ファイルの作成</title>
<para><command>dtdocbook</command> を実行すると、<symbol role="Variable">volume</symbol><filename>.sgm</filename> ファイル、および、エンティティを使用して指定された追加ファイルを読み取ります。また、使用するグラフィック・ファイルが存在するかどうかも確認します。
</para>
<para>検索パスに <command>/usr/dt/bin/dtdocbook</command> コマンドがあることを確認してください。(確認方法がわからない場合には、システム管理者に問い合わせてください。)
</para>
<sect2 id="hrdc.crhv.div.6" role="Procedure">
<title id="hrdc.crhv.mkr.3">実行時のヘルプ・ボリュームを作成するには</title>
<orderedlist><listitem><para>ファイル・マネージャを開き、ディレクトリを <symbol role="Variable">volume</symbol><filename>.sgm</filename> ファイルのあるディレクトリに変更します。
</para>
<graphic id="hrdc.crhv.igrph.3" entityref="HRDC.CrHV.fig.3"></graphic>
</listitem><listitem><para>ファイル・アイコンを選択します。
</para>
</listitem><listitem><para>ファイル・マネージャの[選択]メニューで[コンパイル]を選択します。
</para>
<para><symbol role="Variable">volume</symbol><filename>.sgm</filename> ファイルが処理され、<symbol role="Variable">volume</symbol><filename>.sdl</filename> ファイルと <symbol role="Variable">volume</symbol><filename>.log</filename> ファイルが作成されます。</para>
</listitem></orderedlist>
</sect2>
<sect2 id="HRDC.CrHV.div.7">
<title>DocBook の出力</title>
<para>DocBook は、その入力として、<symbol role="Variable">volume</symbol><filename>.sgm</filename> を受け取り、いくつかのファイルを出力します。
</para>
<itemizedlist><listitem><para>もっとも重要なのは、最終的な出力ファイルが、<symbol role="Variable">volume</symbol><filename>.sdl</filename> という名前の実行時ヘルプ・ボリュームであることです。</para>
</listitem><listitem><para>処理中にエラーが発生すると、それらは、<symbol role="Variable">volume</symbol><filename>.log</filename> という名前のエラー・ファイルに報告されます。これは、通常、使用後に削除します。</para>
</listitem></itemizedlist>
<para><symbol role="Variable">volume</symbol><filename>.sdl</filename> ファイルは、ソース・ファイルのエラーがなくなるまで作成されません。
</para>
<para><symbol role="Variable">volume</symbol><filename>.sdl</filename> ファイル、およびユーザのグラフィック・ファイルは、ヘルプ・トピックを表示するために、ヘルプ・システムによって読み込まれます。
</para>
<para>実行時のヘルプ・ファイルは、ユーザの <symbol role="Variable">volume</symbol><filename>.sgm</filename> ファイルと同じベース名をもちます。たとえば、ユーザのソース・ファイルの名前が、<filename>Librarian.sgm</filename> ならば、ヘルプ・ボリュームの名前は、<filename>Librarian.sdl</filename> になります。</para>
<para><command>dtdocbook</command> ユーティリティは、引き数として単一のファイルを受け付けます。ファイル名が、&ldquo;<filename>.sgm</filename>&rdquo; という文字列で終わっていれば、これらの文字列がファイル名の拡張子であることが仮定され、すべての中間ファイル、および最終的な出力ファイルのファイル・ベース名を作成するために、削除されます。
</para>
<para>既存の SDL ファイルの圧縮や伸張を要求するために、<command>dtdocbook -c</command> または <command>dtdocbook -d</command> オプションを指定する場合、入力ファイル名は、ldquo;<filename>.sdl</filename>&rdquo; という文字列で終わります。もう一度、繰り返すと、これらの文字列はファイル名の拡張子と仮定され、すべての中間ファイルおよび最終的な出力ファイルのファイル・ベース名を作成するために、削除されます。
</para>
<para><command>-c</command> オプションが指定され、そのファイルがすでに圧縮されている場合、ファイルは伸張されてから圧縮されます。このアクションは、圧縮された SDL ファイルの集積状態を検証する手段として有用です。
</para>
<para><command>-d</command> が指定され、そのファイルがすでに伸張されている場合、、再度の解析とすべての事前計算処理の実行が行われ、ファイルは再度書き込まれます。このアクションは、SDL ファイルの集積状態を検証する手段として有用です。また、たとえば、SDL ファイルを直接編集したことによって再計算が必要になった場合に、個別のヘルプ・トピックのバイト・オフセットを含むそのような再計算を強制的に実行するときにも有用です。
</para>
<para>最終的なファイル名の拡張子は、常に &ldquo;<filename>.sdl</filename>&rdquo; になります。<command>dtdocbook -o</command> オプションが指定された場合には、<command>dtdocbook -o</command> への引き数 <symbol role="Variable">filename</symbol> が、与えられた出力ファイル名として使用されます。
</para>
<caution>
<para><command>dtdocbook</command> を実行した後で、実行時ヘルプ・ファイルやグラフィック・ファイルの名前を、決して変更してはいけません。<symbol role="Variable">volume</symbol><filename>.sdl</filename> ファイルに格納された情報は、元の名前に依存します。<symbol role="Variable">volume</symbol><filename>.sgm</filename> ファイルやグラフィック・ファイルの名前を変更した場合は、必ず、<command>dtdocbook</command> を再実行してください。
</para>
</caution>
</sect2>
<sect2 id="HRDC.CrHV.div.8" role="Procedure">
<title>手動で dtdocbook コマンドを実行するには</title>
<itemizedlist><listitem><para><command>dtdocbook</command> コマンドは、次のように実行します。
</para>
<para><command>dtdocbook</command> <symbol>options</symbol> <symbol>volume</symbol></para>
<para><symbol>options</symbol> が、<symbol>volume</symbol> 名の前にあることをみてください。<xref role="SecTitleAndPageNum" linkend="HRDC.CmdS.mkr.2"> には、すべての有効なオプションをリストされています。</para>
</listitem></itemizedlist>
<sect3 id="HRDC.CrHV.div.9">
<title>コマンド Options.sgm の例</title>
<para>次のコマンドは、<filename>MyVolume</filename> という名前のヘルプ・ボリュームを処理します。</para>
<programlisting>dtdocbook MyVolume</programlisting>
<para><command>-r</command> オプションを使用すると、<filename>MyVolume.sgm</filename> というソース・ファイルを処理することによって生成されたすべてのファイルが削除されます。
</para>
<programlisting>dtdocbook -r MyVolume.sgm</programlisting>
<para>次のコマンドは、<filename>MyVolume.sgm</filename> という名前のソース・ファイルを処理し、結果を <filename>Other_File.sdl</filename> という名前のファイルに出力します。</para>
<programlisting>dtdocbook -o Other_File.sdl MyVolume.sgm</programlisting>
<para><command>-v</command> オプションを使用すると、進行状況が画面に表示されます。
</para>
<programlisting>dtdocbook -v MyVolume</programlisting>
</sect3>
<sect3 id="HRDC.CrHV.div.11">
<title>関連項目</title>
<itemizedlist remap="Bullet1"><listitem><para><xref role="ChapNumAndTitle"
linkend="HRDC.Inst.mkr.1"> は、アプリケーション・インストール・パッケージにどのヘルプ・ファイルが含まれているかを説明しています。
</para>
</listitem></itemizedlist>
</sect3>
</sect2>
<sect2 id="HRDC.CrHV.div.12" role="Procedure">
<title id="HRDC.CrHV.mkr.5">パーサ・エラーをレビューおよび修正するには</title>
<para>最初のエラー・メッセージは、SGML パーサから出力されます。これらのほとんどは、SGML のシンタクスに関するエラー・メッセージですが、「ファイルがみつからない」という種類のものもあります。
</para>
<para>ソース・ファイルを SGML から SDL に翻訳する処理の2つのパスも、シンタクスに関するエラー・メッセージや「ファイルがみつからない」というメッセージを生成しますが、件数は多くありません。2つのパスのうち2番目のパスは、まれにしかエラー・メッセージを発行しません。すべてのシンタクスと内容は、それまでにチェックされてしまうからです。
</para>
<para><command>dtdocbook</command> を実行後、<symbol role="Variable">volume</symbol><filename>.log</filename> ファイル(ここで <symbol role="Variable">volume</symbol> は、ユーザの<symbol role="Variable">volume</symbol><filename>.sgm</filename> ファイルのベース名です)の内容をみてください。</para>
<para>ひとつの単純なエラーが、数個のエラー・メッセージを出力する可能性は、おおいにあります。なぜなら、エラーによって、パーサが意図したコンテキストの解析順序を失い、引き続くマークアップを適切に解釈することが不可能になるからです。
</para>
<sect3 id="HRDC.CrHV.div.13">
<title>一般的なエラー</title>
<para>処理エラーのほとんどは、以下の一般的なミスによるものです。
</para>
<itemizedlist><listitem><para>終了タグの付け忘れ</para>
</listitem><listitem><para>間違ったエンティティ名の使用</para>
</listitem><listitem><para>無効な要素IDの参照</para>
</listitem></itemizedlist>
<para>要素に終了タグを付け忘れるのは、よくあるミスです。<emphasis>事実上、すべての DocBook の要素には、終了タグが必要です。</emphasis>リスト内の図のように、複雑な要素を別の要素内に、構造的にネストする場合は、マークアップをチェックしてください。
</para>
<para>また、不正確なエンティティ名を使用するとエラーが出力されます。ほとんどの場合、これは単純なスペルミスです。ある場合には、エンティティ名が変更されているにもかかわらず、元の名前への相互参照が、エラーの原因となります。エンティティ名を変更した場合には、ソース・ファイルを検索して、すべてのエンティティ名のインスタンスをチェックすることを忘れないでください。
</para>
<para>また、要素に割り当てられたIDを変更すると、あらゆる相互参照やトピックへのリンクに影響するため、エラーが出力されることがあります。IDを変更した場合には、ソース・ファイルを検索して、そのIDのすべてのインスタンスをチェックすることを忘れないでください。
</para>
</sect3>
</sect2>
</sect1>
<sect1 id="HRDC.CrHV.div.14">
<title id="HRDC.CrHV.mkr.6">ヘルプ・ボリュームの表示</title>
<para>ヘルプ・ビューアは、どのヘルプ・ボリュームでも表示できます。ヘルプ・ビューアは、アプリケーション定義リンクを除く(これはユーザのリンクをどのように解釈すべきかわからないためです)すべての型のハイパーリンクをサポートしています。
</para>
<para>アプリケーション用ヘルプを記述していて、そのアプリケーションが使用できる状態であれば、アプリケーションを実行し、ユーザが操作するようにヘルプを呼び出せば、ヘルプを表示できます。
</para>
<sect2 id="HRDC.CrHV.div.15" role="Procedure">
<title id="HRDC.CrHV.mkr.7">ヘルプ・ボリュームを表示するには</title>
<orderedlist><listitem><para>ファイル・マネージャを開き、ディレクトリを <symbol role="Variable">volume</symbol><filename>.sdl</filename> ファイルのあるディレクトリに移動します。
</para>
</listitem><listitem><para>アイコンをダブルクリックします。</para>
<para>デフォルトでは、ヘルプ・ビューアを使用してファイルが表示されます。
</para>
</listitem></orderedlist>
<sect3 id="HRDC.CrHV.div.16" role="Procedure">
<title>手動で dthelpview コマンドを実行するには</title>
<itemizedlist><listitem><para>表示したいボリュームの <symbol role="Variable">volume</symbol><filename>.sdl</filename> ファイルが、現在のディレクトリにあるか、または登録されている場合は、次のコマンドを実行します。
</para>
<para><command>dthelpview -helpVolume <symbol role="Variable">volume</symbol><filename>.sdl</filename></command></para>
<para><emphasis>あるいは、</emphasis><symbol role="Variable">volume</symbol><filename>.sdl</filename> が別のディレクトリにある(そして未登録である)場合は、次のコマンドを実行します。
</para>
<para><command>dthelpview -helpVolume /<symbol>full-path</symbol>/ <symbol>volume</symbol>.sdl</command></para>
</listitem></itemizedlist>
<para>これらのコマンドで、<command>-helpVolume</command> パラメータは、短縮して <command>-h</command> にすることができます。
</para>
</sect3>
<sect3 id="HRDC.CrHV.div.17">
<title>例</title>
<para>ヘルプ・ボリュームを編集したばかりとしましょう。まず、DocBook ソフトウェアで、これを処理します。
</para>
<programlisting>dtdocbook MyVolume.sgm</programlisting>
<para>エラーがなければ、次のコマンドで表示することができます。
</para>
<programlisting>dthelpview -h MyVolume.sdl</programlisting>
</sect3>
<sect3 id="HRDC.CrHV.div.18">
<title>関連項目</title>
<itemizedlist><listitem><para><xref role="SecTitleAndPageNum" linkend="HRDC.Inst.mkr.9"></para>
</listitem></itemizedlist>
</sect3>
<sect3 id="HRDC.CrHV.div.19">
<title>例: 個人用ヘルプ・ディレクトリ</title>
<para>プロジェクト期間中に、自分が開発しているヘルプ・ボリュームにアクセスしたいけれども、システムのすべてのユーザに公開したくはない場合があります。たとえば、作業ディレクトリが、<filename>/projects/help</filename> で、ヘルプ・ボリュームが <filename>Myvolume</filename> という名前だとします。</para>
<para>まず、ボリュームを登録できるホーム・ディレクトリに個人用ヘルプ・ディレクトリを作成します。
</para>
<programlisting>mkdir -p $HOME/.dt/help/C</programlisting>
<para>次にDocBook ソフトウェアによって作成される)<filename>Myvolume.sdl</filename> ファイルへのシンボリック・リンクを作成します。
</para>
<programlisting>ln -s /projects/help/Myvolume.sdl $HOME/.dt/help/C/Myvolume.sdl
</programlisting>
<para>これで(現在のディレクトリとは無関係に)ボリュームを次のコマンドで表示できます。これは、ホーム・ディレクトリ内の <filename>.dt/help/C</filename> ディレクトリは、ヘルプ・システムがヘルプ・ボリュームを検索するときに最初に参照するからです。
</para>
<programlisting>dthelpview -helpVolume Myvolume.sdl</programlisting>
</sect3>
</sect2>
</sect1>
<sect1 id="HRDC.CrHV.div.20">
<title id="HRDC.CrHV.mkr.8">索引ボリュームへのヘルプの追加</title>
<para>デスクトップは、索引ボリュームと呼ばれる特別なヘルプ・ボリュームを提供しています。索引ボリュームには、システムで使用可能なヘルプ・ボリュームがリストされます。索引ボリュームは、フロントパネルで、[ヘルプ・ビューア]コントロールをクリックすると表示されます。
</para>
<para>索引ボリュームから各種のヘルプ・ボリュームを直接表示できます。これにより、アプリケーションを起動しなくても、アプリケーション固有のヘルプにアクセスできます。また、スタンドアロン・ヘルプを記述している場合は、ユーザがそのヘルプを得られる唯一の方法です。
</para>
<figure>
<title id="HRDC.CrHV.mkr.9">ヘルプ・ファミリを表示する索引ヘルプ・ボリューム</title>
<graphic id="HRDC.CrHV.grph.1" entityref="HRDC.CrHV.fig.4"></graphic>
</figure>
<para>ヘルプ・ボリュームを索引ボリュームで使用可能にするには、ヘルプ・ファミリ・ファイルを作成します。アプリケーションがデスクトップに登録されている場合には、ファミリ・ファイルの存在によって、ヘルプ・ボリュームが索引ボリュームに取り込まれます。
</para>
<sect2 id="HRDC.CrHV.div.21">
<title id="HRDC.CrHV.mkr.10">索引ボリューム</title>
<para>デスクトップ・ユーティリティは、索引ボリュームの作成および更新を行います。ユーザが、初めてフロントパネルのヘルプ・ビューアをクリックすると、ユーティリティが自動的に実行されます。これは、ヘルプ検索パスのディレクトリにあるヘルプ・ボリュームとヘルプ・ファミリ・ファイルを識別します。ユーザの <filename>HomeDirectory/.dt/help/$DTUSERSESSION</filename> ディレクトリにある <filename>index.hv</filename> と呼ばれるファイルを作成します。初期作成後は、ボリュームは変更が発生したときのみ更新されます。
</para>
<para>索引ボリュームを手動で更新するには、<xref role="SecTitleAndPageNum" linkend="HRDC.CmdS.mkr.5"> を参照してください。</para>
<para>索引ボリュームにリストされたどのヘルプ・ボリュームも、ボリューム・タイトルを選択することによって表示することができます。複数の異なるボリュームを表示して、その間を移動できるため、索引ヘルプのウィンドウには、[トップレベル]と呼ばれるボタンが追加されます。このボタンを使用して、ひとつまたは複数のボリュームを表示した後、索引リストに戻ることができます。
</para>
</sect2>
<sect2 id="HRDC.CrHV.div.22">
<title>ヘルプ・ファミリ・ファイル</title>
<para>デスクトップ・ユーティリティは、どのヘルプ・ボリュームが索引ボリュームに集められているか識別するために、ヘルプ・ファミリ・ファイルを調べます。<xref role="PageNum" linkend="HRDC.CrHV.mkr.9"> の <xref role="CodeOrFigureOrTable" linkend="HRDC.CrHV.mkr.9"> は、索引ボリュームにリストされている「共通デスクトップ環境」と「概要およびデスクトップの基本スキル」という2つのヘルプ・ファミリを示します。各ファミリ・ファイルは、ひとつまたは複数の関連するヘルプ・ボリュームから成ります。たとえば、「共通デスクトップ環境」ファミリには、デスクトップを説明する異なるボリュームが含まれています。
</para>
<para>アプリケーションとそのヘルプ・ファイルをデスクトップにインストールする方法の詳細については、『共通デスクトップ環境 上級ユーザおよびシステム管理者ガイド』を参照してください。
</para>
</sect2>
<sect2 id="HRDC.CrHV.div.23" role="Procedure">
<title id="HRDC.CrHV.mkr.11">ヘルプ・ファミリを作成するには</title>
<orderedlist><listitem><para>プロダクトに独自のファイル名を付けます。<emphasis>ヘルプ・ファミリ</emphasis>のファイルであることが識別できるように、拡張子 <filename>.hf</filename> を使用します。
</para>
<para><filename><symbol>family</symbol>.hf</filename></para>
</listitem><listitem><para>次の行をファイルに入力します。
</para>
<programlisting>*.charSet: <symbol>character-set</symbol>
*.title: <symbol>family title</symbol>
*.bitmap: <symbol>icon file</symbol>
*.abstract: <symbol>family abstract</symbol>
*.volumes: <symbol>volume volume volume ...</symbol></programlisting>
<para><symbol>character-set</symbol> は、<symbol>family title</symbol> 文字列と <symbol>family abstract</symbol> 文字列が使用する文字セットです。サポートされている文字セットのリストについては、<xref role="SecTitleAndPageNum" linkend="HRDC.Lang.mkr.11"> を参照してください。<symbol>family title</symbol> と <symbol>family abstract</symbol> には、DocBook マークアップを指定できません。このファイルは、DocBook ソフトウェアでは<emphasis>処理されません。</emphasis>
</para>
<para><symbol>icon file</symbol> はオプションです。指定する場合、ファイルの位置を指定するのに使用するパスは絶対パス名でなければなりません。アイコンを付けない場合は、ファミリ・ファイルに <filename>*.bitmap</filename> リソースを指定しないようにしてください。
</para>
<para><symbol>volume</symbol> 名のリストは、そのファミリにどのボリュームが属すのかを識別します。ボリュームは、この行に表示される順番にリストされます。ひとつのボリュームが複数のファミリにリストされることもあります。
</para>
<para>いずれかの値が1行を超える場合、最後の行以外の各行を、バックスラッシュ (<filename>\</filename>) で終わらせます。
</para>
<para>ファイル内で <filename>!</filename> (感嘆符) で始まる行はコメント行であり、無視されます。
</para>
</listitem><listitem><para>最終的なプロダクトを準備するとき、<symbol>family</symbol><filename>.hf</filename> ファイルと残りのヘルプ・ファイルをインストールしてください。デスクトップ統合スクリプト (<command>dtappintegrate</command>) は、実行されると、ファミリ・ファイルへのシンボリック・リンクを作成します。
</para>
<para><command>dtappintegrate</command> スクリプトの実行方法は、<citetitle>共通デスクトップ環境 上級ユーザおよびシステム管理者ガイド</citetitle>で説明しています。
</para>
</listitem></orderedlist>
<sect3 id="HRDC.CrHV.div.24">
<title>例</title>
<para>次の例は、デスクトップのオンライン・ヘルプ用のファミリ・ファイルです。
</para>
<programlisting>*.charSet: ISO-8859-1
*.title: Common Desktop Environment
*.bitmap: /usr/dt/appconfig/help/C/graphics/cdelogo.pm
*.abstract: Overview and Basic Desktop Skills \
* File Manager and the Desktop \
* Front Panel \
* Application Manager \
* Style Manager \
* Text Editor \
* Mailer
*.volumes: Intromgr.sdl Filemgr.sdl FPanel.sdl
Appmanager.sdl Stylemgr.sdl
Textedit.sdl Mailer.sdl
</programlisting>
<para>実際にデスクトップ・ソフトウェアに指定されているヘルプ・ファミリが、この図のとおりになっているとはかぎりません。
</para>
</sect3>
<sect3 id="HRDC.CrHV.div.25">
<title>関連項目</title>
<itemizedlist remap="Bullet1"><listitem><para>サポートされている文字セットの名前のリストについては、<xref role="SecTitleAndPageNum" linkend="HRDC.Lang.mkr.5"> を参照してください。
</para>
</listitem></itemizedlist>
</sect3>
</sect2>
<sect2 id="hrdc.crhv.div.26" role="Procedure">
<title id="hrdc.crhv.mkr.12">索引ボリュームを表示するには</title>
<orderedlist><listitem><para>デスクトップのフロントパネルから[ヘルプ・ビューア]コントロールを選択します。
</para>
<graphic id="hrdc.crhv.igrph.4" entityref="HRDC.CrHV.fig.5"></graphic>
</listitem><listitem><para>ヘルプ・ウィンドウをスクロールして、システムで使用可能なヘルプ・ファミリを表示します。
</para>
</listitem><listitem><para>必要ならば、ヘルプ・ファミリ・タイトルを選択して、ボリュームを表示します。
</para>
</listitem></orderedlist>
<note>
<para>ヘルプ・システムに関するヘルプ情報を表示するには、「共通デスクトップ環境」のタイトル、次に「デスクトップ ヘルプ・システム」を選択してください。
</para>
</note>
<sect3 id="hrdc.crhv.div.27" role="Procedure">
<title>手動で索引ボリュームを表示するには</title>
<itemizedlist><listitem><para><command>dthelpview</command> コマンドを、次のように実行します。
</para>
<programlisting>dthelpview -helpVolume index</programlisting>
</listitem></itemizedlist>
</sect3>
<sect3 id="hrdc.crhv.div.28">
<title>関連項目</title>
<itemizedlist><listitem><para><xref role="SecTitleAndPageNum" linkend="hrdc.cmds.mkr.4"> は <command>dthelpview</command> コマンド行をリストしています。
</para>
</listitem><listitem><para><command>dthelpgen</command>(1) マニュアル・ページ
</para>
</listitem></itemizedlist>
</sect3>
</sect2>
</sect1>
<sect1 id="HRDC.CrHV.div.29">
<title id="HRDC.CrHV.mkr.13">ヘルプ・トピックの印刷<indexterm><primary>印刷</primary><secondary>ヘルプ・トピック</secondary></indexterm></title>
<para>ヘルプ・ボリュームを表示した後、ヘルプ・トピックを印刷することができます。
<!--Original XRef content: 'Figure&numsp;4&hyphen;2'--><xref role="CodeOrFigureOrTable" linkend="HRDC.CrHV.mkr.14"> のダイアログ・ボックスで個々のトピック、目次および索引情報、ヘルプ・ボリューム全体を印刷できます。印刷出力では、グラフィックは省略されます。
</para>
<figure>
<title id="HRDC.CrHV.mkr.14">ヘルプの印刷ダイアログ・ボックス</title>
<graphic id="HRDC.CrHV.grph.2" entityref="HRDC.CrHV.fig.6"></graphic>
</figure>
</sect1>
<sect1 id="HRDC.CrHV.div.30">
<title id="HRDC.CrHV.mkr.15">ヘルプのテスト</title>
<indexterm><primary>テスト</primary><secondary>ヘルプ</secondary></indexterm><indexterm><primary>ハイパーリンクの検証</primary></indexterm><indexterm><primary>ハイパーリンク</primary><secondary>ハイパーリンクの検証</secondary></indexterm><indexterm><primary>アプリケーションのエントリ・ポイントの検証</primary></indexterm><indexterm><primary>アプリケーションのエントリ・ポイント、検証</primary></indexterm><indexterm><primary>アプリケーションのエントリ・ポイント、検証</primary></indexterm><indexterm><primary>ポイント、エントリ、アプリケーションにおける検証</primary></indexterm><indexterm><primary>テスト</primary><secondary>さまざまなディスプレイ上のグラフィック</secondary></indexterm><indexterm><primary>グラフィック、さまざまなディスプレイ上のテスト</primary></indexterm><indexterm><primary>ディスプレイ、さまざまな~上のグラフィックのテスト</primary></indexterm>
<para>ヘルプ・ボリュームのテストは、他のソフトウェア・プロダクトのテストと同じように重要です。テストを計画するときに役立つヒントをいくつか紹介します。
</para>
<sect2 id="HRDC.CrHV.div.31">
<title>ハイパーリンクの妥当性テスト</title>
<itemizedlist remap="Bullet1"><listitem><para>ヘルプ・ボリュームを表示して、すべてのハイパーリンクを試します。(実線または破線の下線の付いた)テキストは、すべてハイパーリンクです。また、ハイパーリンクになっているすべてのグラフィックもテストします。グラフィック・ハイパーリンクは、ハイパーリンクの印として、イメージの周りに(破線または実線の)隅が開いている枠を使用しています。
</para>
</listitem><listitem><para>アプリケーション固有のヘルプを記述していて <command>JumpNewView</command>、<command>Man</command>、または <command>AppDefined</command> リンクのいずれかを指定した場合は、これらのリンクをアプリケーションからテストしなければなりません。これらのリンクを <command>dthelpview</command> を使用してテストしても、アプリケーション内から正しく動作する保証にはなりません。
</para>
</listitem></itemizedlist>
</sect2>
<sect2 id="HRDC.CrHV.div.32">
<title>エントリ・ポイントの確認</title>
<para>特定のヘルプ・トピックへのアクセスにIDを使用するアプリケーション固有のヘルプを記述している場合、IDがヘルプ・ボリューム内で正しく確立されているかを調べる方法はつあります。
</para>
<itemizedlist remap="Bullet1"><listitem><para>アプリケーションを実行して、ユーザ
がするようにヘルプを要求し、エントリ・ポイントをひとつずつ確認します。これにより、アプリケーションが正しいIDを使用しているかという検証もできます。
</para>
</listitem><listitem><para>アプリケーションが開発中でまだ使用できない場合は、各IDに対して <command>dthelpview</command> を実行することで、各IDをテストできます。
</para>
<programlisting>dthelpview -helpVolume <symbol role="Variable">volume.sdl</symbol> -locationId <symbol role="Variable">id</symbol></programlisting>
<para><symbol role="Variable">id</symbol> は、テストしたい位置IDです。<command>dthelpview</command> が正しいトピックを表示していれば、そのIDは大丈夫です。
</para>
</listitem></itemizedlist>
</sect2>
<sect2 id="HRDC.CrHV.div.33">
<title>索引エントリのチェック</title>
<para>ユーザは、ヘルプ・トピックをみつけるために、ヘルプ・ボリュームの索引を検索したり、ブラウズしたりします。あいまいな用語や重複したエントリがないように、索引エントリも丁寧に検査してください。また、各索引エントリを選択して、表示されるトピックがもっとも適切な情報か検証してください。
</para>
</sect2>
<sect2 id="HRDC.CrHV.div.34">
<title>グラフィックのテスト</title>
<itemizedlist remap="Bullet1"><listitem><para>グラフィックが、カラー、グレースケール、白黒ディスプレイで表示可能なことを検査するために、物理的にアプリケーションをさまざまなディスプレイで表示します。
</para>
</listitem><listitem><para>デスクトップが使用するカラーの数を変更して、他のディスプレイをシミュレートすることもできます。そのためには、スタイル・マネージャを開き、[色の数]を選択し、異なるカラー・オプションを指定します。
</para>
</listitem></itemizedlist>
<sect3 id="HRDC.CrHV.div.36">
<title>関連項目</title>
<itemizedlist remap="Bullet1"><listitem><para><!--Original XRef content: '&ldquo;Generating a Index Help Volume (dthelpgen)&rdquo; on page&numsp;193'--><xref role="SecTitleAndPageNum" linkend="HRDC.CmdS.mkr.5"></para>
</listitem></itemizedlist>
</sect3>
</sect2>
</sect1>
</chapter>
<!--fickle 1.14 mif-to-docbook 1.7 01/02/96 16:48:20-->

View File

@@ -0,0 +1,909 @@
<!-- $XConsortium: ch05.sgm /main/11 1996/08/25 15:10:20 rws $ -->
<!-- (c) Copyright 1995 Digital Equipment Corporation. -->
<!-- (c) Copyright 1995 Hewlett-Packard Company. -->
<!-- (c) Copyright 1995 International Business Machines Corp. -->
<!-- (c) Copyright 1995 Sun Microsystems, Inc. -->
<!-- (c) Copyright 1995 Novell, Inc. -->
<!-- (c) Copyright 1995 FUJITSU LIMITED. -->
<!-- (c) Copyright 1995 Hitachi. -->
<chapter id="HRDC.ChEnt.div.1">
<title id="HRDC.ChEnt.mkr.1">特殊文字エンティティの概要</title>
<para>この章では、ヘルプ・トピックの記述に使用する特殊文字のリストを示します。
<indexterm><primary>特殊文字</primary><secondary>~のリスト</secondary></indexterm><indexterm><primary>文字、特殊な~の挿入</primary></indexterm><indexterm><primary>定義済みエンティティ</primary></indexterm><indexterm><primary>エンティティ</primary><secondary>特殊文字</secondary></indexterm><indexterm><primary>図形</primary></indexterm>
この特殊文字は、関連するエンティティ名を、特殊文字を表示する場所へ指定することにより、テキストに入力できます。
</para>
<table id="HRDC.ChEnt.tbl.1" frame="Topbot">
<title>数値および特殊図形記号</title>
<tgroup cols="3" colsep="0" rowsep="0">
<colspec colname="col1" colwidth="0.90in">
<colspec colwidth="1.75in">
<colspec colname="col3" colwidth="2.35in">
<spanspec nameend="col3" namest="col1" spanname="1to3">
<thead>
<row><entry align="left" valign="bottom"><para><literal>記号</literal></para></entry>
<entry align="left" valign="bottom"><para><literal>エンティティ名</literal></para></entry>
<entry align="left" valign="bottom"><para><literal>説明</literal></para></entry>
</row></thead>
<tbody>
<row>
<entry align="left" valign="top"><para>&amp;</para></entry>
<entry align="left" valign="top"><para><literal>&amp;amp;</literal></para></entry>
<entry align="left" valign="top"><para>アンパサンド</para></entry></row>
<row>
<entry align="left" valign="top"><para>'</para></entry>
<entry align="left" valign="top"><para><literal>&amp;apos;</literal></para></entry>
<entry align="left" valign="top"><para>アポストロフィ</para></entry></row>
<row>
<entry align="left" valign="top"><para>*</para></entry>
<entry align="left" valign="top"><para><literal>&amp;ast;</literal></para></entry>
<entry align="left" valign="top"><para>アスタリスク</para></entry></row>
<row>
<entry align="left" valign="top"><para>\</para></entry>
<entry align="left" valign="top"><para><literal>&amp;bsol;</literal></para></entry>
<entry align="left" valign="top"><para>バックスラッシュ、逆スラッシュ</para></entry>
</row>
<row>
<entry align="left" valign="top"><para>&cent;</para></entry>
<entry align="left" valign="top"><para><literal>&amp;cent;</literal></para></entry>
<entry align="left" valign="top"><para>セント記号</para></entry></row>
<row>
<entry align="left" valign="top"><para>:</para></entry>
<entry align="left" valign="top"><para><literal>&amp;colon;</literal></para></entry>
<entry align="left" valign="top"><para>コロン</para></entry></row>
<row>
<entry align="left" valign="top"><para>,</para></entry>
<entry align="left" valign="top"><para><literal>&amp;comma;</literal></para></entry>
<entry align="left" valign="top"><para>コンマ</para></entry></row>
<row>
<entry align="left" valign="top"><para>@</para></entry>
<entry align="left" valign="top"><para><literal>&amp;commat;</literal></para></entry>
<entry align="left" valign="top"><para>商用アットマーク</para></entry></row>
<row>
<entry align="left" valign="top"><para>&copy;</para></entry>
<entry align="left" valign="top"><para><literal>&amp;copy;</literal></para></entry>
<entry align="left" valign="top"><para>著作権記号</para></entry></row>
<row>
<entry align="left" valign="top"><para>&curren;</para></entry>
<entry align="left" valign="top"><para><literal>&amp;curren;</literal></para></entry>
<entry align="left" valign="top"><para>一般通貨記号</para></entry>
</row>
<row>
<entry align="left" valign="top"><para>&darr;</para></entry>
<entry align="left" valign="top"><para><literal>&amp;darr;</literal></para></entry>
<entry align="left" valign="top"><para>下向き矢印記号</para></entry></row>
<row>
<entry align="left" valign="top"><para>&deg;</para></entry>
<entry align="left" valign="top"><para><literal>&amp;deg;</literal></para></entry>
<entry align="left" valign="top"><para>度数記号</para></entry></row>
<row>
<entry align="left" valign="top"><para>&divide;</para></entry>
<entry align="left" valign="top"><para><literal>&amp;divide;</literal></para></entry>
<entry align="left" valign="top"><para>除算記号</para></entry></row>
<row>
<entry align="left" valign="top"><para>$</para></entry>
<entry align="left" valign="top"><para><literal>&amp;dollar;</literal></para></entry>
<entry align="left" valign="top"><para>ドル記号</para></entry></row>
<row>
<entry align="left" valign="top"><para>=</para></entry>
<entry align="left" valign="top"><para><literal>&amp;equals;</literal></para></entry>
<entry align="left" valign="top"><para>等号</para></entry></row>
<row>
<entry align="left" valign="top"><para>!</para></entry>
<entry align="left" valign="top"><para><literal>&amp;excl;</literal></para></entry>
<entry align="left" valign="top"><para>感嘆符</para></entry></row>
<row>
<entry align="left" valign="top"><para>&frac12;</para></entry>
<entry align="left" valign="top"><para><literal>&amp;frac12</literal></para></entry>
<entry align="left" valign="top"><para>分数 2分の1</para></entry></row>
<row>
<entry align="left" valign="top"><para>&frac14;</para></entry>
<entry align="left" valign="top"><para><literal>&amp;frac14</literal></para></entry>
<entry align="left" valign="top"><para>分数 4分の1</para></entry>
</row>
<row>
<entry align="left" valign="top"><para>&frac18;</para></entry>
<entry align="left" valign="top"><para><literal>&amp;frac18</literal></para></entry>
<entry align="left" valign="top"><para>分数 8分の1</para></entry>
</row>
<row>
<entry align="left" valign="top"><para>&frac34;</para></entry>
<entry align="left" valign="top"><para><literal>&amp;frac34</literal></para></entry>
<entry align="left" valign="top"><para>分数 4分の3</para></entry>
</row>
<row>
<entry align="left" valign="top"><para>&frac38;</para></entry>
<entry align="left" valign="top"><para><literal>&amp;frac38</literal></para></entry>
<entry align="left" valign="top"><para>分数 8分の3</para></entry>
</row>
<row>
<entry align="left" valign="top"><para>&frac58;</para></entry>
<entry align="left" valign="top"><para><literal>&amp;frac58;</literal></para></entry>
<entry align="left" valign="top"><para>分数 8分の5</para></entry>
</row>
<row>
<entry align="left" valign="top"><para>&frac78;</para></entry>
<entry align="left" valign="top"><para><literal>&amp;frac78;</literal></para></entry>
<entry align="left" valign="top"><para>分数 8分の7</para></entry>
</row>
<row>
<entry align="left" valign="top"><para>></para></entry>
<entry align="left" valign="top"><para><literal>&amp;gt;</literal></para></entry>
<entry align="left" valign="top"><para>より大きい</para></entry></row>
<row>
<entry align="left" valign="top"><para>&half;</para></entry>
<entry align="left" valign="top"><para><literal>&amp;half;</literal></para></entry>
<entry align="left" valign="top"><para>分数 2分の1</para></entry></row>
<row>
<entry align="left" valign="top"><para>-</para></entry>
<entry align="left" valign="top"><para><literal>&amp;hyphen;</literal></para></entry>
<entry align="left" valign="top"><para>ハイフン</para></entry></row>
<row>
<entry align="left" valign="top"><para>&iexcl;</para></entry>
<entry align="left" valign="top"><para><literal>&amp;iexcl;</literal></para></entry>
<entry align="left" valign="top"><para>逆向き感嘆符</para></entry>
</row>
<row>
<entry align="left" valign="top"><para>&iquest;</para></entry>
<entry align="left" valign="top"><para><literal>&amp;iquest;</literal></para></entry>
<entry align="left" valign="top"><para>逆向き疑問符</para></entry>
</row>
<row>
<entry align="left" valign="top"><para>&larr;</para></entry>
<entry align="left" valign="top"><para><literal>&amp;larr;</literal></para></entry>
<entry align="left" valign="top"><para>左向き矢印記号</para></entry></row>
<row>
<entry align="left" valign="top"><para>{</para></entry>
<entry align="left" valign="top"><para><literal>&amp;lcub;</literal></para></entry>
<entry align="left" valign="top"><para>左カーリー・ブレイス</para></entry></row>
<row>
<entry align="left" valign="top"><para>_</para></entry>
<entry align="left" valign="top"><para><literal>&amp;lowbar;</literal></para></entry>
<entry align="left" valign="top"><para>アンダースコア</para></entry></row>
<row>
<entry align="left" valign="top"><para>(</para></entry>
<entry align="left" valign="top"><para><literal>&amp;lpar;</literal></para></entry>
<entry align="left" valign="top"><para>左括弧</para></entry></row>
<row>
<entry align="left" valign="top"><para>[</para></entry>
<entry align="left" valign="top"><para><literal>&amp;lsqb;</literal></para></entry>
<entry align="left" valign="top"><para>左スクエア・ブラケット</para></entry>
</row>
<row>
<entry align="left" valign="top"><para>`</para></entry>
<entry align="left" valign="top"><para><literal>&amp;lsquo;</literal></para></entry>
<entry align="left" valign="top"><para>左単一引用符</para></entry></row>
<row>
<entry align="left" valign="top"><para>&lt;</para></entry>
<entry align="left" valign="top"><para><literal>&amp;lt;</literal></para></entry>
<entry align="left" valign="top"><para>より小さい</para></entry></row>
<row>
<entry align="left" valign="top"><para>&nbsp;</para></entry>
<entry align="left" valign="top"><para><literal>&amp;nbsp;</literal></para></entry>
<entry align="left" valign="top"><para>ブレイクのない空白</para></entry></row>
<row>
<entry align="left" valign="top"><para>&not;</para></entry>
<entry align="left" valign="top"><para><literal>&amp;not;</literal></para></entry>
<entry align="left" valign="top"><para>否定</para></entry></row>
<row>
<entry align="left" valign="top"><para>#</para></entry>
<entry align="left" valign="top"><para><literal>&amp;num;</literal></para></entry>
<entry align="left" valign="top"><para>井桁</para></entry></row>
<row>
<entry align="left" valign="top"><para>&para;</para></entry>
<entry align="left" valign="top"><para><literal>&amp;para;</literal></para></entry>
<entry align="left" valign="top"><para>段落記号</para></entry></row>
<row>
<entry align="left" valign="top"><para>%</para></entry>
<entry align="left" valign="top"><para><literal>&amp;percnt;</literal></para></entry>
<entry align="left" valign="top"><para>パーセント記号</para></entry></row>
<row>
<entry align="left" valign="top"><para>.</para></entry>
<entry align="left" valign="top"><para><literal>&amp;period;</literal></para></entry>
<entry align="left" valign="top"><para>フル・ストップ、ピリオド</para></entry></row>
<row>
<entry align="left" valign="top"><para>+</para></entry>
<entry align="left" valign="top"><para><literal>&amp;plus;</literal></para></entry>
<entry align="left" valign="top"><para>正符号</para></entry></row>
<row>
<entry align="left" valign="top"><para>&plusmn;</para></entry>
<entry align="left" valign="top"><para><literal>&amp;plusmn;</literal></para></entry>
<entry align="left" valign="top"><para>正負符号</para></entry></row>
<row>
<entry align="left" valign="top"><para>&pound;</para></entry>
<entry align="left" valign="top"><para><literal>&amp;pound;</literal></para></entry>
<entry align="left" valign="top"><para>パウンド・サイン</para></entry></row>
<row>
<entry align="left" valign="top"><para>?</para></entry>
<entry align="left" valign="top"><para><literal>&amp;quest;</literal></para></entry>
<entry align="left" valign="top"><para>疑問符</para></entry></row>
<row>
<entry align="left" valign="top"><para>&rarr;</para></entry>
<entry align="left" valign="top"><para><literal>&amp;rarr;</literal></para></entry>
<entry align="left" valign="top"><para>右向き矢印記号</para></entry></row>
<row>
<entry align="left" valign="top"><para>}</para></entry>
<entry align="left" valign="top"><para><literal>&amp;rcub;</literal></para></entry>
<entry align="left" valign="top"><para>右カーリー・ブレイス</para></entry></row>
<row>
<entry align="left" valign="top"><para>&rdquo;</para></entry>
<entry align="left" valign="top"><para><literal>&amp;rdquo;</literal></para></entry>
<entry align="left" valign="top"><para>右二重引用符</para></entry></row>
<row>
<entry align="left" valign="top"><para>&reg;</para></entry>
<entry align="left" valign="top"><para><literal>&amp;reg;</literal></para></entry>
<entry align="left" valign="top"><para>登録商標、マル付きの R</para></entry>
</row>
<row>
<entry align="left" valign="top"><para>)</para></entry>
<entry align="left" valign="top"><para><literal>&amp;rpar;</literal></para></entry>
<entry align="left" valign="top"><para>右括弧</para></entry></row>
<row>
<entry align="left" valign="top"><para>]</para></entry>
<entry align="left" valign="top"><para><literal>&amp;rsqb;</literal></para></entry>
<entry align="left" valign="top"><para>右スクエア・ブラケット</para></entry>
</row>
<row>
<entry align="left" valign="top"><para>'</para></entry>
<entry align="left" valign="top"><para><literal>&amp;rsquo;</literal></para></entry>
<entry align="left" valign="top"><para>右単一引用符</para></entry></row>
<row>
<entry align="left" valign="top"><para>&sect;</para></entry>
<entry align="left" valign="top"><para><literal>&amp;sect;</literal></para></entry>
<entry align="left" valign="top"><para>セクション記号</para></entry></row>
<row>
<entry align="left" valign="top"><para>;</para></entry>
<entry align="left" valign="top"><para><literal>&amp;semi;</literal></para></entry>
<entry align="left" valign="top"><para>セミコロン</para></entry></row>
<row>
<entry align="left" valign="top"><para>/</para></entry>
<entry align="left" valign="top"><para><literal>&amp;sol;</literal></para></entry>
<entry align="left" valign="top"><para>スラッシュ</para></entry></row>
<row>
<entry align="left" valign="top"><para>&times;</para></entry>
<entry align="left" valign="top"><para><literal>&amp;times;</literal></para></entry>
<entry align="left" valign="top"><para>乗算記号</para></entry></row>
<row>
<entry align="left" valign="top"><para>&trade;</para></entry>
<entry align="left" valign="top"><para><literal>&amp;trade;</literal></para></entry>
<entry align="left" valign="top"><para>商標</para></entry></row>
<row>
<entry align="left" valign="top"><para>&uarr;</para></entry>
<entry align="left" valign="top"><para><literal>&amp;uarr;</literal></para></entry>
<entry align="left" valign="top"><para>上向き矢印記号</para></entry></row>
<row>
<entry align="left" valign="top"><para>&yen;</para></entry>
<entry align="left" valign="top"><para><literal>&amp;yen;</literal></para></entry>
<entry align="left" valign="top"><para>円記号</para></entry></row></tbody>
</tgroup></table>
<table id="HRDC.ChEnt.tbl.2" frame="Topbot">
<title>ギリシャ文字</title>
<tgroup cols="3" colsep="0" rowsep="0">
<colspec colname="col1" colwidth="1.11in">
<colspec colname="col2" colwidth="1.53in">
<colspec colname="col3" colwidth="2.35in">
<spanspec nameend="col2" namest="col1" spanname="1to2">
<thead>
<row><entry align="left" valign="bottom"><para><literal>記号</literal></para></entry>
<entry align="left" valign="bottom"><para><literal>エンティティ名</literal></para></entry>
<entry align="left" valign="bottom"><para><literal>説明</literal></para></entry>
</row></thead>
<tbody>
<row>
<entry align="left" spanname="1to2" valign="top"><para>小文字</para></entry></row>
<row>
<entry align="left" valign="top"><para>&alpha;</para></entry>
<entry align="left" valign="top"><para><literal>&amp;alpha;</literal></para></entry>
<entry align="left" valign="top"><para>アルファ</para></entry>
</row>
<row>
<entry align="left" valign="top"><para>&beta;</para></entry>
<entry align="left" valign="top"><para><literal>&amp;beta;</literal></para></entry>
<entry align="left" valign="top"><para>ベータ</para></entry>
</row>
<row>
<entry align="left" valign="top"><para>&chi;</para></entry>
<entry align="left" valign="top"><para><literal>&amp;chi;</literal></para></entry>
<entry align="left" valign="top"><para>カイ</para></entry>
</row>
<row>
<entry align="left" valign="top"><para>&delta;</para></entry>
<entry align="left" valign="top"><para><literal>&amp;delta;</literal></para></entry>
<entry align="left" valign="top"><para>デルタ</para></entry>
</row>
<row>
<entry align="left" valign="top"><para>&epsiv;</para></entry>
<entry align="left" valign="top"><para><literal>&amp;epsiv;</literal></para></entry>
<entry align="left" valign="top"><para>エプシロン、バリアント</para></entry>
</row>
<row>
<entry align="left" valign="top"><para>&eta;</para></entry>
<entry align="left" valign="top"><para><literal>&amp;eta;</literal></para></entry>
<entry align="left" valign="top"><para>エータ</para></entry>
</row>
<row>
<entry align="left" valign="top"><para>&gamma;</para></entry>
<entry align="left" valign="top"><para><literal>&amp;gamma;</literal></para></entry>
<entry align="left" valign="top"><para>ガンマ</para></entry>
</row>
<row>
<entry align="left" valign="top"><para>&iota;</para></entry>
<entry align="left" valign="top"><para><literal>&amp;iota;</literal></para></entry>
<entry align="left" valign="top"><para>イオタ</para></entry>
</row>
<row>
<entry align="left" valign="top"><para>&kappa;</para></entry>
<entry align="left" valign="top"><para><literal>&amp;kappa;</literal></para></entry>
<entry align="left" valign="top"><para>カッパ</para></entry>
</row>
<row>
<entry align="left" valign="top"><para>&lambda;</para></entry>
<entry align="left" valign="top"><para><literal>&amp;lambda;</literal></para></entry>
<entry align="left" valign="top"><para>ラムダ</para></entry>
</row>
<row>
<entry align="left" valign="top"><para>&mu;</para></entry>
<entry align="left" valign="top"><para><literal>&amp;mu;</literal></para></entry>
<entry align="left" valign="top"><para>ミュー</para></entry></row>
<row>
<entry align="left" valign="top"><para>&nu;</para></entry>
<entry align="left" valign="top"><para><literal>&amp;nu;</literal></para></entry>
<entry align="left" valign="top"><para>ニュー</para></entry></row>
<row>
<entry align="left" valign="top"><para>&omega;</para></entry>
<entry align="left" valign="top"><para><literal>&amp;omega;</literal></para></entry>
<entry align="left" valign="top"><para>オメガ</para></entry>
</row>
<row>
<entry align="left" valign="top"><para>&phis;</para></entry>
<entry align="left" valign="top"><para><literal>&amp;phis;</literal></para></entry>
<entry align="left" valign="top"><para>ファイ</para></entry>
</row>
<row>
<entry align="left" valign="top"><para>&pi;</para></entry>
<entry align="left" valign="top"><para><literal>&amp;pi;</literal></para></entry>
<entry align="left" valign="top"><para>パイ</para></entry></row>
<row>
<entry align="left" valign="top"><para>&piv;</para></entry>
<entry align="left" valign="top"><para><literal>&amp;piv;</literal></para></entry>
<entry align="left" valign="top"><para>パイ、バリアント</para></entry>
</row>
<row>
<entry align="left" valign="top"><para>&psi;</para></entry>
<entry align="left" valign="top"><para><literal>&amp;psi;</literal></para></entry>
<entry align="left" valign="top"><para>プサイ</para></entry>
</row>
<row>
<entry align="left" valign="top"><para>&rho;</para></entry>
<entry align="left" valign="top"><para><literal>&amp;rho;</literal></para></entry>
<entry align="left" valign="top"><para>ロウ</para></entry>
</row>
<row>
<entry align="left" valign="top"><para>&sigma;</para></entry>
<entry align="left" valign="top"><para><literal>&amp;sigma;</literal></para></entry>
<entry align="left" valign="top"><para>シグマ</para></entry>
</row>
<row>
<entry align="left" valign="top"><para>&tau;</para></entry>
<entry align="left" valign="top"><para><literal>&amp;tau;</literal></para></entry>
<entry align="left" valign="top"><para>タウ</para></entry>
</row>
<row>
<entry align="left" valign="top"><para>&thetas;</para></entry>
<entry align="left" valign="top"><para><literal>&amp;thetas;</literal></para></entry>
<entry align="left" valign="top"><para>シータ</para></entry>
</row>
<row>
<entry align="left" valign="top"><para>&thetav;</para></entry>
<entry align="left" valign="top"><para><literal>&amp;thetav;</literal></para></entry>
<entry align="left" valign="top"><para>シータ、バリアント</para></entry>
</row>
<row>
<entry align="left" valign="top"><para>&upsi;</para></entry>
<entry align="left" valign="top"><para><literal>&amp;upsi;</literal></para></entry>
<entry align="left" valign="top"><para>ウプシロン</para></entry>
</row>
<row>
<entry align="left" valign="top"><para>&xi;</para></entry>
<entry align="left" valign="top"><para><literal>&amp;xi;</literal></para></entry>
<entry align="left" valign="top"><para>グザイ</para></entry></row>
<row>
<entry align="left" valign="top"><para>&zeta;</para></entry>
<entry align="left" valign="top"><para><literal>&amp;zeta;</literal></para></entry>
<entry align="left" valign="top"><para>ゼータ</para></entry>
</row>
<row>
<entry align="left" spanname="1to2" valign="top"><para>大文字</para></entry></row>
<row>
<entry align="left" valign="top"><para>&Delta;</para></entry>
<entry align="left" valign="top"><para><literal>&amp;Delta;</literal></para></entry>
<entry align="left" valign="top"><para>デルタ</para></entry>
</row>
<row>
<entry align="left" valign="top"><para>&Gamma;</para></entry>
<entry align="left" valign="top"><para><literal>&amp;Gamma;</literal></para></entry>
<entry align="left" valign="top"><para>ガンマ</para></entry>
</row>
<row>
<entry align="left" valign="top"><para>&Lambda;</para></entry>
<entry align="left" valign="top"><para><literal>&amp;Lambda</literal></para></entry>
<entry align="left" valign="top"><para>ラムダ</para></entry>
</row>
<row>
<entry align="left" valign="top"><para>&Omega;</para></entry>
<entry align="left" valign="top"><para><literal>&amp;Omega;</literal></para></entry>
<entry align="left" valign="top"><para>オメガ</para></entry>
</row>
<row>
<entry align="left" valign="top"><para>&Pi;</para></entry>
<entry align="left" valign="top"><para><literal>&amp;Pi;</literal></para></entry>
<entry align="left" valign="top"><para>パイ</para></entry></row>
<row>
<entry align="left" valign="top"><para>&Phi;</para></entry>
<entry align="left" valign="top"><para><literal>&amp;Phi;</literal></para></entry>
<entry align="left" valign="top"><para>ファイ</para></entry>
</row>
<row>
<entry align="left" valign="top"><para>&Psi;</para></entry>
<entry align="left" valign="top"><para><literal>&amp;Psi;</literal></para></entry>
<entry align="left" valign="top"><para>プサイ</para></entry>
</row>
<row>
<entry align="left" valign="top"><para>&Sigma;</para></entry>
<entry align="left" valign="top"><para><literal>&amp;Sigma;</literal></para></entry>
<entry align="left" valign="top"><para>シグマ</para></entry>
</row>
<row>
<entry align="left" valign="top"><para>&Theta;</para></entry>
<entry align="left" valign="top"><para><literal>&amp;Theta;</literal></para></entry>
<entry align="left" valign="top"><para>シータ</para></entry>
</row>
<row>
<entry align="left" valign="top"><para>&Upsi;</para></entry>
<entry align="left" valign="top"><para><literal>&amp;Upsi;</literal></para></entry>
<entry align="left" valign="top"><para>ウプシロン</para></entry>
</row>
<row>
<entry align="left" valign="top"><para>&Xi;</para></entry>
<entry align="left" valign="top"><para><literal>&amp;Xi;</literal></para></entry>
<entry align="left" valign="top"><para>グザイ</para></entry></row>
</tbody></tgroup></table>
<table id="HRDC.ChEnt.tbl.3" frame="Topbot">
<title>一般技術記号</title>
<tgroup cols="3" colsep="0" rowsep="0">
<colspec colname="col1" colwidth="0.90in">
<colspec colname="col2" colwidth="1.75in">
<colspec colname="col3" colwidth="2.35in">
<thead>
<row><entry align="left" valign="bottom"><para><literal>記号</literal>
</para></entry><entry align="left" valign="bottom"><para><literal>エンティティ名</literal></para></entry><entry align="left" valign="bottom"><para><literal>説明</literal></para></entry></row></thead>
<tbody>
<row>
<entry align="left" valign="top"><para>&aleph;</para></entry>
<entry align="left" valign="top"><para><literal>&amp;aleph;</literal></para></entry>
<entry align="left" valign="top"><para>ヘブライ文字アレフ</para></entry>
</row>
<row>
<entry align="left" valign="top"><para>&and;</para></entry>
<entry align="left" valign="top"><para><literal>&amp;and;</literal></para></entry>
<entry align="left" valign="top"><para>ウェッジ、論理積</para></entry></row>
<row>
<entry align="left" valign="top"><para>&ap;</para></entry>
<entry align="left" valign="top"><para><literal>&amp;ap;</literal></para></entry>
<entry align="left" valign="top"><para>ほとんど等しい</para></entry>
</row>
<row>
<entry align="left" valign="top"><para>&cap;</para></entry>
<entry align="left" valign="top"><para><literal>&amp;cap;</literal></para></entry>
<entry align="left" valign="top"><para>積集合</para></entry></row>
<row>
<entry align="left" valign="top"><para>&cong;</para></entry>
<entry align="left" valign="top"><para><literal>&amp;cong;</literal></para></entry>
<entry align="left" valign="top"><para>合同</para></entry></row>
<row>
<entry align="left" valign="top"><para>&cup;</para></entry>
<entry align="left" valign="top"><para><literal>&amp;cup;</literal></para></entry>
<entry align="left" valign="top"><para>和集合</para></entry>
</row>
<row>
<entry align="left" valign="top"><para>&equiv;</para></entry>
<entry align="left" valign="top"><para><literal>&amp;equiv;</literal></para></entry>
<entry align="left" valign="top"><para>恒等号</para></entry></row>
<row>
<entry align="left" valign="top"><para>&exist;</para></entry>
<entry align="left" valign="top"><para><literal>&amp;exist;</literal></para></entry>
<entry align="left" valign="top"><para>存在記号</para></entry>
</row>
<row>
<entry align="left" valign="top"><para>&forall;</para></entry>
<entry align="left" valign="top"><para><literal>&amp;forall;</literal></para></entry>
<entry align="left" valign="top"><para>全称記号</para></entry></row>
<row>
<entry align="left" valign="top"><para>&ge;</para></entry>
<entry align="left" valign="top"><para><literal>&amp;ge;</literal></para></entry>
<entry align="left" valign="top"><para>より大きいか等しい</para></entry>
</row>
<row>
<entry align="left" valign="top"><para>&infin;</para></entry>
<entry align="left" valign="top"><para><literal>&amp;infin;</literal></para></entry>
<entry align="left" valign="top"><para>無限大</para></entry></row>
<row>
<entry align="left" valign="top"><para>&isin;</para></entry>
<entry align="left" valign="top"><para><literal>&amp;isin;</literal></para></entry>
<entry align="left" valign="top"><para>属する</para></entry></row>
<row>
<entry align="left" valign="top"><para>&le;</para></entry>
<entry align="left" valign="top"><para><literal>&amp;le;</literal></para></entry>
<entry align="left" valign="top"><para>より小さいか等しい</para></entry></row>
<row>
<entry align="left" valign="top"><para>&ne;</para></entry>
<entry align="left" valign="top"><para><literal>&amp;ne;</literal></para></entry>
<entry align="left" valign="top"><para>不等号</para></entry></row>
<row>
<entry align="left" valign="top"><para>&notin;</para></entry>
<entry align="left" valign="top"><para><literal>&amp;notin;</literal></para></entry>
<entry align="left" valign="top"><para>属さない</para></entry>
</row>
<row>
<entry align="left" valign="top"><para>&or;</para></entry>
<entry align="left" valign="top"><para><literal>&amp;or;</literal></para></entry>
<entry align="left" valign="top"><para>論理和</para></entry></row>
<row>
<entry align="left" valign="top"><para>&part;</para></entry>
<entry align="left" valign="top"><para><literal>&amp;part;</literal></para></entry>
<entry align="left" valign="top"><para>微分デルタ記号</para></entry>
</row>
<row>
<entry align="left" valign="top"><para>&perp;</para></entry>
<entry align="left" valign="top"><para><literal>&amp;perp;</literal></para></entry>
<entry align="left" valign="top"><para>垂直記号</para></entry></row>
<row>
<entry align="left" valign="top"><para>&prime;</para></entry>
<entry align="left" valign="top"><para><literal>&amp;prime;</literal></para></entry>
<entry align="left" valign="top"><para>プライムまたは円弧の度数(度)</para></entry>
</row>
<row>
<entry align="left" valign="top"><para>&prop;</para></entry>
<entry align="left" valign="top"><para><literal>&amp;prop;</literal></para></entry>
<entry align="left" valign="top"><para>比例記号</para></entry></row>
<row>
<entry align="left" valign="top"><para>&rArr;</para></entry>
<entry align="left" valign="top"><para><literal>&amp;rArr;</literal></para></entry>
<entry align="left" valign="top"><para>右向き二重矢印記号</para></entry></row>
<row>
<entry align="left" valign="top"><para>&sub;</para></entry>
<entry align="left" valign="top"><para><literal>&amp;sub;</literal></para></entry>
<entry align="left" valign="top"><para>部分集合、に含まれる</para></entry>
</row>
<row>
<entry align="left" valign="top"><para>&sube;</para></entry>
<entry align="left" valign="top"><para><literal>&amp;sube;</literal></para></entry>
<entry align="left" valign="top"><para>部分集合、等しい</para></entry></row>
<row>
<entry align="left" valign="top"><para>&sup;</para></entry>
<entry align="left" valign="top"><para><literal>&amp;sup;</literal></para></entry>
<entry align="left" valign="top"><para>部分集合、に含まれる</para></entry></row>
<row>
<entry align="left" valign="top"><para>&there4;</para></entry>
<entry align="left" valign="top"><para><literal>&amp;there4;</literal></para></entry>
<entry align="left" valign="top"><para>したがって</para></entry></row>
<row>
<entry align="left" valign="top"><para>&Prime;</para></entry>
<entry align="left" valign="top"><para><literal>&amp;Prime;</literal></para></entry>
<entry align="left" valign="top"><para>二重プライムまたは円弧の度数(分)</para></entry>
</row></tbody></tgroup></table>
<table id="HRDC.ChEnt.tbl.4" frame="Topbot">
<title>印刷記号</title>
<tgroup cols="3" colsep="0" rowsep="0">
<colspec colname="col1" colwidth="0.90in">
<colspec colname="col2" colwidth="1.75in">
<colspec colname="col3" colwidth="2.35in">
<thead>
<row><entry align="left" valign="bottom"><para><literal>記号</literal>
</para></entry><entry align="left" valign="bottom"><para><literal>エンティティ名</literal></para></entry><entry align="left" valign="bottom"><para><literal>説明</literal></para></entry></row></thead>
<tbody>
<row>
<entry align="left" valign="top"><para>&bull;</para></entry>
<entry align="left" valign="top"><para><literal>&amp;bull;</literal></para></entry>
<entry align="left" valign="top"><para>丸弾丸型(塗りつぶし)</para></entry>
</row>
<row>
<entry align="left" valign="top"><para>&clubs;</para></entry>
<entry align="left" valign="top"><para><literal>&amp;clubs;</literal></para></entry>
<entry align="left" valign="top"><para>クラブ</para></entry></row>
<row>
<entry align="left" valign="top"><para>&diams;</para></entry>
<entry align="left" valign="top"><para><literal>&amp;diams;</literal></para></entry>
<entry align="left" valign="top"><para>ダイヤモンド</para></entry>
</row>
<row>
<entry align="left" valign="top"><para>&hearts;</para></entry>
<entry align="left" valign="top"><para><literal>&amp;hearts;</literal></para></entry>
<entry align="left" valign="top"><para>ハート</para></entry></row>
<row>
<entry align="left" valign="top"><para>&hellip;</para></entry>
<entry align="left" valign="top"><para><literal>&amp;hellip;</literal></para></entry>
<entry align="left" valign="top"><para>水平方向の省略記号</para></entry>
</row>
<row>
<entry align="left" valign="top"><para>&mdash;</para></entry>
<entry align="left" valign="top"><para><literal>&amp;mdash;</literal></para></entry>
<entry align="left" valign="top"><para>エム・ダッシュ(長いダッシュ)</para></entry>
</row>
<row>
<entry align="left" valign="top"><para>&ndash;</para></entry>
<entry align="left" valign="top"><para><literal>&amp;ndash;</literal></para></entry>
<entry align="left" valign="top"><para>エヌ・ダッシュ(短いダッシュ)</para></entry>
</row>
<row>
<entry align="left" valign="top"><para>&spades;</para></entry>
<entry align="left" valign="top"><para><literal>&amp;spades;</literal></para></entry>
<entry align="left" valign="top"><para>スペード</para></entry></row>
<row>
<entry align="left" valign="top"><para>&vellip;</para></entry>
<entry align="left" valign="top"><para><literal>&amp;vellip;</literal></para></entry>
<entry align="left" valign="top"><para>垂直方向の省略記号</para></entry></row>
</tbody></tgroup></table>
<table id="HRDC.ChEnt.tbl.5" frame="Topbot">
<title>Latin 1 の文字</title>
<tgroup cols="3" colsep="0" rowsep="0">
<colspec colname="col1" colwidth="0.90in">
<colspec colwidth="1.75in">
<colspec colname="col3" colwidth="2.35in">
<spanspec nameend="col3" namest="col1" spanname="1to3">
<thead>
<row><entry align="left" valign="bottom"><para><literal>記号</literal></para></entry>
<entry align="left" valign="bottom"><para><literal>エンティティ名</literal></para></entry>
<entry align="left" valign="bottom"><para><literal>説明</literal></para></entry>
</row></thead>
<tbody>
<row>
<entry align="left" valign="top"><para>&aacute;</para></entry>
<entry align="left" valign="top"><para><literal>&amp;aacute;</literal></para></entry>
<entry align="left" valign="top"><para>小文字の a、アキュート・アクセント記号</para></entry></row>
<row>
<entry align="left" valign="top"><para>&acirc;</para></entry>
<entry align="left" valign="top"><para><literal>&amp;acirc;</literal></para></entry>
<entry align="left" valign="top"><para>小文字の a、サーカムフレックス</para></entry></row>
<row>
<entry align="left" valign="top"><para>&aelig;</para></entry>
<entry align="left" valign="top"><para><literal>&amp;aelig;</literal></para></entry>
<entry align="left" valign="top"><para>小文字の ae 二重母音</para></entry></row>
<row>
<entry align="left" valign="top"><para>&agrave;</para></entry>
<entry align="left" valign="top"><para><literal>&amp;agrave;</literal></para></entry>
<entry align="left" valign="top"><para>小文字の a、グラーブ・アクセント記号</para></entry></row>
<row>
<entry align="left" valign="top"><para>&aring;</para></entry>
<entry align="left" valign="top"><para><literal>&amp;aring;</literal></para></entry>
<entry align="left" valign="top"><para>小文字の a、リング</para></entry></row>
<row>
<entry align="left" valign="top"><para>&atilde;</para></entry>
<entry align="left" valign="top"><para><literal>&amp;atilde;</literal></para></entry>
<entry align="left" valign="top"><para>小文字の a、チルド</para></entry></row>
<row>
<entry align="left" valign="top"><para>&auml;</para></entry>
<entry align="left" valign="top"><para><literal>&amp;auml;</literal></para></entry>
<entry align="left" valign="top"><para>小文字の a、ウムラウト記号</para></entry></row>
<row>
<entry align="left" valign="top"><para>&ccedil;</para></entry>
<entry align="left" valign="top"><para><literal>&amp;ccedil;</literal></para></entry>
<entry align="left" valign="top"><para>小文字の c、セディーユ</para></entry></row>
<row>
<entry align="left" valign="top"><para>&eacute;</para></entry>
<entry align="left" valign="top"><para><literal>&amp;eacute;</literal></para></entry>
<entry align="left" valign="top"><para>小文字の e、アキュート・アクセント記号</para></entry></row>
<row>
<entry align="left" valign="top"><para>&ecirc;</para></entry>
<entry align="left" valign="top"><para><literal>&amp;ecirc;</literal></para></entry>
<entry align="left" valign="top"><para>小文字の e、サーカムフレックス</para></entry></row>
<row>
<entry align="left" valign="top"><para>&egrave;</para></entry>
<entry align="left" valign="top"><para><literal>&amp;egrave;</literal></para></entry>
<entry align="left" valign="top"><para>小文字の e、グラーブ・アクセント記号</para></entry></row>
<row>
<entry align="left" valign="top"><para>&eth;</para></entry>
<entry align="left" valign="top"><para><literal>&amp;eth;</literal></para></entry>
<entry align="left" valign="top"><para>小文字の eth、アイスランド語</para></entry></row>
<row>
<entry align="left" valign="top"><para>&euml;</para></entry>
<entry align="left" valign="top"><para><literal>&amp;euml;</literal></para></entry>
<entry align="left" valign="top"><para>小文字の e、ウムラウト記号</para></entry></row>
<row>
<entry align="left" valign="top"><para>&iacute;</para></entry>
<entry align="left" valign="top"><para><literal>&amp;iacute;</literal></para></entry>
<entry align="left" valign="top"><para>小文字の i、アキュート・アクセント記号</para></entry></row>
<row>
<entry align="left" valign="top"><para>&icirc;</para></entry>
<entry align="left" valign="top"><para><literal>&amp;icirc;</literal></para></entry>
<entry align="left" valign="top"><para>小文字の i、サーカムフレックス</para></entry></row>
<row>
<entry align="left" valign="top"><para>&igrave;</para></entry>
<entry align="left" valign="top"><para><literal>&amp;igrave;</literal></para></entry>
<entry align="left" valign="top"><para>小文字の i、グラーブ・アクセント記号</para></entry></row>
<row>
<entry align="left" valign="top"><para>&iuml;</para></entry>
<entry align="left" valign="top"><para><literal>&amp;iuml;</literal></para></entry>
<entry align="left" valign="top"><para>小文字の i、ウムラウト記号</para></entry></row>
<row>
<entry align="left" valign="top"><para>&ntilde;</para></entry>
<entry align="left" valign="top"><para><literal>&amp;ntilde;</literal></para></entry>
<entry align="left" valign="top"><para>小文字の n、チルド</para></entry></row>
<row>
<entry align="left" valign="top"><para>&oacute;</para></entry>
<entry align="left" valign="top"><para><literal>&amp;oacute;</literal></para></entry>
<entry align="left" valign="top"><para>小文字の o、アキュート・アクセント記号</para></entry></row>
<row>
<entry align="left" valign="top"><para>&ocirc;</para></entry>
<entry align="left" valign="top"><para><literal>&amp;ocirc;</literal></para></entry>
<entry align="left" valign="top"><para>小文字の o、サーカムフレックス</para></entry></row>
<row>
<entry align="left" valign="top"><para>&ograve;</para></entry>
<entry align="left" valign="top"><para><literal>&amp;ograve;</literal></para></entry>
<entry align="left" valign="top"><para>小文字の o、グラーブ・アクセント記号</para></entry></row>
<row>
<entry align="left" valign="top"><para>&oslash;</para></entry>
<entry align="left" valign="top"><para><literal>&amp;oslash;</literal></para></entry>
<entry align="left" valign="top"><para>小文字の o、スラッシュ</para></entry></row>
<row>
<entry align="left" valign="top"><para>&otilde;</para></entry>
<entry align="left" valign="top"><para><literal>&amp;otilde;</literal></para></entry>
<entry align="left" valign="top"><para>小文字の o、チルド</para></entry></row>
<row>
<entry align="left" valign="top"><para>&ouml;</para></entry>
<entry align="left" valign="top"><para><literal>&amp;ouml;</literal></para></entry>
<entry align="left" valign="top"><para>小文字の o、ウムラウト記号</para></entry></row>
<row>
<entry align="left" valign="top"><para>&szlig;</para></entry>
<entry align="left" valign="top"><para><literal>&amp;szlig;</literal></para></entry>
<entry align="left" valign="top"><para>小文字のシャープな s、ドイツ語</para></entry></row>
<row>
<entry align="left" valign="top"><para>&thorn;</para></entry>
<entry align="left" valign="top"><para><literal>&amp;thorn;</literal></para></entry>
<entry align="left" valign="top"><para>小文字の thorn、アイスランド語</para></entry></row>
<row>
<entry align="left" valign="top"><para>&uacute;</para></entry>
<entry align="left" valign="top"><para><literal>&amp;uacute;</literal></para></entry>
<entry align="left" valign="top"><para>小文字の u、アキュート・アクセント記号</para></entry></row>
<row>
<entry align="left" valign="top"><para>&ucirc;</para></entry>
<entry align="left" valign="top"><para><literal>&amp;ucirc;</literal></para></entry>
<entry align="left" valign="top"><para>小文字の u、サーカムフレックス</para></entry></row>
<row>
<entry align="left" valign="top"><para>&ugrave;</para></entry>
<entry align="left" valign="top"><para><literal>&amp;ugrave;</literal></para></entry>
<entry align="left" valign="top"><para>小文字の u、グラーブ・アクセント記号</para></entry></row>
<row>
<entry align="left" valign="top"><para>&uuml;</para></entry>
<entry align="left" valign="top"><para><literal>&amp;uuml;</literal></para></entry>
<entry align="left" valign="top"><para>小文字の u、ウムラウト記号</para></entry></row>
<row>
<entry align="left" valign="top"><para>&yacute;</para></entry>
<entry align="left" valign="top"><para><literal>&amp;yacute;</literal></para></entry>
<entry align="left" valign="top"><para>小文字の y、アキュート・アクセント記号</para></entry></row>
<row>
<entry align="left" valign="top"><para>&yuml;</para></entry>
<entry align="left" valign="top"><para><literal>&amp;yuml;</literal></para></entry>
<entry align="left" valign="top"><para>小文字の y、ウムラウト記号</para></entry></row>
<row>
<entry align="left" valign="top"><para>&Aacute;</para></entry>
<entry align="left" valign="top"><para><literal>&amp;Aacute;</literal></para></entry>
<entry align="left" valign="top"><para>大文字の a、アキュート・アクセント記号</para></entry></row>
<row>
<entry align="left" valign="top"><para>&Acirc;</para></entry>
<entry align="left" valign="top"><para><literal>&amp;Acirc;</literal></para></entry>
<entry align="left" valign="top"><para>大文字の a、サーカムフレックス</para></entry></row>
<row>
<entry align="left" valign="top"><para>&AElig;</para></entry>
<entry align="left" valign="top"><para><literal>&amp;AElig;</literal></para></entry>
<entry align="left" valign="top"><para>大文字の ae 二重母音</para></entry></row>
<row>
<entry align="left" valign="top"><para>&Agrave;</para></entry>
<entry align="left" valign="top"><para><literal>&amp;Agrave;</literal></para></entry>
<entry align="left" valign="top"><para>大文字の a、グラーブ・アクセント記号</para></entry></row>
<row>
<entry align="left" valign="top"><para>&Aring;</para></entry>
<entry align="left" valign="top"><para><literal>&amp;Aring;</literal></para></entry>
<entry align="left" valign="top"><para>大文字の a、リング</para></entry></row>
<row>
<entry align="left" valign="top"><para>&Atilde;</para></entry>
<entry align="left" valign="top"><para><literal>&amp;Atilde;</literal></para></entry>
<entry align="left" valign="top"><para>大文字の a、チルド</para></entry></row>
<row>
<entry align="left" valign="top"><para>&Auml;</para></entry>
<entry align="left" valign="top"><para><literal>&amp;Auml;</literal></para></entry>
<entry align="left" valign="top"><para>大文字の a、ウムラウト記号</para></entry></row>
<row>
<entry align="left" valign="top"><para>&Ccedil;</para></entry>
<entry align="left" valign="top"><para><literal>&amp;Ccedil;</literal></para></entry>
<entry align="left" valign="top"><para>大文字の c、セディーユ</para></entry></row>
<row>
<entry align="left" valign="top"><para>&Eacute;</para></entry>
<entry align="left" valign="top"><para><literal>&amp;Eacute;</literal></para></entry>
<entry align="left" valign="top"><para>大文字の e、アキュート・アクセント記号</para></entry></row>
<row>
<entry align="left" valign="top"><para>&Ecirc;</para></entry>
<entry align="left" valign="top"><para><literal>&amp;Ecirc;</literal></para></entry>
<entry align="left" valign="top"><para>大文字の e、サーカムフレックス</para></entry></row>
<row>
<entry align="left" valign="top"><para>&Egrave;</para></entry>
<entry align="left" valign="top"><para><literal>&amp;Egrave;</literal></para></entry>
<entry align="left" valign="top"><para>大文字の e、グラーブ・アクセント記号</para></entry></row>
<row>
<entry align="left" valign="top"><para>&ETH;</para></entry>
<entry align="left" valign="top"><para><literal>&amp;ETH;</literal></para></entry>
<entry align="left" valign="top"><para>大文字の eth、アイスランド語</para></entry></row>
<row>
<entry align="left" valign="top"><para>&Euml;</para></entry>
<entry align="left" valign="top"><para><literal>&amp;Euml;</literal></para></entry>
<entry align="left" valign="top"><para>大文字の e、ウムラウト記号</para></entry></row>
<row>
<entry align="left" valign="top"><para>&Iacute;</para></entry>
<entry align="left" valign="top"><para><literal>&amp;Iacute;</literal></para></entry>
<entry align="left" valign="top"><para>大文字の i、アキュート・アクセント記号</para></entry></row>
<row>
<entry align="left" valign="top"><para>&Icirc;</para></entry>
<entry align="left" valign="top"><para><literal>&amp;Icirc;</literal></para></entry>
<entry align="left" valign="top"><para>大文字の i、サーカムフレックス</para></entry></row>
<row>
<entry align="left" valign="top"><para>&Igrave;</para></entry>
<entry align="left" valign="top"><para><literal>&amp;Igrave;</literal></para></entry>
<entry align="left" valign="top"><para>大文字の i、グラーブ・アクセント記号</para></entry></row>
<row>
<entry align="left" valign="top"><para>&Iuml;</para></entry>
<entry align="left" valign="top"><para><literal>&amp;Iuml;</literal></para></entry>
<entry align="left" valign="top"><para>大文字の i、ウムラウト記号</para></entry></row>
<row>
<entry align="left" valign="top"><para>&Ntilde;</para></entry>
<entry align="left" valign="top"><para><literal>&amp;Ntilde;</literal></para></entry>
<entry align="left" valign="top"><para>大文字の n、チルド</para></entry></row>
<row>
<entry align="left" valign="top"><para>&Oacute;</para></entry>
<entry align="left" valign="top"><para><literal>&amp;Oacute;</literal></para></entry>
<entry align="left" valign="top"><para>大文字の o、アキュート・アクセント記号</para></entry></row>
<row>
<entry align="left" valign="top"><para>&Ocirc;</para></entry>
<entry align="left" valign="top"><para><literal>&amp;Ocirc;</literal></para></entry>
<entry align="left" valign="top"><para>大文字の o、サーカムフレックス</para></entry></row>
<row>
<entry align="left" valign="top"><para>&Ograve;</para></entry>
<entry align="left" valign="top"><para><literal>&amp;Ograve;</literal></para></entry>
<entry align="left" valign="top"><para>大文字の o、グラーブ・アクセント記号</para></entry></row>
<row>
<entry align="left" valign="top"><para>&Oslash;</para></entry>
<entry align="left" valign="top"><para><literal>&amp;Oslash;</literal></para></entry>
<entry align="left" valign="top"><para>大文字の o、スラッシュ</para></entry></row>
<row>
<entry align="left" valign="top"><para>&Otilde;</para></entry>
<entry align="left" valign="top"><para><literal>&amp;Otilde;</literal></para></entry>
<entry align="left" valign="top"><para>大文字の o、チルド</para></entry></row>
<row>
<entry align="left" valign="top"><para>&Ouml;</para></entry>
<entry align="left" valign="top"><para><literal>&amp;Ouml;</literal></para></entry>
<entry align="left" valign="top"><para>大文字の o、ウムラウト記号</para></entry></row>
<row>
<entry align="left" valign="top"><para>&THORN;</para></entry>
<entry align="left" valign="top"><para><literal>&amp;THORN;</literal></para></entry>
<entry align="left" valign="top"><para>大文字の thorn、アイスランド語</para></entry></row>
<row>
<entry align="left" valign="top"><para>&Uacute;</para></entry>
<entry align="left" valign="top"><para><literal>&amp;Uacute;</literal></para></entry>
<entry align="left" valign="top"><para>大文字の u、アキュート・アクセント記号</para></entry></row>
<row>
<entry align="left" valign="top"><para>&Ucirc;</para></entry>
<entry align="left" valign="top"><para><literal>&amp;Ucirc;</literal></para></entry>
<entry align="left" valign="top"><para>大文字の u、サーカムフレックス</para></entry></row>
<row>
<entry align="left" valign="top"><para>&Ugrave;</para></entry>
<entry align="left" valign="top"><para><literal>&amp;Ugrave;</literal></para></entry>
<entry align="left" valign="top"><para>大文字の u、グラーブ・アクセント記号</para></entry></row>
<row>
<entry align="left" valign="top"><para>&Uuml;</para></entry>
<entry align="left" valign="top"><para><literal>&amp;Uuml;</literal></para></entry>
<entry align="left" valign="top"><para>大文字の u、ウムラウト記号</para></entry></row>
<row>
<entry align="left" valign="top"><para>&Yacute;</para></entry>
<entry align="left" valign="top"><para><literal>&amp;Yacute;</literal></para></entry>
<entry align="left" valign="top"><para>大文字の y、アキュート・アクセント記号</para></entry></row>
</tbody></tgroup></table>
</chapter>
<!--fickle 1.14 mif-to-docbook 1.7 01/02/96 16:48:20-->

View File

@@ -0,0 +1,221 @@
<!-- $XConsortium: ch06.sgm /main/9 1996/08/26 10:45:30 rws $ -->
<!-- (c) Copyright 1995 Digital Equipment Corporation. -->
<!-- (c) Copyright 1995 Hewlett-Packard Company. -->
<!-- (c) Copyright 1995 International Business Machines Corp. -->
<!-- (c) Copyright 1995 Sun Microsystems, Inc. -->
<!-- (c) Copyright 1995 Novell, Inc. -->
<!-- (c) Copyright 1995 FUJITSU LIMITED. -->
<!-- (c) Copyright 1995 Hitachi. -->
<chapter id="HRDC.CmdS.div.1">
<title id="HRDC.CmdS.mkr.1">コマンドの要約</title>
<para>この章では、ヘルプ・コマンドが端末ウィンドウで手動で実行されるときに使用可能なコマンド行オプションを要約します。
</para>
<sect1 id="HRDC.CmdS.div.2">
<title>ヘルプ・システム・コマンド</title>
<para>ヘルプ・システムが提供するデスクトップのアクションとデータ型により、ヘルプ・ファイルのアイコンをクリックするかメニュー項目を選択すると、実行時のヘルプ・ファイルをコンパイルしたり表示することができます。しかし、特定のコマンド・オプションを選択する場合、端末エミュレータで手動でコマンドを入力するか、新しいアクションを作成しなければなりません。
</para>
<para>ヘルプのアクションとデータ型は、<filename>/usr/dt/appconfig/types/</filename><symbol role="Variable">lang</symbol> ディレクトリにある2つのファイル <filename>dthelp.dt</filename> および <filename>dtdocbook.dt</filename> に定義されています。
</para>
<para>ここで要約されているコマンドは、次のとおりです。</para>
<informaltable>
<tgroup cols="2" colsep="0" rowsep="0">
<colspec align="left" colwidth="145*">
<colspec align="left" colwidth="383*">
<tbody>
<row>
<entry align="left" valign="top"><para><command>dtDocBook</command></para></entry>
<entry align="left" valign="top"><para>DocBook のソース・ファイルを実行ファイルにコンパイルします。
</para></entry></row>
<row>
<entry align="left" valign="top"><para><command>dthelpview</command></para></entry>
<entry align="left" valign="top"><para>ヘルプ・ボリューム、ヘルプ・トピック、テキスト・ファイルまたはマニュアル・ページを表示します。
</para></entry></row>
<row>
<entry align="left" valign="top"><para><command>dthelpgen</command></para></entry>
<entry align="left" valign="top"><para>各ファミリ・ファイルのエントリが入っている新しいヘルプ・ボリューム <filename>index.hv</filename> にヘルプ・ファミリ・ファイルを格納します。
</para></entry></row></tbody></tgroup></informaltable>
</sect1>
<sect1 id="HRDC.CmdS.div.3">
<title id="HRDC.CmdS.mkr.2">DocBook ファイルの処理 (dtdocbook)</title>
<para>DocBook ソフトウェアは、<command>dtdocbook</command> コマンドで起動され、DocBook のソース・ファイルを実行時のヘルプ・ファイルにコンパイルします。<symbol role="Variable">volume</symbol><filename>.sgm</filename> ファイルがあるディレクトリで <command>dtdocbook</command> を実行してください。
</para>
<sect2 id="HRDC.CmdS.div.4">
<title>コマンド形式</title>
<programlisting>dtdocbook [command-options] volume</programlisting>
<para><symbol role="Variable">command-options</symbol> は、<symbol role="Variable">volume</symbol> 名の後に入力されるオプションです。</para>
</sect2>
<sect2 id="HRDC.CmdS.div.5">
<title>コマンド・オプション</title>
<informaltable>
<tgroup cols="2" colsep="0" rowsep="0">
<colspec align="left" colwidth="116*">
<colspec align="left" colwidth="412*">
<tbody>
<row>
<entry align="left" valign="top"><para><command>-c</command></para></entry>
<entry align="left" valign="top"><para>既存の SDL ファイルを圧縮します。入力ファイルの拡張子は、&ldquo;<filename>.sdl</filename>&rdquo; であることを仮定します。</para></entry>
</row>
<row>
<entry align="left" valign="top"><para><command>-d</command></para></entry>
<entry align="left" valign="top"><para>既存の SDL ファイルを伸張します。入力ファイルの拡張子は、&ldquo;<filename>.sdl</filename>&rdquo; であることを仮定します。
</para></entry></row>
<row>
<entry align="left" valign="top"><para><command>-h</command></para></entry>
<entry align="left" valign="top"><para>(ヘルプ) <command>dtdocbook</command> コマンドの形式およびオプションのリストを、標準出力に表示します。
</para></entry>
</row>
<row>
<entry align="left" valign="top"><para><command>-l</command></para></entry>
<entry align="left" valign="top"><para>ログを <filename>basename.log</filename> に出力します。</para></entry></row>
<row>
<entry align="left" valign="top"><para><command>-m</command></para></entry>
<entry align="left" valign="top"><para>(マップ) 追加の SDATA および/または文字のマッピング・ファイルを追加します。
</para></entry></row>
<row>
<entry align="left" valign="top"><para><command>-o</command> <filename>file</filename></para></entry>
<entry align="left" valign="top"><para><filename>file</filename> を出力ファイル名として使用します。ファイル名に拡張子を付けてはいけません。
</para></entry></row>
<row>
<entry align="left" valign="top"><para><command>-r</command></para></entry>
<entry align="left" valign="top"><para>すべての中間ファイルおよび出力ファイルを削除します。それらが存在しない場合でも、通知はしません。
</para></entry></row>
<row>
<entry align="left" valign="top"><para><command>-u</command></para></entry>
<entry align="left" valign="top"><para>(非圧縮) 翻訳中、出力ファイルの圧縮を行いません。
</para></entry></row>
<row>
<entry align="left" valign="top"><para><command>-v</command></para></entry>
<entry align="left" valign="top"><para>(饒舌) <command>dtdocbook</command> の処理中にパーサのメッセージを生成、表示します。
</para></entry>
</row></tbody></tgroup></informaltable>
<para><command>-c</command> オプションが指定され、ファイルがすでに圧縮されている場合は、ファイルは伸張されてから、再度圧縮されます。この処理は、圧縮された SDL ファイルの統合性を検証する手段として有用です。
</para>
<para><command>-d</command> オプションが指定され、ファイルがすでに伸張されている場合は、再度の解析、すべての前計算の実行が行われ、ファイルは再度書き込まれます。この処理は、SDL ファイルの統合性を検証する手段として有用です。また、たとえば SDL ファイルを直接編集したことによって、再計算が必要になったとき、個々のヘルプ・トピックのバイト・オフセットを含む目次の再計算を強制的に実行させる場合にも有用です。
</para>
<sect3 id="HRDC.CmdS.div.7">
<title>関連項目</title>
<itemizedlist remap="Bullet1"><listitem><para><xref role="HeadingAndPage"
linkend="HRDC.CrHV.mkr.2"></para>
</listitem><listitem><para><xref role="HeadingAndPage" linkend="HRDC.Inst.mkr.5">
</para>
</listitem><listitem><para><xref role="HeadingAndPage" linkend="HRDC.CrHV.mkr.6"></para>
</listitem><listitem><para><filename moreinfo="RefEntry">dtdocbook</filename>(1)
マニュアル・ページ</para>
</listitem></itemizedlist>
</sect3>
</sect2>
</sect1>
<sect1 id="HRDC.CmdS.div.8">
<title id="HRDC.CmdS.mkr.4">ヘルプ・トピックの表示 (dthelpview)</title>
<para><command>dthelpview</command> コマンドは、ヘルプ・ボリューム、個々のヘルプ・トピック、テキスト・ファイル、またはマニュアル・ページを表示するために使用できます。
</para>
<sect2 id="HRDC.CmdS.div.9">
<title>コマンド形式</title>
<para>ヘルプビューを起動するには、次のようにいくつかの方法があります。</para>
<itemizedlist><listitem><para><command>dthelpview -helpVolume <symbol role="Variable">volume</symbol> [ -locationId <symbol role="Variable">id</symbol> ]</command>
</para>
</listitem><listitem><para><command>dthelpview -man</command></para>
</listitem><listitem><para><command>dthelpview -manPage</command> <symbol role="Variable">man</symbol></para>
</listitem><listitem><para><command>dthelpview -file</command> <symbol role="Variable">filename</symbol></para>
</listitem></itemizedlist>
<para>オプションの機能を次に示します。</para>
<informaltable>
<tgroup cols="2" colsep="0" rowsep="0">
<colspec align="left" colwidth="188*">
<colspec align="left" colwidth="340*">
<tbody>
<row>
<entry align="left" valign="top"><para><command>-helpVolume</command> <symbol role="Variable">volume</symbol></para></entry>
<entry align="left" valign="top"><para>表示したい <symbol role="Variable">volume</symbol><filename>.sdl</filename> ファイルの名前を指定します。ボリュームが現在のディレクトリになく、<emphasis>かつ</emphasis>、ボリュームが登録されていない場合はパス名が必要です。
</para></entry></row>
<row>
<entry align="left" valign="top"><para><command>-locationId</command> <symbol role="Variable">id</symbol></para></entry>
<entry align="left" valign="top"><para>IDを指定します。<command>dthelpview</command> は、<symbol role="Variable">id</symbol> が入っているトピックを表示します。IDを指定しない場合、ヘルプビューはデフォルトとして <filename>_hometopic</filename> を使用します。</para></entry></row>
<row>
<entry align="left" valign="top"><para><command>-man</command></para></entry>
<entry align="left" valign="top"><para>表示するマニュアル・ページを要求するダイアログを表示してから、要求されたマニュアル・ページを表示します。
</para></entry></row>
<row>
<entry align="left" valign="top"><para><command>-manPage</command> <symbol role="Variable">man</symbol></para></entry>
<entry align="left" valign="top"><para>特定のマニュアル・ページが表示されるように指定します。
</para></entry></row>
<row>
<entry align="left" valign="top"><para><command>-file</command> <symbol role="Variable">filename</symbol></para></entry>
<entry align="left" valign="top"><para>特定のテキスト・ファイルが表示されるように指定します。
</para></entry></row></tbody></tgroup></informaltable>
<para>デフォルトの <symbol role="Variable">volume</symbol> と <symbol role="Variable">id</symbol> は <command>dthelpview</command> の app-defaults ファイルである <filename>/usr/dt/app-defaults/C/Dthelpview</filename> に設定できます。
</para>
<sect3 id="HRDC.CmdS.div.10">
<title>関連項目</title>
<itemizedlist><listitem><para><xref role="SecTitleAndPageNum" linkend="HRDC.Inst.mkr.9">
</para>
</listitem><listitem><para><xref role="SecTitleAndPageNum" linkend="HRDC.CrHV.mkr.6"></para>
</listitem><listitem><para><command>dthelpview</command>(1) マニュアル・ページ</para>
</listitem></itemizedlist>
</sect3>
</sect2>
</sect1>
<sect1 id="HRDC.CmdS.div.11">
<title id="HRDC.CmdS.mkr.5">索引ボリュームの生成 (dthelpgen)</title>
<para><command>dthelpgen</command> ユーティリティは、フロントパネルのヘルプ・ビューアを使用してシステムに登録されたヘルプ・ボリュームを表示できるようにする特殊なヘルプ・ボリュームを作成します。フロントパネルの[ヘルプ・ビューア]コントロールを最初にクリックすると、<command>dthelpgen</command> は自動的に実行されます。ヘルプ検索パス・ディレクトリ(ローカルな、またはネットワーク化されたディレクトリ)を検索してヘルプ・ファミリ・ファイルを位置付け、次にユーザの <filename>HomeDirectory/.dt/help/$DTUSERSESSION</filename> ディレクトリに 索引ボリューム (<filename>index.hv</filename>) を作成します。一度作成されると、ボリュームは次のアクションのいずれかに応じて更新されます。
</para>
<itemizedlist><listitem><para>ファミリ・ファイルまたはヘルプ・ボリュームの追加、削除、または変更
</para>
</listitem><listitem><para><systemitem class="environvar">LANG</systemitem> 環境変数の変更</para>
</listitem><listitem><para><literal>ReloadApps</literal> アクションの起動</para>
</listitem><listitem><para>端末エミュレータ上での <command>dthelpgen</command> の手動による実行
</para>
</listitem></itemizedlist>
<para>索引ボリュームは、フロントパネルの[ヘルプ・ビューア]コントロールをクリックすると表示されます。または、<command>dthelpview</command> を手動で実行し、次のコマンド行で示されているように索引ボリューム名を指定することができます。
</para>
<programlisting>dthelpview -h index.hv</programlisting>
<sect2 id="HRDC.CmdS.div.12">
<title>コマンド形式</title>
<programlisting>dthelpgen -dir [<symbol role="Variable">options</symbol>]
</programlisting>
<para>オプションの機能を次に示します。</para>
<informaltable>
<tgroup cols="2" colsep="0" rowsep="0">
<colspec align="left" colwidth="100*">
<colspec align="left" colwidth="356*">
<tbody>
<row>
<entry><para><command>-dir</command></para></entry>
<entry><para>索引ボリュームと中間ファイルを格納するディレクトリを指定します。これは、必須のパラメータです。
</para></entry></row></tbody>
</tgroup></informaltable>
</sect2>
<sect2 id="HRDC.CmdS.div.13">
<title>オプション</title>
<informaltable>
<tgroup cols="2" colsep="0" rowsep="0">
<colspec align="left" colwidth="167*">
<colspec align="left" colwidth="361*">
<tbody>
<row>
<entry align="left" valign="top"><para><command>-generate</command></para></entry>
<entry align="left" valign="top"><para>システム上のファミリ・ファイルとヘルプ・ボリュームが変更されていない場合でも新しい索引ヘルプ・ボリュームが作成されるように指定します。
</para></entry></row>
<row>
<entry align="left" valign="top"><para><command>-file</command> <symbol role="Variable">basename</symbol></para></entry>
<entry align="left" valign="top"><para><command>dthelpgen</command> が作成したヘルプ・ボリュームと中間ファイルの名前を指定します。デフォルトの名前は <filename>index.hv</filename> です。</para></entry></row>
<row>
<entry align="left" valign="top"><para><command>-lang</command></para></entry>
<entry align="left" valign="top"><para>どの言語ディレクトリのヘルプ・ファミリとヘルプ・ボリュームを検索するかを指定します。<command>-lang</command> オプションを設定すると、<systemitem class="environvar">LANG</systemitem> 環境変数の現在値よりも優先されます。
</para></entry>
</row></tbody></tgroup><?Pub Caret></informaltable>
<note>
<para>索引ボリュームがヘルプ・ウィンドウに表示されている間に <command>dthelpgen</command> を実行する場合、ウィンドウを閉じてから索引ボリュームをもう一度開いてください。
</para>
</note>
<sect3 id="HRDC.CmdS.div.14">
<title>関連項目</title>
<itemizedlist><listitem><para><xref role="SecTitleAndPageNum" linkend="HRDC.Inst.mkr.9"></para>
</listitem><listitem><para><command moreinfo="RefEntry">dthelpgen</command>(1)
マニュアル・ページ</para>
</listitem></itemizedlist>
</sect3>
</sect2>
</sect1>
</chapter>
<!--fickle 1.14 mif-to-docbook 1.7 01/02/96 16:48:20-->

View File

@@ -0,0 +1,391 @@
<!-- $XConsortium: ch07.sgm /main/13 1996/09/08 19:40:15 rws $ -->
<!-- (c) Copyright 1995 Digital Equipment Corporation. -->
<!-- (c) Copyright 1995 Hewlett-Packard Company. -->
<!-- (c) Copyright 1995 International Business Machines Corp. -->
<!-- (c) Copyright 1995 Sun Microsystems, Inc. -->
<!-- (c) Copyright 1995 Novell, Inc. -->
<!-- (c) Copyright 1995 FUJITSU LIMITED. -->
<!-- (c) Copyright 1995 Hitachi. -->
<chapter id="HRDC.Sgml.div.1">
<title id="HRDC.Sgml.mkr.1">DocBook 文書型定義の読み方</title>
<para>この章では、DocBook 2.2.1 文書型定義 (DTD) の読み方と、Standard Generalized Markup Language (SGML) に完全に準拠したヘルプ・ファイルを作成するための DTD の使用方法について説明します。
</para>
<informaltable id="HRDC.Sgml.itbl.1" frame="All">
<tgroup cols="1">
<colspec colname="1" colwidth="4.0 in">
<tbody>
<row rowsep="1">
<entry><para><!--Original XRef content: 'DocBook 1.3 DTD196'--><xref role="JumpText"
linkend="HRDC.Sgml.mkr.2"></para></entry></row>
<row rowsep="1">
<entry><para><!--Original XRef content: 'DTD Components196'--><xref role="JumpText"
linkend="HRDC.Sgml.mkr.3"></para></entry></row>
<row rowsep="1">
<entry><para><!--Original XRef content: 'Element Declarations196'--><xref
role="JumpText" linkend="HRDC.Sgml.mkr.4"></para></entry></row>
<row rowsep="1">
<entry><para><!--Original XRef content: 'Element Declaration Keywords198'--><xref
role="JumpText" linkend="HRDC.Sgml.mkr.5"></para></entry></row>
<row rowsep="1">
<entry><para><!--Original XRef content: 'Attribute List Declarations199'--><xref
role="JumpText" linkend="HRDC.Sgml.mkr.6"></para></entry></row>
<row rowsep="1">
<entry><para><!--Original XRef content: 'Formal Markup199'--><xref role="JumpText"
linkend="HRDC.Sgml.mkr.7"></para></entry></row></tbody></tgroup></informaltable>
<sect1 id="HRDC.Sgml.div.2">
<title>文書型定義</title>
<para><emphasis>文書型定義</emphasis> (DTD) は、構造化されたまたは階層のあるドキュメントを作成するための要素のセットを定義します。DTD は各要素の形式を指定し、ドキュメント内での要素の使用方法を決定します。
</para>
<sect2 id="HRDC.Sgml.div.3">
<title id="HRDC.Sgml.mkr.2">DocBook 2.1 DTD</title>
<para>The DocBook 2.2.1 DTD タグ・セットとその関連規則は、正規マークアップとして参照されます。DTD は Standard Generalized Markup Language (SGML) ISO 規定 8879:1986 に準拠しています。つまり、SGML 準拠のヘルプ・ファイルを作成するために、正規マークアップを使用できます。
</para>
<para>付録 A には、完全な DTD 仕様が掲載されています。DTD は、開発者用ツールキットでも使用できます。DTD は、<filename>/usr/dt/dthelp/dtdocbook/SGML</filename> ディレクトリにあり、名前は <filename>DocBook.dtd</filename> です。
</para>
<sect3 id="HRDC.Sgml.div.4">
<title>関連項目</title>
<itemizedlist><listitem><para><filename>dtdocbookdtd(4)</filename> マニュアル・ページ
</para>
</listitem></itemizedlist>
</sect3>
</sect2>
</sect1>
<sect1 id="HRDC.Sgml.div.5">
<title id="HRDC.Sgml.mkr.3">DTD コンポーネント</title>
<para>DTD は、これまでの章で説明した DocBook の各要素を定義します。この節では、いくつかの重要な用語を紹介し、要素記述の構文の読み方を説明します。DTD の各セクションを完全に説明するものではありません。
</para>
<sect2 id="HRDC.Sgml.div.6">
<title id="HRDC.Sgml.mkr.4">要素宣言</title>
<para>DocBook DTD は、各要素を<emphasis>要素宣言</emphasis>で定義します。宣言には、要素を説明する詳細な記述、それに必要なコンポーネント、指定できる要素またはできない要素を使用します。要素には、<emphasis>属性宣言</emphasis>で定義された特性もあります。特性についての詳細は、次の <xref role="SecTitleAndPageNum" linkend="HRDC.Sgml.mkr.6"> で説明します。</para>
<para>要素宣言、属性宣言いずれにおいても、DocBook DTD は、要素や属性のグループ化を表現するエンティティに代わるエンティティの拡張的な利用を行います。DTD では、これらのエンティティ宣言は、要素宣言および属性宣言に優先します。)
</para>
<para>たとえば、DTD は、ID、Lang (言語、Remap、Role、または XRefLabel のように、非常に多くの DocBook 要素がもつ共通属性のグループに代わる "%commonatts;" 参照のあるエンティティを宣言します。別の例では、DTD は、ItemizedList、OrderedList、SegmentedList、VariableList などに代わる "%list.gp;" 参照のあるエンティティを宣言します。
</para>
<para>要素宣言の形式は次のとおりです。</para>
<programlisting>&lt;!ELEMENT <symbol>element_type minimization (content model)</symbol>></programlisting>
<para>形式の説明を次に示します。</para>
<informaltable>
<tgroup cols="2" colsep="0" rowsep="0">
<colspec align="left" colwidth="116*">
<colspec align="left" colwidth="412*">
<tbody>
<row>
<entry align="left" valign="top"><para><symbol>element_type</symbol></para></entry>
<entry align="left" valign="top"><para>要素名を指定します。これはタグ名としても使用されます。たとえば、要素型 Title のタグは &lt;Title> です。
</para></entry></row>
<row>
<entry align="left" valign="top"><para><symbol>minimization</symbol></para></entry>
<entry align="left" valign="top"><para>開始タグまたは終了タグが必要かどうかを示す2文字のエントリです。1番目の文字は開始タグを表します。2番目の文字は終了タグを表します。その2文字の間には、ひとつの空白が入ります。文字 <literal>O</literal> は、そのタグがオプションであることを意味します。<literal>-</literal>(マイナス記号)は、タグが必要であることを意味します。</para><para>たとえば、<literal>- -</literal> というエントリは、その要素には開始タグと終了タグの両方が必要である、という意味になります。DocBook 2.2.1 の DTD では、ほとんどすべての要素に開始タグと終了タグが必要です。
</para></entry>
</row>
<row>
<entry align="left" valign="top"><para><symbol>content model</symbol></para></entry>
<entry align="left" valign="top"><para>要素型に含められる必要な要素およびオプションの要素のリストを指定します。要素のシーケンスと、適用可能であれば、要素を指定できる回数を定義します。また、疑問の要素内に含むことができない要素も指定します。
</para></entry></row></tbody></tgroup></informaltable>
<para>content model は、次の記述を使用します。</para>
<informaltable>
<tgroup cols="2" colsep="0" rowsep="0">
<colspec align="left" colwidth="106*">
<colspec align="left" colwidth="422*">
<tbody>
<row>
<entry align="left" valign="top"><para><literal>|</literal></para></entry>
<entry align="left" valign="top"><para>縦棒は、「または」を意味します。
</para></entry></row>
<row>
<entry align="left" valign="top"><para><literal>+</literal></para></entry>
<entry align="left" valign="top"><para>要素名の後のプラス記号は、その要素が少くとも1回は現われなければならないこと、および繰り返しが可能であることを意味します。
</para></entry></row>
<row>
<entry align="left" valign="top"><para><literal>*</literal></para></entry>
<entry align="left" valign="top"><para>要素名の後のアスタリスクは、その要素が0回あるいは何回でも現われることを意味します。
</para></entry></row>
<row>
<entry align="left" valign="top"><para><literal>?</literal></para></entry>
<entry align="left" valign="top"><para>要素名の後の疑問符は、その要素が0回または1回現われることを意味します。
</para></entry></row>
<row>
<entry align="left" valign="top"><para>,</para></entry>
<entry align="left" valign="top"><para>コンマはシーケンスを説明します。すなわち、コンマの前の要素型に、コンマの後に指定された要素が続かなければなりません。
</para></entry></row>
<row>
<entry align="left" valign="top"><para><literal>+</literal> (<symbol>element_
type(s)</symbol>)</para></entry>
<entry align="left" valign="top"><para><literal>+</literal> (プラス記号) は、リストされたまたは括弧で囲まれた要素が、要素型の内部か、それを含む要素の内部で使用できることを示します。これを取り込みと呼びます。
</para></entry></row>
<row>
<entry align="left" valign="top"><para><literal>-</literal> (<symbol>element_
type(s)</symbol>)</para></entry>
<entry align="left" valign="top"><para><literal>-</literal> (マイナス記号) は、リストされたまたは括弧で囲まれた要素が、要素型の内部か、それを含む要素の内部で使用できないことを示します。これを排他と呼びます。
</para></entry></row></tbody></tgroup></informaltable>
<sect3 id="HRDC.Sgml.div.7">
<title>例</title>
<para>各例は、要素宣言とその意味するところを示しています。
</para>
<itemizedlist><listitem><para>次の例は、Appendix 要素に、開始タグと終了タグの両方が必須であることを宣言しています。さらに、その後に必須の Title が続く オプションの DocInfo 要素、その後にエンティティ参照 "%sect.gp;"名前としては、Sect1 およびそれに許されるサブコンポーネント)によって参照されるひとつまたは複数の要素が続くオプションの TitleAbbref を含むことができることを示しています。また、エンティティ参照 "%ubiq.gp;"名前としては、IndexTermsによって参照される要素が、Appendix またはそのサブコンポーネントの内部に取り込むことができることも宣言しています。
</para>
<programlisting>&lt;:!ELEMENT Appendix - - (DocInfo?, Title, TitleAbbrev?, (%sect1.gp;)) +(%ubiq.gp;) >
</programlisting>
</listitem><listitem><para>次の例は、OrderedList 要素に開始タグと終了タグの両方が必須であること、および少くともひとつの ListItem を含まなければならないこと、を宣言しています。
</para>
<programlisting>&lt;!ELEMENT OrderedList - - (ListItem+) ></programlisting>
</listitem><listitem><para>次の例は、ListItem 要素に開始タグと終了タグの両方が必須であること、他の要素の間に Paragraph、List、および Table を含むエンティティ参照 "%component.gp;" によって参照される要素のグループを少くともひとつ含まなければならないこと、を宣言しています。
</para>
<programlisting>&lt;!ELEMENT ListItem - - ((%component.gp;)+) ></programlisting>
</listitem><listitem><para>次の例は、Sect1 要素に開始タグと終了タグの両方が必須であることを宣言しています。さらに、Sect1 が、必須の Title とオプションの TitleAbbrev をもつことを宣言しています。次に、Sect1 が0個またはひとつ以上の ToC、LoT、Index、Glossary、および Bibliographyこれらは、エンティティ参照 "%nav.gp;" によって参照される要素ですをもつことを宣言しています。それから、Sect1 要素が、エンティティ要素 "%component.gp;" によって参照される要素のグループを、少くともひとつ含まなければならないことを宣言しています。これは、他の要素の間に Paragraph、List、および Table を含み、これらの後には、オプションで0個またはひとつ以上の Sect2 や RefEntry が続きます。
</para>
<programlisting>&lt;!ELEMENT Sect1 - - (Title, TitleAbbrev?, (%nav.gp;)*, (((%component.gp;)+, (RefEntry* | Sect2*)) | RefEntry+ | Sect2+), (%nav.gp;)*) +(%ubiq.gp;) >
</programlisting>
</listitem><listitem><para>次の例は、InformalTalbe 要素に、開始タグと終了タグの両方が必須であることを宣言しています。さらに、InformalTalbe が、ひとつまたは複数の Graphic または TGroupこれはエンティティ参照 "%tblcontent.gp;" によって参照される文字列の意味ですを含まなければならないことを宣言しています。また、InformalTable 要素が、Talbe や別の InformalTalbe を含むことができないことを宣言しています。
</para>
<programlisting>&lt;!ELEMENT InformalTable - - ((%tblcontent.gp;)) -(Table|InformalTable)>
</programlisting>
</listitem><listitem><para>次の例は、TGroup 要素には、開始タグが必須で終了タグは必須ではないこと、0個またはひとつ以上の ColSpec、個またはひとつ以上の spanSpec、個またはひとつ以上の THead、個またはひとつの TFoot、および必須の TBody という要素を、この順序で含むことができること、を宣言しています。
</para>
<programlisting>&lt;!ELEMENT TGroup - O (ColSpec*, SpanSpec*, THead?, TFoot?, TBody) >
</programlisting>
</listitem></itemizedlist>
</sect3>
</sect2>
<sect2 id="HRDC.Sgml.div.8">
<title id="HRDC.Sgml.mkr.5">要素宣言のキーワード</title>
<para>要素の中には、要素宣言の中に、要素のデータ内容を説明するキーワードを含むものがあります。DTD には、<computeroutput>EMPTY</computeroutput>、<computeroutput>CDATA</computeroutput>、および <computeroutput>#PCDATA</computeroutput> という3つのキーワードがあります。
</para>
<informaltable>
<tgroup cols="2" colsep="0" rowsep="0">
<colspec align="left" colwidth="110*">
<colspec align="left" colwidth="418*">
<tbody>
<row>
<entry align="left" valign="top"><para><computeroutput>EMPTY</computeroutput></para></entry>
<entry align="left" valign="top"><para>要素が、オンライン情報で表示されるデータ内容をもたないことを指定します。
</para></entry></row>
<row>
<entry align="left" valign="top"><para><computeroutput>CDATA</computeroutput></para></entry>
<entry align="left" valign="top"><para>「文字データ」を表します。つまり、その要素のデータ内容は、マークアップとして認識されません。
</para></entry>
</row>
<row>
<entry align="left" valign="top"><para><computeroutput>#PCDATA</computeroutput></para></entry>
<entry align="left" valign="top"><para>「構文解析された文字データ」を表します。つまり、そのデータ内容にはヘルプ・システムのパーサが解釈するテキストとマークアップ文字の両方が含まれます。
</para></entry></row></tbody>
</tgroup></informaltable>
</sect2>
<sect2 id="HRDC.Sgml.div.9">
<title id="HRDC.Sgml.mkr.6">属性リスト宣言</title>
<para>属性リストは、要素をより詳しく説明する追加の属性を宣言します。属性リスト宣言の形式は次のとおりです。
</para>
<programlisting>&lt;!ATTLIST <symbol>element_type attribute_values default_value</symbol>></programlisting>
<sect3 id="HRDC.Sgml.div.7a">
<title>例</title>
<para>次の各例は、属性リスト宣言を示し、それが意味するところを説明しています。
</para>
<itemizedlist><listitem><para>次の属性リスト宣言は、要素 Para が共通の属性をもち、それらにデフォルト値がないことを意味しています。
</para>
<programlisting>&lt;!ATTLIST Para %commonatts; ></programlisting>
</listitem><listitem><para>次の属性リスト宣言は、要素 Sect1 が共通の属性、および Label 属性と Renderas 属性をもつことを意味しています。Label 属性は、その値として「文字データ」をとり、そのデフォルト値は #IMPLIED です。Renderas 属性(これは Sect1 がどのように表示されるかを決定します)は、値 Sect2、Sect3、Sect4 および Sect5 をとることができます。たとえば、Renderas="Sect2" ならば、Sect1 は Sect2 と同じ形式で表示されます。
</para>
<programlisting>&lt;!ATTLIST Sect1
%commonatts;
Label CDATA #IMPLIED
Renderas (Sect2 | Sect3 | Sect4 | Sect5) #IMPLIED ></programlisting>
</listitem><listitem><para>次の属性リスト宣言は、要素 TFoot が共通の属性をもち、デフォルト値がなく、値として "Top"、"Middle"、および "Bottom" をとる("Top" がデフォルト値VAlign 属性をもつことを意味しています。
</para>
<programlisting>&lt;!ATTLIST TFoot
%commonatts;
VAlign (Top | Middle | Bottom) "Top" ></programlisting>
</listitem><listitem><para>次の属性リスト宣言は、要素 OrderedList が共通の属性をもち、デフォルト値がなく、他にいくつかの属性をもつことを意味しています。
</para>
<para>Numeration 属性は、OrderedList 中の ListItem にどのように数字が割りふられるかを決定します。これは、値として、"Arabic"(アラビア数字)、"Upperalpha"(大文字の英字)、"Loweralpha"(小文字の英字)、"Upperroman"(大文字のローマ数字)、"Lowerroman"(小文字のローマ数字)のいずれかをとります。
</para>
<para>InheritNum 属性は、別の OrderedList に埋め込まれた OrderedList への数字の割りふりが、含むリストの数字の割りふりに埋め込まれる別のリストの項目に埋め込まれているリストの項目に、2a、2b、2c のように数字が割り付けられるかどうかを決定します。InheritNum は、値として、"Inherit" および "Ignore"(デフォルト値)をとります。
</para>
<para>Continuation 属性は、OrderedList への数字の割りふりが先行する OrderedList の数字の割りふりを続行するか、新規に開始するかを決定します。これは、値として、"Continues" および "Restarts"(デフォルト値)をとります。
</para>
<programlisting>&lt;!ATTLIST OrderedList
%commonatts;
Numeration (Arabic|Uperalpha|Loweralpha|Uperroman|Lowerroman)
#IMPLIED
InheritNum (Inherit|Ignore) Ignore
Continuation (Continues|Restarts) Restarts
></programlisting>
</listitem></itemizedlist>
</sect3>
</sect2>
</sect1>
<sect1 id="HRDC.Sgml.div.10">
<title id="HRDC.Sgml.mkr.7">正規マークアップ</title>
<para>基本的な要素のセットを習得した後は、構造化エディタの使用が、正規マークアップ作成の最良の方法です。構造化エディタでは、メニューから要素を選択することによって、正規マークアップを作成します。操作に応じて、構造化エディタは、各要素に必要なすべてのタグを生成します。さらに、構造化エディタは、作成された構造フレームワークが文書型定義に準拠するかどうか検証します。
</para>
<sect2 id="HRDC.Sgml.div.11">
<title id="HRDC.Sgml.mkr.8">正規マークアップの注意点</title>
<para>DocBook は、正規マークアップ言語です。ほとんどすべての要素に、開始タグと終了タグが必須です。開始タグが <symbol>&lt;ElementName></symbol> ならば、終了タグは / (順スラッシュ) が終了タグとしてのマークになる <symbol>&lt;/ElementName></symbol> という形式になります。
</para>
<para>正規マークアップでは、各要素、そのコンポーネント部分、およびそれが含む要素は、明示的にタグが付けられなければなりません。たとえば、次に示すのは、2つのエントリを含む Table 中の Row のためのスキーマにしたがった正規マークアップです。(この例および他のマークアップ例では読みやすくするために、タグの字下げを行っています。字下げは、実際のマークアップでは必須ではありません。)
</para>
<programlisting>&lt;row>
&lt;entry align="left" valign="top">
&lt;para><symbol>contents of first entry</symbol>&lt;/para>
&lt;/entry>
&lt;entry align="left"valign="top">
&lt;para><symbol>contents of second entry</symbol>&lt;/para>
&lt;/entry>
&lt;row>
</programlisting>
<para>Row のサブコンポーネント、Entry と Para が、おのおのそれ自身の開始タグと終了タグをもっていることに注意してください。
</para>
</sect2>
<sect2 id="HRDC.Sgml.div.13">
<title id="HRDC.Sgml.mkr.9">要素の明確な階層</title>
<para>DTD 中の各要素宣言は、要素をどのようにそしてどこで使用することができるかを管理する規則のセットになります。要素は、さらに別の要素を含むことが可能な別の要素を含むため、文書は要素の階層になります。トップレベルでは、Part 要素が、ヘルプ・ボリューム中の他のすべての要素のコンテナになります。
</para>
<para>ヘルプ・トピックを作成するために、どのマークアップが必要なのかを決定するために、DocBook マークアップ言語を管理する規則に慣れる必要があります。
</para>
<para>マークアップ言語を学ぶひとつの方法は、使用を必要とするコンポーネントの要素宣言を学習することです。たとえば、章を作成するとしましょう。まず、次にリストされている Chapter の宣言をみてください。
</para>
<programlisting>&lt;!ELEMENT Chapter - - (DocInfo?, Title, TitleAbbrev?, (%sect1.gp;), (Index |
Glossary | Bibliography)*) +(%ubiq.gp;) ></programlisting>
<para>これは、Chapter が DocInfo コンポーネントをもつことを宣言しています。次に、それがどのように構築されるかをみるために、DocInfo の宣言をみてください。
</para>
<programlisting>&lt;!ELEMENT DocInfo - - (Title, TitleAbbrev?, Subtitle?, AuthorGroup+, Abstract*, RevHistory?, LegalNotice*) -(%ubiq.gp;) >
</programlisting>
<para>これは、DocInfo に、少くともひとつの Title とひとつまたは複数の AuthorGroup が必須であり、オプションでさまざまな他の要素を含むことができることを宣言しています。次に、それらがどのように構築されるかをみるために、Title 要素と AuthorGroup 要素の宣言をチェックします。
</para>
<programlisting>&lt;!ELEMENT Title - - ((%inlinechar.gp;)+) >
&lt;!ELEMENT AuthorGroup - - ((Author | Editor | Collab | CorpAuthor |
OtherCredit)+) >
</programlisting>
<para>この方法で、Chapter のすべてのサブコンポーネントおよびサブコンポーネントのすべてのサブコンポーネントについて、もっとも内側の要素まで調査し、それらがどのように機能するかを習得するまで続けることによって、Chapter の構築方法を学ぶことができます。
</para>
<para>しかしながら、幸いにも、構造化エディタを使用すれば、DTD およびマークアップのタグの形式について設計者が知らなければならないことを最小化できます。構造化エディタのアプリケーションは、DTD を「読み込み」、その多くが中間的な構造タグである各要素に必須のタグを作成します。
</para>
<sect3 id="HRDC.Sgml.div.14">
<title>例</title>
<para>次の正規マークアップの例は、デスクトップのテキスト・エディタのヘルプ・ボリュームからの抜粋です。関連するオンライン情報を表示するには、フロントパネルで[ヘルプ・ビューア]を選択します。「デスクトップの紹介」を選択し、リストされたボリュームの中から「テキスト・エディタのヘルプ」を選択します。テキスト・エディタ・ボリュームで「テキスト・エディタの使い方」を選択し、次に「既存のドキュメントを開くには」を選択します。
</para>
<para>テキストと関連する要素タグを読みやすくするために、この例では、字下げと余分な空白を使用しています。実際のマークアップでは、字下げと余分な空白の使用が、必ずしも必要ではないことを忘れないでください。
</para>
<programlisting>&lt;sect2 id=&ldquo;TOOPENANEXISTINGDOCUMENT&rdquo;>
&lt;title>既存のドキュメントを開くには&lt;/title>
&lt;para>テキスト・エディタまたはファイル・マネージャを使用して既存のファイルを開くことができます。&lt;/para>
&lt;IndexTerm>&lt;primary>ドキュメント &lt;secondary>開く&lt;/secondary>
&lt;/primary>&lt;/IndexTerm>
&lt;IndexTerm>&lt;primary>開く
&lt;secondary>既存のドキュメント&lt;/secondary>
&lt;/primary>&lt;/IndexTerm>
&lt;para>テキスト・エディタで既存のドキュメントを開くには&lt;/para>
&lt;OrderedList>
&lt;ListItem>
&lt;para> [ファイル]メニューから[開く]を選択します。&lt;/para>
&lt;para> ファイル選択ダイアログ・ボックスに、システムのファイルとフォルダの一覧が表示されます。表示されたドキュメントの一覧をブラウズしたり、システムの別のファイルをみるために、別のフォルダに変更することができます。&lt;/para>
&lt;/ListItem>
&lt;ListItem>
&lt;para> [ファイル]リストから開きたいドキュメントを選択するか、[ファイルを開く]フィールドにファイル名を入力します。&lt;/para>
&lt;para>&lt;emphasis>あるいは&lt;/emphasis> ドキュメントが現在のフォルダにない場合は、まず目的のドキュメントがあるフォルダに変更します。次に[フォルダ]リストから名前を選択するか、入力域かフォルダ名フィールドに変更したいフォルダのパス名を入力します。&lt;/para>
&lt;/ListItem>
&lt;ListItem>
&lt;para> リターン・キーを押すか、[了解]をクリックします。&lt;/para>
&lt;/ListItem>
&lt;/OrderedList>
&lt;graphic id="some-graphic-id" entityref="some-graphic-entity">&lt;/graphic>
&lt;para>ファイル・マネージャで既存のドキュメントを開くには&lt;/para>
&lt;IndexTerm>&lt;primary>開く
&lt;secondary>ファイル・マネージャでドキュメントを~&lt;/secondary>
&lt;/primary>&lt;/IndexTerm>
&lt;IndexTerm>&lt;primary>document
&lt;secondary>ファイル・マネージャで開く&lt;/secondary>
&lt;/primary>&lt;/IndexTerm>
&lt;IndexTerm>&lt;primary>ファイル・マネージャ
&lt;secondary>ドキュメントを開く&lt;/secondary>
&lt;/primary>&lt;/IndexTerm>
&lt;OrderedList>
&lt;ListItem>
&lt;para>ファイル・マネージャ・ウィンドウで、ドキュメントのファイル・アイコンを表示します。&lt;/para>
&lt;/ListItem>
&lt;ListItem>
&lt;para> 次のうちの<emphasis>ひとつを</emphasis>実行します。&lt;/para>
&lt;InformalList>
&lt;ListItem>
&lt;para>ドキュメントのファイル・アイコンをダブルクリックします。&lt;/para>
&lt;/ListItem>
&lt;ListItem>
&lt;para>ドキュメントを選択し、[選択]メニューから[開く]を選択します。&lt;/para>
&lt;/ListItem>
&lt;ListItem>
&lt;para>ドキュメントをフロントパネルのテキスト・エディタのコントロールにドラッグします。&lt;/para>
&lt;/ListItem>
&lt;/InformalList>
&lt;/ListItem>
&lt;/OrderedList>
&lt;sect3>
&lt;title>See Also&lt;/title>
&lt;InformalList>
&lt;ListItem>
&lt;para>&lt;xref linkend="some-sect-id" endterm="some-sects-title-id">&lt;/para>
&lt;/ListItem>
&lt;ListItem>
&lt;para>&lt;xref linkend="another-sect-id" endterm="another-sects-title-id">&lt;/para>
&lt;/ListItem>
&lt;ListItem>
&lt;para>&lt;xref linkend="some-other-sect-id" endterm="some-other-sects-title-id">&lt;/para>
&lt;/ListItem>
&lt;/InformalList>
&lt;sect3>
&lt;sect2>
</programlisting>
</sect3>
</sect2>
<sect2 id="HRDC.Sgml.div.15">
<title id="HRDC.Sgml.mkr.10">ファイル・エンティティ宣言</title>
<para>正規マークアップでファイル・エンティティを宣言するには、次の形式を使用します。
</para>
<programlisting>&lt;!entity <symbol>entityname</symbol> SYSTEM " <symbol>filename</symbol>"></programlisting>
<para><symbol>entityname</symbol> はエンティティ名で、<symbol>filename</symbol> はファイル名です。キーワード <computeroutput>SYSTEM</computeroutput> は必須です。</para>
<sect3 id="HRDC.Sgml.div.16">
<title>例</title>
<para>次の例は、3つのテキスト・から成り、グラフィック・イメージをひとつ含むヘルプ・ボリュームのエンティティ宣言です。
</para>
<programlisting>
&lt;!entity <symbol>MetaInformation</symbol> SYSTEM "<symbol>metainfo</symbol>">
&lt;!entity <symbol>BasicTasks</symbol> SYSTEM "<symbol>basics</symbol>">
&lt;!entity <symbol>AdvancedFeatures</symbol> SYSTEM "<symbol>advanced</symbol>">
&lt;!entity <symbol>process_diagram</symbol> SYSTEM "<symbol>process.tif</symbol>">
</programlisting>
</sect3>
</sect2>
</sect1>
</chapter>
<!--fickle 1.14 mif-to-docbook 1.7 01/02/96 16:48:20-->

View File

@@ -0,0 +1,254 @@
<!-- $XConsortium: ch08.sgm /main/12 1996/09/08 19:40:25 rws $ -->
<!-- (c) Copyright 1995 Digital Equipment Corporation. -->
<!-- (c) Copyright 1995 Hewlett-Packard Company. -->
<!-- (c) Copyright 1995 International Business Machines Corp. -->
<!-- (c) Copyright 1995 Sun Microsystems, Inc. -->
<!-- (c) Copyright 1995 Novell, Inc. -->
<!-- (c) Copyright 1995 FUJITSU LIMITED. -->
<!-- (c) Copyright 1995 Hitachi. -->
<chapter id="HRDC.CrDia.div.1">
<title id="HRDC.CrDia.mkr.1">ヘルプ・ダイアログ・ボックスの作成と管理</title>
<para>この章では、ヘルプ・ダイアログ・ウィジェットとその作成方法を説明します。
</para>
<informaltable id="HRDC.CrDia.itbl.1" frame="All">
<tgroup cols="1">
<colspec colname="1" colwidth="4.0 in">
<tbody>
<row rowsep="1">
<entry><para><!--Original XRef content: 'Help Dialog Boxes207'--><xref role="JumpText"
linkend="HRDC.CrDia.mkr.2"></para></entry></row>
<row rowsep="1">
<entry><para><!--Original XRef content: 'General Help Dialog208'--><xref role="JumpText"
linkend="HRDC.CrDia.mkr.3"></para></entry></row>
<row rowsep="1">
<entry><para><!--Original XRef content: 'To Create a General Help Dialog209'--><xref
role="JumpText" linkend="HRDC.CrDia.mkr.5"></para></entry></row>
<row rowsep="1">
<entry><para><!--Original XRef content: 'Quick Help Dialog211'--><xref role="JumpText"
linkend="HRDC.CrDia.mkr.6"></para></entry></row>
<row rowsep="1">
<entry><para><!--Original XRef content: 'To Create a Quick Help Dialog211'--><xref
role="JumpText" linkend="HRDC.CrDia.mkr.7"></para></entry></row>
<row rowsep="1">
<entry><para><!--Original XRef content: 'Summary of Application Program Interface214'--><xref
role="JumpText" linkend="HRDC.CrDia.mkr.8"></para></entry></row></tbody></tgroup>
</informaltable>
<sect1 id="HRDC.CrDia.div.2">
<title id="HRDC.CrDia.mkr.2">ヘルプ・ダイアログ・ボックス</title>
<indexterm><primary>作成</primary><secondary>ヘルプ・ダイアログ・ボックス</secondary>
</indexterm><indexterm><primary>ヘルプ・ダイアログ・ボックスの管理</primary></indexterm><indexterm><primary>ダイアログ・ボックス</primary><secondary>作成と管理</secondary></indexterm><indexterm><primary>ダイアログ・ボックス</primary><secondary>簡易ヘルプ</secondary></indexterm><indexterm><primary>ダイアログ・ボックス</primary>
<secondary>一般ヘルプ</secondary></indexterm><indexterm><primary>一般ヘルプ・ダイアログ・ボックス</primary><secondary>機能</secondary></indexterm>
<para>ヘルプ・システムは、アプリケーション・プログラマに対して、ヘルプ・ダイアログ・ボックスをすべての Motif アプリケーションに追加するプログラミング・ライブラリを提供します。ライブラリは、2種類のダイアログ・ボックスを提供します。
</para>
<itemizedlist remap="Bullet1"><listitem><para><emphasis>一般ヘルプ・ダイアログ</emphasis> には、メニューバー、トピック・ツリー、ヘルプ・トピック表示領域があります。トピック・ツリーには、ヘルプ・ボリュームのトピックとサブトピックが表示されます。ユーザは、表示するトピックを選択したり、使用可能なトピックをブラウズしたり、トピックがヘルプ・ボリュームのどこにあるかをみつけるために、トピック・ツリーを使用します。
</para>
</listitem><listitem><para><emphasis>簡易ヘルプ・ダイアログ</emphasis> には、トピック表示領域と、下部にひとつ以上のダイアログ・ボタンがあります。
</para>
</listitem></itemizedlist>
<sect2 id="HRDC.CrDia.div.3">
<title>標準の Xt パラダイム<indexterm><primary>ウィジェット・クラス</primary>
</indexterm><indexterm><primary>クラス、ダイアログ・ウィジェット</primary></indexterm></title>
<para><indexterm><primary>ウィジェット・リソース</primary></indexterm><indexterm>
<primary>リソース</primary><secondary>ヘルプ・ダイアログ・ボックス</secondary></indexterm>
プログラミングの観点からみると、ユーザは、アプリケーション内の他の Motif ウィジェットと対話するのと同じようにヘルプ・ダイアログと対話します。2種類のヘルプ・ダイアログ・ボックスは、2つの新しいウィジェット・クラス(<classname>DtHelpDialog</classname> と <classname>DtHelpQuickDialog</classname>)として定義されます。
</para>
<para>ボリューム名、トピックIDなどのヘルプ・ウィンドウの属性のほとんどは、ウィジェット・リソースとして処理されます。たとえば、新しいトピックを表示するには、<systemitem class="resource">DtNhelpVolume</systemitem>、<systemitem class="resource">DtNlocationId</systemitem>、および <systemitem class="resource">DtNhelpType</systemitem> の各リソースを設定するために <function>XtSetValues()</function> の呼び出しを実行するだけです。詳細については、<!--Original XRef content: '&ldquo;Displaying Help Topics&rdquo; on page&numsp;216'--><xref role="SecTitleAndPageNum" linkend="HRDC.HReq.mkr.3"> を参照してください。
</para>
<note>
<para>ヘルプ・システムをアプリケーションに統合するには、プログラミング言語、Motif プログラマーズ・ツールキット、Xt イントリンシクス・ツールキットに関する実用的な知識が必要です。
</para>
</note>
</sect2>
</sect1>
<sect1 id="HRDC.CrDia.div.4">
<title id="HRDC.CrDia.mkr.3">一般ヘルプ・ダイアログ</title>
<para>一般ヘルプ・ダイアログには、トピック・ツリーとトピック表示領域の2つの表示領域があります。トピック・ツリーは、スクロール可能なヘルプ・トピックのリストを提供しています。常にホーム・トピックのタイトルが1番目の項目になります。ユーザがタイトルを選択すると、そのタイトルに矢印 (→) が付き、そのヘルプ情報がトピック表示領域に表示されます。
<!--Original XRef content: 'Figure&numsp;9&hyphen;1 on page&numsp;209'--><xref role="CodeOrFigOrTabAndPNum" linkend="hrdc.crdia.mkr.4"> に、一般ヘルプ・ウィンドウのトピック・ツリーとトピック表示領域を示します。現在のトピック「パレットを選択するには」が表示されています。
</para>
<para>一般ヘルプ・ダイアログには、[前のトピックへ]、[ヒストリ]、[索引] の3つのダイアログ・ボタンがあります。これらのコマンドは、ヘルプ・メニューでも使用できます。ヘルプ・ダイアログとグラフィカル・ユーザ・インタフェースの概要については、
<!--Original XRef content: '&ldquo;Help User Interface&rdquo; on page&numsp;5'--><xref role="SecTitleAndPageNum" linkend="HRDC.Intro.mkr.7"> を参照してください。
</para>
<para><indexterm><primary>一般ヘルプ・ダイアログ・ボックス</primary><secondary>機能</secondary></indexterm><indexterm><primary>一般ヘルプ・ダイアログ・ボックス</primary><secondary>ダイアログ・ボタン</secondary></indexterm><indexterm><primary>ダイアログ・ボックス</primary><secondary>一般ヘルプ</secondary></indexterm></para>
<figure>
<title id="HRDC.CrDia.mkr.4">一般ヘルプ・ダイアログ</title>
<graphic id="HRDC.CrDia.grph.1" entityref="HRDC.CrDia.fig.1"></graphic>
</figure>
<sect2 id="HRDC.CrDia.div.5" role="Procedure">
<title id="HRDC.CrDia.mkr.5">一般ヘルプ・ダイアログを作成するには
<indexterm><primary>作成</primary><secondary>一般ヘルプ・ダイアログ・ボックス</secondary></indexterm><indexterm>
<primary>一般ヘルプ・ダイアログ・ボックス</primary><secondary>作成</secondary></indexterm><indexterm><primary>ダイアログ・ボックス</primary><secondary>一般ヘルプの作成</secondary></indexterm></title>
<orderedlist><listitem><para>適切なヘッダ・ファイルを指定します。
</para>
<programlisting>#include &lt;Help.h>
#include &lt;HelpDialog.h></programlisting>
</listitem><listitem><para>一般ヘルプ・ダイアログ・ウィジェットのインスタンスを作成します。
</para>
<para><function moreinfo="RefEntry">DtCreateHelpDialog()</function> 簡易関数を使用します。
</para>
<para><emphasis>または</emphasis> <function moreinfo="RefEntry">XtCreateManagedWidget()</function> 関数を使用します。
</para>
</listitem><listitem><para>ダイアログ内で発生するハイパーリンク・イベントを処理するためのコールバックを追加します。(詳細については、<xref role="SecTitleAndPageNum" linkend="HRDC.DiaEv.mkr.3"> を参照してください。)</para>
</listitem><listitem><para>[閉じる]コマンドを処理するための<emphasis>クローズ・コールバック</emphasis>を追加します。
</para>
</listitem></orderedlist>
<sect3 id="HRDC.CrDia.div.6">
<title>例</title>
<para>次のコード・セグメントは、簡易関数を使用して一般ヘルプ・ダイアログを(<symbol role="Variable">parent</symbol> の子として)作成します。ダイアログは管理されていません。ヘルプが要求された時点で、アプリケーションによって管理されます。
</para>
<programlisting>Widget mainHelpDialog, moreButton, helpButton;
ac = 0;
XtSetArg (al[ac], XmNtitle, "My Application - Help"); ac++;
XtSetArg (al[ac], DtNhelpVolume, "My Help Volume"); ac++;
XtSetArg (al[ac], DtNlocationId, "Getting Started"); ac++;
XtSetArg (al[ac], DtNhelpType, "DtHELP_TYPE_TOPIC"); ac++;
mainHelpDialog =
DtCreateHelpDialog (parent, "mainHelpDialog", al, ac);</programlisting>
<para>次の2つの呼び出しは、ダイアログにハイパーリンクとクローズ・コールバックを追加します。関数 <function>HyperlinkCB()</function> と <function>CloseHelpCB()</function> は、ここには示されていないアプリケーションの別の場所で宣言しています。
</para>
<programlisting>XtAddCallback (mainHelpDialog, DtNhyperLinkCallback,
HyperlinkCB, (XtPointer)NULL);
XtAddCallback (mainHelpDialog, DtNcloseCallback,
CloseHelpCB, (XtPointer)NULL);</programlisting>
</sect3>
<sect3 id="HRDC.CrDia.div.7">
<title>関連項目</title>
<itemizedlist><listitem><para><xref role="SecTitleAndPageNum" linkend="HRDC.H4Hlp.mkr.1"></para>
</listitem><listitem><para><xref role="SecTitleAndPageNum" linkend="HRDC.DiaEv.mkr.7">
</para>
</listitem><listitem><para><filename moreinfo="RefEntry">DtCreateHelpDialog</filename>(3) マニュアル・ページ</para>
</listitem><listitem><para><filename moreinfo="RefEntry">DtHelpDialog</filename>(3) マニュアル・ページ</para>
</listitem></itemizedlist>
</sect3>
</sect2>
</sect1>
<sect1 id="HRDC.CrDia.div.8">
<title id="HRDC.CrDia.mkr.6">簡易ヘルプ・ダイアログ</title>
<para><indexterm><primary>簡易ヘルプ・ダイアログ・ボックス</primary><secondary>ボタン</secondary></indexterm>
簡易ヘルプ・ダイアログ・ボックスは、オンライン・ヘルプの第一目標である<emphasis>ユーザができるだけ早く、また正常に作業に戻れること</emphasis>が実現できるように設計されています。このシンプルなユーザ・インタフェースによって、ユーザは情報に集中しつづけることができます。ダイアログの情報は、ユーザが読んだ後に消してしまっても作業が続けられるように、有用なものでなければなりません。
</para>
<figure>
<title>4つの標準ボタンを備えた簡易ヘルプ・ダイアログ</title>
<graphic id="HRDC.CrDia.grph.2" entityref="HRDC.CrDia.fig.2"></graphic>
</figure>
<para>簡易ヘルプ・ダイアログには5つのボタンがあり、そのうち4つが管理されています。残りのダイアログ・ボタンは構成可能なので、このボタンは希望に合わせて使用することができます。しかし、その目的としては、次の2つの方法のどちらかでヘルプへのパスを提供することです。
</para>
<itemizedlist><listitem><para>ユーザがより詳細な情報を探せるようにします。この場合、デフォルトのボタン・ラベル ([詳細]) が適切です。これは<emphasis>段階的な表示</emphasis>と呼ばれます。
</para>
</listitem><listitem><para>アプリケーションのヘルプ・ボリュームを通常どおりブラウズするために、一般ヘルプ・ダイアログを開けるようにします。この場合、<literal>[ブラウズ&hellip;]</literal> がもっとも適切なボタン・ラベルになります。
</para>
</listitem></itemizedlist>
<para>開発者用ツールキットには、簡易関数 <function>DtHelpQuickDialogGetChild()</function> が含まれています。この関数は、どの簡易ヘルプ・ダイアログ・ボタンにも対応するウィジェットIDを決定します。
</para>
<sect2 id="HRDC.CrDia.div.9" role="Procedure">
<title id="HRDC.CrDia.mkr.7">簡易ヘルプ・ダイアログを作成するには</title>
<orderedlist><listitem><para>適切なヘッダ・ファイルを指定します。</para>
<programlisting>#include &lt;Help.h>
#include &lt;HelpQuickD.h></programlisting>
</listitem><listitem><para>簡易ヘルプ・ダイアログ・ウィジェットのインスタンスを作成します。
</para>
<itemizedlist><listitem><para><function moreinfo="refentry">DtCreateHelpQuickDialog()</function> 簡易関数を使用します。</para>
</listitem><listitem><para><emphasis>または</emphasis> <function moreinfo="refentry">XtCreateManagedWidget()</function> 関数を使用します。</para>
</listitem></itemizedlist>
</listitem><listitem><para>ダイアログ内で発生するハイパーリンク・イベントを処理するためのコールバックを追加します(詳細については、<xref role="SecTitleAndPageNum" linkend="HRDC.DiaEv.mkr.3"> を参照してください)。</para>
</listitem><listitem><para>[了解] ボタンを処理するための<emphasis>クローズ・コールバック</emphasis>を追加します。
</para>
</listitem><listitem><para>使用したいダイアログ・ボタンを構成します。
</para>
<itemizedlist><listitem><para>アプリケーション定義のボタンを使用するには、それを管理して起動コールバックを追加します。
</para>
</listitem><listitem><para>印刷を許可しないようにするには、[印刷]ボタンの管理を解除します。
</para>
</listitem><listitem><para>ユーザが「ヘルプの使い方」を使用できるように、[ヘルプ]ボタンを管理し、ダイアログに<emphasis>ヘルプ・コールバック</emphasis>を追加します。
</para>
</listitem></itemizedlist>
</listitem></orderedlist>
<sect3 id="HRDC.CrDia.div.10">
<title>例</title>
<para>次のコード・セグメントは、簡易関数を使用して簡易ヘルプ・ダイアログを(<symbol>parent</symbol> の子として)作成します。ダイアログは管理されていません。ヘルプが要求された時点で、アプリケーションの別の場所で管理されます。この例では、アプリケーション定義のボタンが使用可能になっており、ヘルプをさらに要求するために使用しています。
</para>
<programlisting>Widget quickHelpDialog, moreButton, helpButton;
ac = 0;
XtSetArg (al[ac], XmNtitle, "My Application - Help"); ac++;
XtSetArg (al[ac], DtNhelpVolume, "My Help Volume"); ac++;
XtSetArg (al[ac], DtNlocationId, "Getting Started"); ac++;
XtSetArg (al[ac], DtNhelpType, "DtHELP;_TYPE_TOPIC"); ac++;
quickHelpDialog =
DtCreateHelpQuickDialog (<symbol>parent</symbol>, "quickHelpDialog", al, ac);
</programlisting>
<para>次の2つの呼び出しは、ダイアログにハイパーリンクとクローズ・コールバックを追加します。関数 <function>HyperlinkCB()</function> と <function>CloseHelpCB()</function> は、この例には示されていないアプリケーションの別の場所で宣言されています。
</para>
<programlisting>XtAddCallback (quickHelpDialog, DtNhyperLinkCallback,
HyperlinkCB, (XtPointer)NULL);
XtAddCallback (quickHelpDialog, DtNcloseCallback,
CloseHelpCB, (XtPointer)NULL);
</programlisting>
<para>ここで、アプリケーション定義のボタンが管理され、アプリケーションの <function>MoreHelpCB()</function> 関数を起動する起動コールバックが割り当てられます。
</para>
<programlisting>moreButton = DtHelpQuickDialogGetChild (quickHelpDialog,
DT_HELP_QUICK_MORE_BUTTON);
XtManageChild (moreButton);
XtAddCallback (moreButton, XmNactivateCallback,
MoreHelpCB, (XtPointer)NULL);
</programlisting>
<para>「ヘルプの使い方」を提供するために、ダイアログの[ヘルプ]ボタンが管理され、ダイアログにヘルプ・コールバックが追加されます。
</para>
<programlisting>helpButton = DtHelpQuickDialogGetChild (quickHelpDialog,
DT_HELP_QUICK_HELP_BUTTON);
XtManageChild (helpButton);
XtAddCallback (quickHelpDialog,DtNhelpCallback,
HelpRequestCB, USING_HELP);
</programlisting>
<para>他の Motif ダイアログと同じように、簡易ヘルプ・ダイアログにヘルプ・コールバックを追加すると、[F1]キーと[ヘルプ]ボタンのどちらからでも簡易ヘルプ・ダイアログを使用することができます。
</para>
</sect3>
<sect3 id="HRDC.CrDia.div.11">
<title>関連項目</title>
<itemizedlist><listitem><para><xref role="SecTitleAndPageNum" linkend="HRDC.DiaEv.mkr.7"></para>
</listitem><listitem><para><xref role="ChapNumAndTitle" linkend="HRDC.H4Hlp.mkr.1"></para>
</listitem><listitem><para><filename moreinfo="RefEntry">DtCreateHelpQuickDialog</filename>(3) マニュアル・ページ</para>
</listitem><listitem><para><filename moreinfo="RefEntry">DtHelpQuickDialog</filename>(3) マニュアル・ページ</para>
</listitem><listitem><para><filename moreinfo="RefEntry">DtHelpQuickDialogGetChild</filename>(3) マニュアル・ページ</para>
</listitem></itemizedlist>
</sect3>
</sect2>
</sect1>
<sect1 id="HRDC.CrDia.div.12">
<title id="HRDC.CrDia.mkr.8">アプリケーション・プログラム・インタフェースの要約</title>
<para>ヘルプ・システムに関連するマニュアル・ページは次のとおりです。</para>
<itemizedlist><listitem><para>ダイアログの作成と操作のための関数
</para>
<itemizedlist><listitem><para><filename>DtHelp(5)</filename></para>
</listitem><listitem><para><filename>DtHelpDialog(5)</filename></para>
</listitem><listitem><para><filename>DtHelpQuickD(5)</filename></para>
</listitem><listitem><para><function>DtCreateHelpDialog()</function></para>
</listitem><listitem><para><function>DtCreateHelpQUickDialog()</function></para>
</listitem><listitem><para><function>DtHelpQuickDialogGetChild()</function></para>
</listitem></itemizedlist>
</listitem><listitem><para>項目ヘルプ・モードの実現のための関数</para>
<itemizedlist><listitem><para><function>DtHelpReturnSelectedWidgetId()</function></para>
</listitem></itemizedlist>
</listitem><listitem><para>ヘルプ・ライブラリにメッセージ・カタログを指定するための関数
</para>
<itemizedlist><listitem><para><function>DtHelpSetCatalogName()</function></para>
</listitem></itemizedlist>
</listitem><listitem><para>ヘルプ・ボリュームの作成および表示のためのアプリケーションとアクション
</para>
<itemizedlist><listitem><para><filename>dtdocbook</filename>(1)</para>
</listitem><listitem><para><filename>dthelpview</filename>(1)</para>
</listitem><listitem><para><filename>dthelpgen</filename>(1)</para>
</listitem><listitem><para><filename>dthelpaction(5)</filename></para>
</listitem><listitem><para><filename>dtmanaction(5)</filename></para>
</listitem></itemizedlist>
</listitem><listitem><para>文書型定義</para>
<itemizedlist><listitem><para><filename>dtdocbookdtd(4)</filename></para>
</listitem><listitem><para><filename>dtsdldtd(4)</filename></para>
</listitem></itemizedlist>
</listitem></itemizedlist>
</sect1>
</chapter>
<!--fickle 1.14 mif-to-docbook 1.7 01/02/96 16:48:20-->

View File

@@ -0,0 +1,518 @@
<!-- $XConsortium: ch09.sgm /main/10 1996/09/08 19:40:34 rws $ -->
<!-- (c) Copyright 1995 Digital Equipment Corporation. -->
<!-- (c) Copyright 1995 Hewlett-Packard Company. -->
<!-- (c) Copyright 1995 International Business Machines Corp. -->
<!-- (c) Copyright 1995 Sun Microsystems, Inc. -->
<!-- (c) Copyright 1995 Novell, Inc. -->
<!-- (c) Copyright 1995 FUJITSU LIMITED. -->
<!-- (c) Copyright 1995 Hitachi. -->
<chapter id="HRDC.HReq.div.1">
<title id="HRDC.HReq.mkr.1">ヘルプ要求への応答</title>
<para>この章では、ヘルプ・ダイアログ・ウィジェットのリソースの設定によって、さまざまなヘルプ情報を表示する方法を説明します。
</para>
<informaltable id="HRDC.HReq.itbl.1" frame="All">
<tgroup cols="1">
<colspec colname="1" colwidth="4.0 in">
<tbody>
<row rowsep="1">
<entry><para><!--Original XRef content: 'Requesting Help215'--><xref role="JumpText"
linkend="HRDC.HReq.mkr.2"></para></entry></row>
<row rowsep="1">
<entry><para><!--Original XRef content: 'Displaying Help Topics216'--><xref
role="JumpText" linkend="HRDC.HReq.mkr.3"></para></entry></row>
<row rowsep="1">
<entry><para><!--Original XRef content: 'To Display a Help Topic217'--><xref
role="JumpText" linkend="HRDC.HReq.mkr.5"></para></entry></row>
<row rowsep="1">
<entry><para><!--Original XRef content: 'To Display a String of Text218'--><xref
role="JumpText" linkend="HRDC.HReq.mkr.6"></para></entry></row>
<row rowsep="1">
<entry><para><!--Original XRef content: 'To Display a Text File219'--><xref
role="JumpText" linkend="HRDC.HReq.mkr.7"></para></entry></row>
<row rowsep="1">
<entry><para><!--Original XRef content: 'To Display a Man Page220'--><xref
role="JumpText" linkend="HRDC.HReq.mkr.8"></para></entry></row>
<row rowsep="1">
<entry><para><!--Original XRef content: 'Enabling the Help Key (F1)220'--><xref
role="JumpText" linkend="HRDC.HReq.mkr.9"></para></entry></row>
<row rowsep="1">
<entry><para><!--Original XRef content: 'Providing a Help Menu224'--><xref
role="JumpText" linkend="HRDC.HReq.mkr.11"></para></entry></row>
<row rowsep="1">
<entry><para><!--Original XRef content: 'Supporting Item Help Mode225'--><xref
role="JumpText" linkend="HRDC.HReq.mkr.12"></para></entry></row></tbody></tgroup>
</informaltable>
<sect1 id="HRDC.HReq.div.2">
<title id="HRDC.HReq.mkr.2">ヘルプの要求</title>
<indexterm><primary>~への応答</primary><secondary>ヘルプ要求</secondary></indexterm><indexterm><primary>要求、ヘルプへの応答</primary></indexterm>
<para>アプリケーションの使用中にユーザがヘルプを要求したときは、どのヘルプ・トピックを表示すべきか、アプリケーション側で決定します。
</para>
<sect2 id="HRDC.HReq.div.3">
<title>コンテキストの検知</title>
<para>「バージョン」のヘルプ(通常は著作権のトピックが表示されます)など、特定の情報を明示的に要求するヘルプ要求もあります。しかし、それ以外のヘルプ要求では、コンテキストの検知を必要とします。つまり、アプリケーションにおけるユーザの現在のコンテキストに基づいて、適切なヘルプ・トピックを選択する処理が必要となります。
</para>
<para>たとえば、アプリケーションは、適切なヘルプ・トピックを判断するため、モードや設定のステータスをテストすることがあります。あるいは、入力フィールドの値をテストし、その値が有効でなければ詳細ヘルプを、有効であれば一般ヘルプを表示することもあります。
</para>
</sect2>
<sect2 id="HRDC.HReq.div.4">
<title>エントリ・ポイント</title>
<para><emphasis>エントリ・ポイント</emphasis> とは、ヘルプ・ボリューム内の特定の場所のことで、通常はトピックの先頭です。アプリケーション内でヘルプを要求すると、エントリ・ポイントに直接アクセスできます。
</para>
<para>設計者の観点から言えば、エントリ・ポイントはヘルプ・ボリュームの適切な場所にIDを指定することによって設定されます。プログラマの観点から言えば、ユーザがヘルプを要求できるようにし、特定のヘルプが要求されたときに適切なIDを使用することでエントリ・ポイントが作成されます。
</para>
<para>ユーザがヘルプを要求する方法には、次の4種類があります。
</para>
<itemizedlist remap="Bullet1"><listitem><para><emphasis>[ヘルプ]キー</emphasis>(ほとんどのキーボードでは[F1]キー)を押す
</para>
</listitem><listitem><para>ダイアログ・ボックスの[ヘルプ]ボタンをクリックする
</para>
</listitem><listitem><para>アプリケーションの[ヘルプ]メニューからコマンドを選択する
</para>
</listitem><listitem><para>[アイテムヘルプ]を選択する
</para>
</listitem></itemizedlist>
</sect2>
</sect1>
<sect1 id="HRDC.HReq.div.5">
<title id="HRDC.HReq.mkr.3">ヘルプ・トピックの表示</title>
<para>ヘルプが要求されると、アプリケーションが表示するヘルプ・トピックを決定します。次に、ヘルプ・ダイアログを(必要ならば)作成し、管理して、ヘルプ・トピックを表示するための適切なリソースを設定します。
</para>
<para>ほとんどの要求については、アプリケーションのヘルプ・ボリュームの一部であるヘルプ・トピックが表示されます。しかし、ヘルプ・システムのヘルプ・ダイアログは、マニュアル・ページ、テキスト・ファイル、単純なテキスト文字列を表示することもできます。
</para>
<para id="HRDC.HReq.mkr.4">ヘルプ・システムのダイアログは、Xt イントリンシクスと Motif プログラミングに排他的に基づいているので、他のウィジェットと同じように、リソースを設定することによって、ヘルプ・ダイアログ内の値を変更できます。
</para>
<para><systemitem class="resource">DtNhelpType</systemitem> リソースは、表示すべき情報の種類を決定します。次のいずれかの値が設定されます。
</para>
<itemizedlist remap="Bullet1"><listitem><para><systemitem class="constant">DtHELP_TYPE_TOPIC</systemitem> ヘルプ・ボリュームの一部である通常のヘルプ・トピックを表示します。ボリュームは <systemitem class="resource">DtNhelpVolume</systemitem> リソースを設定して指定します。トピックは <systemitem class="resource">DtNLocationId</systemitem> リソースを設定して指定します。
</para>
</listitem><listitem><para><systemitem class="constant">DtHELP_TYPE_STRING</systemitem> アプリケーションが提供する文字列を表示します。自動的な行の折り返しは使用できないため、改行は文字列で指定してください。文字列は <systemitem class="resource">DtNstringData</systemitem> リソースを設定して指定します。
</para>
</listitem><listitem><para><systemitem class="constant">DtHELP_TYPE_DYNAMIC_STRING</systemitem> アプリケーションが提供する文字列を、行の折り返しでテキストをフォーマットした状態で表示します。改行は段落の区切りを示します。文字列は <systemitem class="resource">DtNstringData</systemitem> リソースを設定して指定します。
</para>
</listitem><listitem><para><systemitem class="constant">DtHELP_TYPE_FILE</systemitem> テキスト・ファイルを表示します。表示するファイルの名前は <systemitem class="resource">DtNhelpFile</systemitem> リソースを設定して指定します。
</para>
</listitem><listitem><para><systemitem class="constant">DtHELP_TYPE_MAN_PAGE</systemitem> ヘルプ・ダイアログのマニュアル参照ページ(マニュアル・ページ)を表示します。表示するマニュアル・ページは <systemitem class="resource">DtNmanPage</systemitem> リソースを設定して指定します。
</para>
</listitem></itemizedlist>
<para>上記の値は、<filename>Help.h</filename> ファイルで定義されています。
</para>
<sect2 id="HRDC.HReq.div.6">
<title>関連項目</title>
<itemizedlist remap="Bullet1"><listitem><para><xref role="SecTitleAndPageNum" linkend="HRDC.CrDia.mkr.1"></para>
</listitem></itemizedlist>
</sect2>
<sect2 id="HRDC.HReq.div.7" role="Procedure">
<title id="HRDC.HReq.mkr.5">ヘルプ・トピックを表示するには</title>
<orderedlist><listitem><para>ヘルプ・ダイアログを作成します。</para>
</listitem><listitem><para>次のようなヘルプ・ダイアログのリソースを設定します。
</para>
<informaltable>
<tgroup cols="2" colsep="0" rowsep="0">
<colspec align="left" colwidth="164*">
<colspec align="left" colwidth="364*">
<tbody>
<row>
<entry align="left" valign="top"><para><systemitem class="resource">DtNhelpType</systemitem></para></entry>
<entry align="left" valign="top"><para><systemitem class="constant">DtHELP_TYPE_TOPIC</systemitem> を設定します。</para></entry></row>
<row>
<entry align="left" valign="top"><para><systemitem class="resource">DtNhelpVolume</systemitem></para></entry>
<entry align="left" valign="top"><para>アプリケーションのボリューム名を設定します。
</para></entry></row>
<row>
<entry align="left" valign="top"><para><systemitem class="resource">DtNlocationId</systemitem></para></entry>
<entry align="left" valign="top"><para>表示するトピックのIDを設定します。
</para></entry></row></tbody></tgroup></informaltable>
<para>サイズやタイトルなど、その他の値も設定できます。
</para>
</listitem><listitem><para><function>XtManageChild()</function> を使用してダイアログを管理します。</para>
</listitem></orderedlist>
<sect3 id="HRDC.HReq.div.8">
<title>例</title>
<para>次のプログラム・セグメントは、IDである <symbol>getting-started</symbol> が付いたトピックを、ボリューム <filename>MyVolume</filename> に表示します。
</para>
<programlisting>ac = 0;
XtSetArg (al[ac], DtNhelpType, DtHELP_TYPE_TOPIC); ac++;
XtSetArg (al[ac], DtNhelpVolume, &ldquo;MyVolume&rdquo;); ac++;
XtSetArg (al[ac], DtNlocationId, &ldquo;getting-started&rdquo;); ac++;
XtSetArg (al[ac], DtNcolumns, 40); ac++;
XtSetArg (al[ac], DtNrows, 12); ac++;
XtSetValues (helpDialog, al, ac);
XtManageChild (helpDialog);</programlisting>
<para>ヘルプ・ボリューム <filename>MyVolume</filename> が未登録の場合、<systemitem class="resource">DtNhelpVolume</systemitem> の値を指定するために、<filename>MyVolume.sdl</filename> ファイルへの絶対パスが必要です。
</para>
</sect3>
</sect2>
<sect2 id="HRDC.HReq.div.9" role="Procedure">
<title id="HRDC.HReq.mkr.6">テキスト文字列を表示するには</title>
<orderedlist><listitem><para>簡易ヘルプ・ダイアログを作成します。
</para>
<para>一般ヘルプ・ダイアログでも使用できますが、このダイアログの機能は文字列データには、ほとんど適用されないので、使用しないようにしてください。
</para>
</listitem><listitem><para>次のようなヘルプ・ダイアログのリソースを設定します。
</para>
<informaltable>
<tgroup cols="2" colsep="0" rowsep="0">
<colspec align="left" colwidth="177*">
<colspec align="left" colwidth="351*">
<tbody>
<row>
<entry align="left" valign="top"><para><systemitem class="resource">DtNhelpType</systemitem></para></entry>
<entry align="left" valign="top"><para><systemitem class="constant">DtHELP_TYPE_DYNAMIC_STRING</systemitem>(行の折り返しを使用する場合)または <systemitem class="constant">DtHELP_TYPE_STRING</systemitem>(改行を有効にしたい場合)を設定します。
</para></entry></row>
<row>
<entry align="left" valign="top"><para><systemitem class="resource">DtNstringData</systemitem></para></entry>
<entry align="left" valign="top"><para>表示する文字列を設定します。文字列のコピーは、内部的に保持されるので、保存する必要はありません。
</para></entry></row></tbody></tgroup></informaltable>
<para>サイズやタイトルなど、その他の値も設定できます。
</para>
</listitem><listitem><para><function>XtManageChild()</function> を使用してダイアログを管理します。
</para>
</listitem></orderedlist>
<sect3 id="HRDC.HReq.div.10">
<title>例</title>
<para>次のプログラム・セグメントは、変数 <symbol role="Variable">descriptionString</symbol> に格納された文字列を表示します。
</para>
<programlisting>ac = 0;
XtSetArg (al[ac], DtNhelpType, DtHELP_TYPE_DYNAMIC_STRING); ac++;
XtSetArg (al[ac], DtNstringData, (char *)descriptionString); ac++;
XtSetValues (quickHelpDialog, al, ac);
XtManageChild (quickHelpDialog);</programlisting>
<para>ヘルプ・ダイアログは、データのコピーを作成するため、文字列が不要になった場合はメモリを解放できます。
</para>
<programlisting>XtFree (descriptionString);</programlisting>
</sect3>
</sect2>
<sect2 id="HRDC.HReq.div.11" role="Procedure">
<title id="HRDC.HReq.mkr.7">テキスト・ファイルを表示するには</title>
<orderedlist><listitem><para>簡易ヘルプ・ダイアログを作成するか、ダイアログ・キャッシュのひとつを取り出します。
</para>
<para>一般ヘルプ・ダイアログも使用できますが、このダイアログ機能のほとんどが標準ヘルプ・トピックについてのみ有効なので、使用しないようにしてください。
</para>
</listitem><listitem><para>次のようなヘルプ・ダイアログのリソースを設定します。
</para>
<informaltable>
<tgroup cols="2" colsep="0" rowsep="0">
<colspec align="left" colwidth="159*">
<colspec align="left" colwidth="369*">
<tbody>
<row>
<entry align="left" valign="top"><para><systemitem class="prompt">DtNhelpType</systemitem></para></entry>
<entry align="left" valign="top"><para><systemitem class="constant">DtHELP_TYPE_FILE</systemitem> を設定します。</para></entry></row>
<row>
<entry align="left" valign="top"><para><systemitem class="prompt">DtNhelpFile</systemitem></para></entry>
<entry align="left" valign="top"><para>表示するファイル名を設定します。アプリケーションの現在のディレクトリにファイルがない場合は、ファイルへのパスを指定してください。
</para></entry></row></tbody></tgroup></informaltable>
<para>サイズやタイトルなど、その他の値も設定できます。特に、幅についてはテキスト・ファイルの標準である80に設定したいときがあるでしょう。
</para>
</listitem><listitem><para><function>XtManageChild()</function> を使用してダイアログを管理します。
</para>
</listitem></orderedlist>
<sect3 id="HRDC.HReq.div.12">
<title>例</title>
<para>次のプログラム・セグメントは、ファイル <filename>/tmp/printer.list</filename> を表示します。ダイアログのサイズもテキスト・ファイルにより適応するようにします。
</para>
<programlisting>ac = 0;
XtSetArg (al[ac], DtNhelpType, DtHELP_TYPE_FILE); ac++;
XtSetArg (al[ac], DtNhelpFile, &ldquo;/tmp/printer.list&rdquo;); ac++;
XtSetArg (al[ac], DtNcolumns, 80); ac++;
XtSetArg (al[ac], DtNrows, 20); ac++;
XtSetValues (quickHelpDialog, al, ac);
XtManageChild (quickHelpDialog);</programlisting>
</sect3>
</sect2>
<sect2 id="HRDC.HReq.div.13" role="Procedure">
<title id="HRDC.HReq.mkr.8">マニュアル・ページを表示するには</title>
<indexterm><primary>表示</primary><secondary>マニュアル・ページ</secondary></indexterm>
<indexterm><primary>マニュアル・ページ</primary><secondary>表示</secondary></indexterm>
<indexterm><primary>&lt;Filename | Command>DtHELP_TYPE_MAN_PAGE &lt;Default Para Font></primary></indexterm>
<orderedlist><listitem><para>簡易ヘルプ・ダイアログを作成します。
</para>
<para>一般ヘルプ・ダイアログも使用できますが、このダイアログ機能のほとんどが
、標準ヘルプ・トピックについてのみ有効なので、使用しないようにしてください。
</para>
</listitem><listitem><para>次のようなヘルプ・ダイアログのリソースを設定します。
</para>
<informaltable>
<tgroup cols="2" colsep="0" rowsep="0">
<colspec align="left" colwidth="159*">
<colspec align="left" colwidth="369*">
<tbody>
<row>
<entry align="left" valign="top"><para><systemitem class="resource">DtNhelpType</systemitem></para></entry>
<entry align="left" valign="top"><para><systemitem class="constant">DtHELP_TYPE_MAN_PAGE</systemitem> を設定します。</para></entry></row>
<row>
<entry align="left" valign="top"><para><systemitem class="resource">DtNmanPage</systemitem></para></entry>
<entry align="left" valign="top"><para>マニュアル・ページの名前を設定します。このリソースの値は、システムの <command>man</command> コマンドへ直接渡されます。したがって、特定のセクションを指定するときは、通常の <command>man</command> コマンドを入力するときのように、セクション番号の前に、マニュアル・ページ名を付けてください。
</para></entry></row></tbody></tgroup>
</informaltable>
<para>サイズやタイトルなど、その他の値も設定できます。
</para>
</listitem><listitem><para><function>XtManageChild()</function> を使用してダイアログを管理します。
</para>
</listitem></orderedlist>
<sect3 id="HRDC.HReq.div.14">
<title>例</title>
<para>次のプログラム・セグメントは、<command>grep</command> コマンドのマニュアル・ページを表示します。ダイアログのサイズもマニュアル・ページに適応するように設定します。
</para>
<programlisting>ac = 0;
XtSetArg (al[ac], DtNhelpType, DtHELP_TYPE_MAN_PAGE); ac++;
XtSetArg (al[ac], DtNmanPage, &ldquo;grep&rdquo;); ac++;
XtSetArg (al[ac], DtNcolumns, 80); ac++;
XtSetArg (al[ac], DtNrows, 20); ac++;
XtSetValues (quickHelpDialog, al, ac);
XtManageChild (quickHelpDialog);</programlisting>
</sect3>
</sect2>
</sect1>
<sect1 id="HRDC.HReq.div.15">
<title id="HRDC.HReq.mkr.9">ヘルプ・キー([F1]キー)を使用可能にする</title>
<indexterm><primary>F1 (ヘルプ・キー)</primary></indexterm><indexterm><primary>キー、ヘルプ([F1]キー)を使用可能にする</primary></indexterm><indexterm><primary>ヘルプ・キー</primary></indexterm>
<para><emphasis>ヘルプ・キー</emphasis> 機能は、すべての Motif マネージャ・ウィジェットとプリミティブ・ウィジェットに組み込まれています。ヘルプ・キーをアクティブにしたいウィジェットに<emphasis>ヘルプ・コールバック</emphasis>を追加すると、ヘルプ・キーが使用可能になります。
</para>
<para>アプリケーション内では、ヘルプに固有のエントリ・ポイントが必要なウィジェットすべてに、それぞれヘルプ・コールバックを追加してください。そのコールバックを呼び出すまで、ヘルプ・コールバック機能は自動的にウィジェット階層を(シェル・ウィジェットまで)上がります。
</para>
<para>ヘルプ・コールバックをマネージャ・ウィジェットに追加する場合、ヘルプ・キーを任意の子ウィジェットのために押すと(子ウィジェットに独自のヘルプ・コールバックがなければ)マネージャのヘルプ・コールバックが呼び出されます。
</para>
<sect2 id="HRDC.HReq.div.16" role="Procedure">
<title id="HRDC.HReq.mkr.10">ヘルプ・コールバックを追加するには</title>
<para><function>XtAddCallback()</function> 関数を次のように使用します。</para>
<programlisting>XtAddCallback (
Widget widget,
String DtNhelpCallback,
XtCallbackProc HelpRequestCB,
XtPointer clientData );
</programlisting>
<para>引き数の説明を以下に示します。</para>
<informaltable>
<tgroup cols="2" colsep="0" rowsep="0">
<colspec align="left" colwidth="170*">
<colspec align="left" colwidth="358*">
<tbody>
<row>
<entry align="left" valign="top"><para><symbol role="Variable">widget</symbol></para></entry>
<entry align="left" valign="top"><para>ヘルプ・キーをアクティブにする場所のウィジェットです。
</para></entry></row>
<row>
<entry align="left" valign="top"><para><function role="Variable">HelpRequestCB()</function></para></entry>
<entry align="left" valign="top"><para>ユーザがヘルプ・キーを押したときにヘルプ要求を処理するアプリケーションの関数です。
</para></entry>
</row>
<row>
<entry align="left" valign="top"><para><symbol role="Variable">clientData</symbol></para></entry>
<entry align="left" valign="top"><para><function>HelpRequestCB()</function> 関数に渡すデータです。通常は、表示するトピックを示します。
</para></entry></row></tbody></tgroup></informaltable>
<para>ユーザがヘルプ・キーを押すと、ウィジェットのヘルプ・コールバックが現在のキーボード・フォーカスとともに呼び出されます。ウィジェットにヘルプ・コールバックがない場合、ヘルプ・コールバックをもつもっとも近い祖先のコールバックが呼び出されます。
</para>
<para>ヘルプ・コールバックがみつからない場合は、何も処理されません。この場合、ヘルプ・コールバックをアプリケーションの各シェルに追加するようにしてください。このようにすれば、ユーザのヘルプ要求が失われることがありません。
</para>
<para>ヘルプ・コールバックをダイアログ・シェルに追加すると、自動的にダイアログの[ヘルプ]ボタンでヘルプ・コールバックを呼び出せるようになります。
</para>
</sect2>
<sect2 id="HRDC.HReq.div.17">
<title>クライアント・データの重要性</title>
<para>追加したそれぞれのヘルプ・コールバックで <symbol role="Variable">clientData</symbol> に固有の値を指定すると、各ヘルプ・コールバックを処理するために、別々の関数を書かずに済みます。アプリケーションには、すべてのヘルプ要求を処理するひとつのコールバック手続きをもたせることができます。(<xref role="SecTitleAndPageNum" linkend="HRDC.HReq.mkr.10"> を参照してください。)コールバック手続きでは、ユーザが要求したヘルプを識別するのに <symbol role="Variable">clientData</symbol> を使用します。つまり、ヘルプ・コールバックを追加するごとに、<symbol role="Variable">clientData</symbol> に固有の値を設定してください。</para>
<sect3 id="HRDC.HReq.div.18">
<title>例</title>
<para>次の例は、ID をエントリ・ポイントに指定する方法のひとつを示しています。<filename>HelpEntryIds.h</filename> ファイルは、各ヘルプ・コールバックの <symbol role="Variable">clientData</symbol> に固有の整数を定義するために使用します。各ウィジェットに対する2つの ID 文字列も定義されます。ひとつは通常の[F1]キーのヘルプ用、もうひとつはアイテムヘルプ・モード(ユーザがウィジェットから記述を取得する場所)用です。
</para>
<para>この例では、アプリケーションのユーザ・インタフェースが、Name、Address、および Telephone Number という3つの入力フィールドをもつメイン・ウィンドウであると仮定しています。
次の例は、<filename>HelpEntryIds.h</filename> ファイルの内容です。
</para>
<programlisting>#define HELP_volumeName "MyVolume"
#define HELP_MainWindow 100
#define HELP_MainWindow_ID "basic-tasks"
#define HELP_MainWindow_ITEM_ID "main-window-desc"
#define HELP_NameField 101
#define HELP_NameField_ID "specifying-a-name"
#define HELP_NameField_ITEM_ID "name-field-desc"
#define HELP_AddressField 102
#define HELP_AddressField_ID "specifying-an-address"
#define HELP_AddressField_ITEM_ID "address-field-desc"
#define HELP_PhoneField 103
#define HELP_PhoneField_ID "specifying-a-phone-no"
#define HELP_PhoneField_ITEM_ID "phone-field-desc"</programlisting>
<para>最初にウィジェットを作成したアプリケーションの一部で、次のようにヘルプ・コールバックが各ウィジェットに追加されます。
</para>
<programlisting>XtAddCallback (mainWindow, DtNhelpCallback,
HelpRequestCB, HELP_MainWindow);
XtAddCallback (nameField, DtNhelpCallback,
HelpRequestCB, HELP_NameField);
XtAddCallback (addressField, DtNhelpCallback,
HelpRequestCB, HELP_AddressField);
XtAddCallback (phoneField, DtNhelpCallback,
HelpRequestCB, HELP_PhoneField);</programlisting>
<para><function>HelpRequestCB()</function> 関数では、ヘルプ要求を(<command>switch()</command> 文によって)ディスパッチするために、<symbol role="Variable">clientData</symbol> パラメータを使用します。ヘルプ・コールバックが[F1]キーによって呼び出された(フラグは &ldquo;false&rdquo;)のか、アイテム・ヘルプ・モードでユーザがウィジェットを選択した(フラグは &ldquo;true&rdquo;)のかを調べるため、グローバル・フラグ <systemitem class="environvar">itemHelp</systemitem> の値が調べられます。
</para>
<programlisting>XtCallbackProc HelpRequestCB (
Widget w,
XtPointer clientData,
XtPointer callData)
{
char *topicToDisplay;
Boolean useQuickHelpDialog;
/* <emphasis>Determine the topic ID for the given `clientData.'</emphasis> */
switch ((int)clientData)
{
case HELP_MainWindow:
useQuickHelpDialog = False;
if (itemHelpFlag)
topicToDisplay = HELP_MainWindow_ITEM_ID;
else
topicToDisplay = HELP_MainWindow_ID;
break; case HELP_NameField:
useQuickHelpDialog = True;
if (itemHelpFlag)
topicToDisplay = HELP_NameField_ITEM_ID;
else
topicToDisplay = HELP_NameField_ID;
break; case HELP_AddressField:
useQuickHelpDialog = True;
if (itemHelpFlag)
topicToDisplay = HELP_AddressField_ITEM_ID;
else
topicToDisplay = HELP_AddressField_ID;
break; case HELP_PhoneField:
useQuickHelpDialog = True;
if (itemHelpFlag)
topicToDisplay = HELP_PhoneField_ITEM_ID;
else
topicToDisplay = HELP_PhoneField_ID;
break; default:
/* <emphasis>An unknown clientData was received.</emphasis> */
/* <emphasis>Put your error handling code here.</emphasis> */
return;
break;
}
/* <emphasis>Display the topic.</emphasis> */
ac = 0;
XtSetArg (al[ac], DtNhelpType, DtHELP_TYPE_TOPIC); ac++;
XtSetArg (al[ac], DtNhelpVolume, HELP_volumeName); ac++;
XtSetArg (al[ac], DtNhelpType, topicToDisplay); ac++;
if (useQuickHelpDialog)
{
XtSetValues (mainQuickHelpDialog, al, ac);
XtManageChild (mainQuickHelpDialog);
}
else
{
XtSetValues (mainHelpDialog, al, ac);
XtManageChild (mainHelpDialog);
}
/* <emphasis>Clear the `item help' flag.</emphasis> */
itemHelpFlag = False;
}
</programlisting>
<para>上記の関数は、アプリケーションがすべてのヘルプ要求に対して2つのヘルプ・ダイアログ(<command>mainHelpDialog</command> と <command>mainQuickHelpDialog</command>を使用し、これらのダイアログがすでに作成されていると想定します。またXt 引き数リストで使用される)<command>al</command> と <command>ac</command> が別の場所で宣言されていることを仮定しています。
</para>
</sect3>
</sect2>
</sect1>
<sect1 id="HRDC.HReq.div.19">
<title id="HRDC.HReq.mkr.11">ヘルプ・メニューの提供<indexterm><primary>ヘルプ・メニュー、提供</primary></indexterm><indexterm><primary>メニュー</primary><secondary>ヘルプ・メニューの提供</secondary></indexterm></title>
<para><citetitle>CDE/Motif スタイルガイドおよび認証チェックリスト</citetitle> では、各メニュー・バーに[ヘルプ]メニューを含むようにすすめています。[ヘルプ]メニューには、ユーザがアプリケーションでさまざまなオンライン・ヘルプにアクセスできるように、多くのコマンドが用意されています。
</para>
<para>もっとも重要なコマンドは次のとおりです。
</para>
<itemizedlist><listitem><para><command>Introduction (概要)</command> アプリケーションのヘルプのホーム・トピックを表示し、ユーザがハイパーリンクを使用して、必要な任意の情報へナビゲートできるようにします。
</para>
</listitem><listitem><para><command>Using Help (ヘルプの使い方)</command> 「ヘルプの使い方」を表示します。ユーザにヘルプ・システムの使い方を示す情報です。
</para>
</listitem><listitem><para><command>Version (バージョン)</command> アプリケーションのバージョン情報と著作権情報を表示します。
</para>
</listitem></itemizedlist>
<para>その他、特殊キーボードの使い方、アプリケーションの使い方、リファレンス、チュートリアルのそれぞれに関するヘルプを表示するコマンドがあります。<citetitle>CDE/Motif スタイルガイドおよび認証チェックリスト</citetitle> のガイドラインや推奨事項の範囲で、使用する[ヘルプ]メニューが、アプリケーションに適応するように設計してください。</para>
<sect2 id="HRDC.HReq.div.20">
<title>関連項目</title>
<itemizedlist remap="Bullet1"><listitem><para><xref role="SecTitleAndPageNum"
linkend="HRDC.OrgH.mkr.13"> では、設計者がヘルプ・ボリュームのホーム・トピックを作成する方法を説明しています。
</para>
</listitem><listitem><para><xref role="SecTitleAndPageNum" linkend="HRDC.OrgH.mkr.16"> では、設計者が著作権トピックを作成する方法を説明しています。
</para>
</listitem><listitem><para><xref role="ChapNumAndTitle" linkend="HRDC.H4Hlp.mkr.1"> では、ヘルプの使い方をみつける方法と、それをアプリケーションに追加する方法を説明しています。
</para>
</listitem></itemizedlist>
</sect2>
</sect1>
<sect1 id="HRDC.HReq.div.21">
<title id="HRDC.HReq.mkr.12">アイテムヘルプ・モードのサポート</title>
<para>一部のアプリケーションは、[ヘルプ]メニューに[アイテムヘルプ]コマンドまたは[ヘルプ・モード]コマンドを備えています。このコマンドは、マウス・ポインタを一時的に <literal>?</literal>(疑問符)の形状に再定義し、ユーザに画面の項目を選択するようにプロンプト要求します。項目を選択すると、その項目の説明をアプリケーションが表示します。
</para>
<para>便利な関数に <function>DtHelpReturnSelectedWidgetId()</function> がありますが、これはポインタを疑問符に変更して、ユーザがウィジェットを選択するのを待ちます。選択したウィジェットのIDが返されます。この関数は <function>XmTrackingLocate()</function> に類似していますが、ユーザがエスケープ・キーを押して操作を取り消すと <function>DtHelpReturnSelectedWidgetId()</function> は NULL を返す点が異なります。
</para>
<para>選択した項目のヘルプを表示するには、単に返されたウィジェットのヘルプ・コールバックを呼び出すだけです。これは、ウィジェットの使用中に、ユーザが<KeyCap>[F1]</KeyCap>キーを押すのと同じことです。
</para>
<para>アイテムヘルプと[F1]ヘルプとを区別させる場合は、ウィジェットのヘルプ・コールバックを呼び出す前にフラグを設定します。こうすると、アイテムヘルプの結果として呼び出すコールバックを判別するときにそのフラグを使用し、それにしたがって応答するようになります。
</para>
<sect2 id="HRDC.HReq.div.22" role="Procedure">
<title id="HRDC.HReq.mkr.13">アイテムヘルプのサポートを追加するには</title>
<orderedlist><listitem><para><function>DtHelpReturnSelectedWidgetId()</function> 関数を使用して関数を記述します。この関数では、選択したウィジェットのヘルプ・コールバックを呼び出します。次のステップでは、この関数を <function>ProcessOnItemHelp()</function> と呼びますが、他の名前を付けることもできます。
</para>
</listitem><listitem><para>[ヘルプ]メニューに<command>アイテムヘルプ</command>というラベルの付いたコマンドを追加します。<function>ProcessOnItemHelp()</function> 関数を呼び出す起動コールバックを追加します。
</para>
</listitem><listitem><para>アイテムヘルプを使用するアプリケーションの各ウィジェットに、ヘルプ・コールバックを追加します。
</para>
</listitem></orderedlist>
<para>選択したウィジェットにヘルプ・コールバックがない場合、アプリケーションはその親ウィジェットの検索を試みます。同様に、親ウィジェットにない場合は、その上の階層を検索し、ヘルプ・コールバックがみつかるまで試行を繰り返します。
</para>
<sect3 id="HRDC.HReq.div.23">
<title>例</title>
<para>次の手続きは、<function>ProcessOnItemHelp()</function> 関数の例ですが、これは[ヘルプ]メニューから <command>[アイテムヘルプ]</command> を選択すると呼び出されます。
</para>
<programlisting>void ProcessOnItemHelp(
Widget widget)
{
/* <emphasis>Declare a variable for the selected widget.</emphasis> */
Widget selWidget=NULL;
int status=DtHELP_SELECT_ERROR;
/* <emphasis>Get an application shell widget from our widget hierarchy to
* pass into DtHelpReturnSelectedWidgetId().</emphasis> */
while (!XtIsSubclass(widget, applicationShellWidgetClass))
widget = XtParent(widget);
status = DtHelpReturnSelectedWidgetId(widget, NULL, &amp;selWidget);
switch ((int)status)
{
case DtHELP_SELECT_ERROR:
printf(&ldquo;Selection Error, cannot continue\n&rdquo;);
break;
case DtHELP_SELECT_VALID:
/* <emphasis>We have a valid widget selection, now let's look
for a registered help callback to invoke.</emphasis> */
while (selWidget != NULL)
{
if ((XtHasCallbacks(selWidget, XmNhelpCallback)
== XtCallbackHasSome))
{
/* <emphasis>Found a help callback, so just call it</emphasis> */
XtCallCallbacks((Widget)selWidget,
XmNhelpCallback,NULL);
break;
}
else
/* <emphasis>No help callback on current widget, so try
the widget's parent</emphasis> */
selWidget = XtParent(selWidget);
}
break;
case DtHELP_SELECT_ABORT:
printf("Selection Aborted by user.\n");
break;
case DtHELP_SELECT_INVALID:
printf("You must select a component within your app.\n");
break;
}
}
</programlisting>
</sect3>
</sect2>
</sect1>
</chapter>
<!--fickle 1.14 mif-to-docbook 1.7 01/02/96 16:48:20-->
<?Pub *0000036813>

View File

@@ -0,0 +1,252 @@
<!-- $XConsortium: ch10.sgm /main/11 1996/09/08 19:40:44 rws $ -->
<!-- (c) Copyright 1995 Digital Equipment Corporation. -->
<!-- (c) Copyright 1995 Hewlett-Packard Company. -->
<!-- (c) Copyright 1995 International Business Machines Corp. -->
<!-- (c) Copyright 1995 Sun Microsystems, Inc. -->
<!-- (c) Copyright 1995 Novell, Inc. -->
<!-- (c) Copyright 1995 FUJITSU LIMITED. -->
<!-- (c) Copyright 1995 Hitachi. -->
<chapter id="HRDC.DiaEv.div.1">
<title id="HRDC.DiaEv.mkr.1">ヘルプ・ダイアログのイベント処理</title>
<para>この章では、アプリケーションが処理するヘルプ・ダイアログのイベントについて説明します。
</para>
<informaltable id="HRDC.DiaEv.itbl.1" frame="All">
<tgroup cols="1">
<colspec colname="1" colwidth="4.0 in">
<tbody>
<row rowsep="1">
<entry><para><!--Original XRef content: 'Supporting Help Dialog Events229'--><xref
role="JumpText" linkend="HRDC.DiaEv.mkr.2"></para></entry></row>
<row rowsep="1">
<entry><para><!--Original XRef content: 'Responding to Hyperlink Events230'--><xref
role="JumpText" linkend="HRDC.DiaEv.mkr.3"></para></entry></row>
<row rowsep="1">
<entry><para><!--Original XRef content: 'Detecting When Help Dialogs Are Dismissed232'--><xref
role="JumpText" linkend="HRDC.DiaEv.mkr.5"></para></entry></row>
<row rowsep="1">
<entry><para><!--Original XRef content: 'Using the Application-Configured
Button233'--><xref role="JumpText" linkend="HRDC.DiaEv.mkr.6"></para></entry>
</row></tbody></tgroup></informaltable>
<sect1 id="HRDC.DiaEv.div.2">
<title id="HRDC.DiaEv.mkr.2">ヘルプ・ダイアログ・イベントのサポート</title>
<indexterm><primary>ヘルプ・ダイアログ</primary><secondary>~のイベント処理</secondary></indexterm><indexterm><primary>イベント</primary><secondary>ヘルプ・ダイアログの、処理</secondary></indexterm><indexterm><primary>ダイアログ</primary><secondary>~のイベントの処理</secondary></indexterm>
<para>アプリケーション内の他のウィジェットと同様に、ヘルプ・ウィンドウには、アプリケーションがサポートしなければならない動作がいくつかあります。
</para>
<sect2 id="HRDC.DiaEv.div.3">
<title>ハイパーリンク・イベント</title>
<para>標準ハイパーリンク・イベントのほとんどは、ヘルプ・システムによって内部的に処理されます。しかし、次に示す4種類のアプリケーションが処理しなければならないハイパーリンクがあります。
</para>
<itemizedlist remap="Bullet1"><listitem><para><emphasis>新規ウィンドウ表示ハイパーリンク</emphasis> 新規ヘルプ・ウィンドウにトピックを表示するという設計者の要求に応じて、アプリケーションは新規のヘルプ・ダイアログを作成しなければなりません。
</para>
</listitem><listitem><para><emphasis>マニュアル・ページ・リンク</emphasis> アプリケーションは、新規の簡易ヘルプ・ダイアログを作成し(またはキャッシュから取り出し)、マニュアル・ページを表示しなければなりません。通常、マニュアル・ページ・ウィンドウのサイズは、他のすべてのヘルプ・ウィンドウと異なります。
</para>
</listitem><listitem><para><emphasis>アプリケーション定義リンク</emphasis> アプリケーションは、これらのリンクに関連付けられているデータを解釈しなければなりません。アプリケーション定義リンクは、アプリケーションの開発者とヘルプの設計者が、このリンクの作成のために共同で作業をした場合にだけ存在します。
</para>
</listitem><listitem><para><emphasis>テキスト・ファイル・リンク</emphasis> アプリケーションは簡易ヘルプ・ダイアログを作成し(またはキャッシュから取り出し)、テキスト・ファイルを表示しなければなりません。
</para>
</listitem></itemizedlist>
</sect2>
<sect2 id="HRDC.DiaEv.div.4">
<title>ダイアログを終了する場合</title>
<para>ユーザがヘルプ・ダイアログを閉じる場合、そのキャッシュ内にダイアログを格納するか、または破棄するかを認識している必要があります。一般ヘルプ・ダイアログでは、ヘルプ・クローズ・コールバックをサポートしています。簡易ダイアログの終了を検知するには、[閉じる]ボタンにコールバックを追加してください。
</para>
</sect2>
<sect2 id="HRDC.DiaEv.div.5">
<title>簡易ヘルプ・ボタン</title>
<para>簡易ヘルプ・ダイアログにあるいくつかのボタンの動作は、アプリケーションによって処理されなければなりません。これらのボタンは、必要に応じて管理することも管理しないことも可能です。起動コールバックを使用して、他のプッシュボタンのように動作を追加することができます。
</para>
<sect3 id="HRDC.DiaEv.div.6">
<title>関連項目</title>
<itemizedlist remap="Bullet1"><listitem><para><link linkend="HRDC.WrTop.div.33" endterm="HRDC.WrTop.mkr.14"></link>は、ヘルプ・システムがサポートしているリンクの種類を記述し、リンクの作成方法について説明しています。
</para>
</listitem></itemizedlist>
</sect3>
</sect2>
</sect1>
<sect1 id="HRDC.DiaEv.div.7">
<title id="HRDC.DiaEv.mkr.3">ハイパーリンク・イベントへの応答</title>
<indexterm><primary>~への応答</primary><secondary>ハイパーリンク・イベント</secondary></indexterm><indexterm><primary>ハイパーリンク</primary><secondary>イベント、~への応答</secondary></indexterm><indexterm><primary>イベント</primary><secondary>ハイパーリンク、~への応答</secondary></indexterm>
<para>アプリケーションは、表示されるヘルプ・ボリューム内で使用されるハイパーリンクの種類だけは、少なくともサポートする必要があります。一般的には、すべてのリンクの種類をサポートするようにしてください。
</para>
<para>ハイパーリンクが選択されたときに、アプリケーションに通知する場合、<emphasis>ハイパーリンク・コールバック</emphasis>をヘルプ・ダイアログに追加します。適切にハイパーリンクを処理するコールバック関数を指定しなければなりません。
</para>
<sect2 id="HRDC.DiaEv.div.8" role="Procedure">
<title id="HRDC.DiaEv.mkr.4">ハイパーリンク・コールバックを指定するには
<indexterm><primary>ハイパーリンク</primary><secondary>コールバック、~の指定</secondary></indexterm><indexterm><primary>コールバック</primary><secondary>ハイパーリンク、~の指定</secondary></indexterm><indexterm>
<primary>&lt;Filename | Command>XtAddCallback &lt;Default Para Font></primary></indexterm><indexterm>
<primary>関数</primary><secondary>&lt;Filename | Command>XtAddCallback() &lt;Default Para Font></secondary></indexterm></title>
<orderedlist><listitem><para>次のようにしてハイパーリンク・コールバックを各ヘルプ・ダイアログに追加します。
</para>
<programlisting>XtAddCallback ( <symbol role="Variable">helpDialog</symbol>, DtNhyperlLinkCallback,
<symbol role="Variable">HyperlinkCB</symbol>, (XtPointer)NULL);</programlisting>
<para><symbol role="Variable">helpDialog</symbol> は、ヘルプ・ダイアログのウィジェットIDで、<symbol role="Variable">HyperlinkCB</symbol> は、ハイパーリンクを処理するコールバック関数の名前です。
</para>
</listitem><listitem><para>ダイアログ内で発生する可能性があるハイパーリンク・イベントを処理するための <symbol role="Variable">HyperlinkCB</symbol> 関数を指定します。
</para>
</listitem></orderedlist>
<para>ハイパーリンク・コールバック内で、次のコールバック構造体(<filename>&lt;Dt/Help.h></filename> で宣言されます)にアクセスしなければなりません。
<indexterm>
<primary>&lt;Filename | Command>DtHelpDialogCallbackStruct &lt;Default Para Font></primary>
</indexterm><indexterm><primary>構造体</primary><secondary>&lt;Filename | Command>DtHelpDialogCallbackStruct &lt;Default Para Font></secondary></indexterm></para>
<programlisting>typedef struct
{
int reason;
XEvent *event;
char *locationId;
char *helpVolume;
char *specification;
int hyperType;
int windowHint;
} DtHelpDialogCallbackStruct;</programlisting>
<para><command>hyperType</command> 要素は、実行されたリンクの種類を示します。指定可能な値は、<filename>DtHELP_LINK_TOPIC</filename> <command>、</command> <filename>DtHELP_LINK_MAN_PAGE</filename><command>、</command> <filename>DtHELP_LINK_APP_DEFINE</filename><command>、および</command> <filename>DtHELP_LINK_TEXT_FILE</filename><command>です。別の種類に対して、どの構造体要素が有効かということについては、</command> <filename moreinfo="RefEntry">DtHelpDialog</filename>(3) のマニュアル・ページを参照してください。
</para>
<para><computeroutput>windowHint</computeroutput> 要素は、ウィンドウの種類を示します。その指定可能な値は、<systemitem>DtHELP_CURRENT_WINDOW</systemitem>、<systemitem>DtHELP_POPUP_WINDOW</systemitem>、および<systemitem>DtHELP_NEW_WINDOW</systemitem> です。</para>
<sect3 id="HRDC.DiaEv.div.9">
<title>例</title>
<para>次の関数 <filename>HyperlinkCB()</filename> は、ハイパーリンク・コールバックを処理するために必要な一般構造体を示しています。
</para>
<programlisting>XtCallbackProc
HyperlinkCB (widget, clientData, callData)
Widget widget;
XtPointer clientData;
XtPointer callData;
{
DtHelpDialogCallbackStruct *hyperData =
(DtHelpDialogCallbackStruct *) callData;
switch ((int)hyperData-> hyperType)
{
case DtHELP_LINK_TOPIC:
/* <symbol role="Variable">Handles &ldquo;jump new view&rdquo;hyperlinks.</symbol> */
break;
case DtHELP_LINK_MAN_PAGE:
/* <symbol role="Variable">Handles &ldquo;man page&rdquo; hyperlinks.</symbol> */
break;
case DtHELP_LINK_APP_DEFINE:
/* <symbol role="Variable">Handles &ldquo;application-defined&rdquo; hyperlinks.</symbol> */
break;
case DtHELP_LINK_TEXT_FILE:
/* <symbol role="Variable">Handles &ldquo;text file&rdquo; hyperlinks.</symbol> */
break;
default:
break;
}</programlisting>
</sect3>
</sect2>
</sect1>
<sect1 id="HRDC.DiaEv.div.10">
<title id="HRDC.DiaEv.mkr.5">ヘルプ・ダイアログの終了の検出
<indexterm><primary>ヘルプ・ダイアログ</primary><secondary>終了の検出</secondary></indexterm><indexterm><primary>ダイアログ</primary><secondary>終了の検出</secondary></indexterm></title>
<para>一般ヘルプ・ダイアログのクローズを検出するには、次のコールバックをダイアログに追加します。
</para>
<programlisting>XtAddCallback (<symbol role="Variable">helpDialog</symbol>, DtNcloseCallback,
<symbol role="Variable">HelpCloseCB</symbol>, (XtPointer)NULL);
</programlisting>
<para><indexterm><primary>コールバック</primary><secondary>クローズ・コールバックの例</secondary></indexterm>
<symbol role="Variable">helpDialog</symbol> はヘルプ・ダイアログのウィジェットIDで、<symbol role="Variable">HelpCloseCB</symbol> はダイアログのクローズを処理するために指定したコールバック手続きの名前です。
</para>
<para>簡易ヘルプ・ダイアログのクローズを検出するには、次のコールバックをダイアログの[了解]ボタンに追加します。
</para>
<programlisting>XtAddCallback (DtHelpQuickDialogGetChild ( <symbol role="Variable">helpDialog</symbol>,
DtHELP_QUICK_OK_BUTTON), XmNactivateCallback, <symbol role="Variable">HelpCloseCB</symbol>,
(XtPointer)NULL);</programlisting>
<para><symbol role="Variable">helpDialog</symbol> はヘルプ・ダイアログのウィジェットIDで、<symbol role="Variable">HelpCloseCB</symbol> はダイアログのクローズを処理するために指定したコールバック手続きの名前です。
</para>
</sect1>
<sect1 id="HRDC.DiaEv.div.11">
<title id="HRDC.DiaEv.mkr.6">アプリケーション構成ボタンの使い方
<indexterm><primary>ボタン、アプリケーション構成</primary></indexterm></title>
<para>簡易ヘルプ・ダイアログのアプリケーション構成ボタンにより、カスタム動作を簡易ヘルプ・ダイアログに追加します。このボタンは、希望に合わせて使用できますが、その目的としては2つの方法のいずれかでヘルプへのパスを提供することです。
</para>
<itemizedlist remap="Bullet1"><listitem><para>段階を追って情報を検索することができます。これは、しばしば段階的な表示と呼ばれます。この場合、デフォルトのボタン・ラベル([詳細 &hellip;])が適切です。
</para>
</listitem><listitem><para>アプリケーションのヘルプ・ボリュームを通常どおりブラウズするために、一般ヘルプ・ダイアログを<emphasis>開くことができるようにします</emphasis>。この場合、[ブラウズ &hellip;]がもっとも適切なボタン・ラベルになります。
</para>
</listitem></itemizedlist>
<sect2 id="HRDC.DiaEv.div.12" role="Procedure">
<title id="HRDC.DiaEv.mkr.7">アプリケーション構成ボタンを使用可能にするには
<indexterm>
<primary>アプリケーション構成、ボタンを使用可能にする</primary></indexterm></title>
<orderedlist><listitem><para>ボタンのIDを取得します。</para>
</listitem><listitem><para>起動コールバックをボタンに追加します。</para>
</listitem><listitem><para>ボタンを管理します。</para>
</listitem></orderedlist>
<sect3 id="HRDC.DiaEv.div.13">
<title>例</title>
<para>次のコード・セグメントは、ボタンのIDを取得し、コールバックを割り当て、ボタンを管理します。<command>quickHelpDialog</command> が作成されたばかりであることを想定しています。
</para>
<programlisting>Widget moreButton;
moreButton = DtHelpQuickDialogGetChild (quickHelpDialog,
DtHELP_QUICK_MORE_BUTTON);
XtAddCallback (moreButton, XmNactivateCallback,
MoreHelpCB, NULL);
XtManageChild (moreButton);</programlisting>
</sect3>
<sect3 id="HRDC.DiaEv.div.14">
<title>関連項目</title>
<itemizedlist remap="Bullet1"><listitem><para><!--Original XRef content: '&ldquo;To
Create a Quick Help Dialog&rdquo; on page&numsp;211'--><xref role="SecTitleAndPageNum"
linkend="HRDC.CrDia.mkr.7"></para>
</listitem><listitem><para><filename moreinfo="RefEntry">DtHelpDialog</filename>(3) マニュアル・ページ</para>
</listitem><listitem><para><filename moreinfo="RefEntry">DtHelpQuickDialog</filename>(3) マニュアル・ページ</para>
</listitem></itemizedlist>
</sect3>
</sect2>
<sect2 id="HRDC.DiaEv.div.12a" role="Procedure"><title id="HRDC.DiaEv.mkr.7a">[詳細 &hellip;]ボタンを使用して DtInfo にアクセスするには</title>
<para>デスクトップ DtHelp 機能の拡張機能として、アプリケーションは簡易ヘルプ・ダイアログの[詳細 &hellip;]ボタンにローカルなコールバックを追加することができます。これは、簡易ヘルプの表示内容と関連する追加情報のために dtinfo を引き続いて起動したり、詳細なヘルプ(「アプリケーションについて」や「ウィンドウについて」のような)のために DtInfo を直接起動します。
</para>
<para>有用性に関する特定の見地から、ローカルな情報本体へのアクセスをユーザに提供する場合は、組み込みの関数 <command>DtActionInvoke()</command> を使用することができます。アンカー・ポイントは、ブックケースのトップと同じように広範囲か、あるいは、特定のセクションと同じように詳細か、どちらでも可能です。また、データの構築において、外部的に一意のリンクIDが与えられれば、セクション内のターゲットも可能です。
</para>
<sect3><title>例</title>
<para>次のセクションは、DtInfo を起動(または接続)する CDE デスクトップ・アクションの API の使用方法を説明しています。
</para>
<para><command>DtActionInvoke</command> を呼び出す前に、アプリケーションは、まずデスクトップ・サービス・ライブラリを初期化するために <command>DtInitialize</command> を、アクションとデータ型を読み込むために <command>DtDbLoad</command> を呼び出さなければなりません。DtInfo アクションおよびデータ型のエントリは CDE デスクトップの一部であるため、これらそれぞれについて <command>DtDbReloadNotify</command> 関数を使用する必要はありません。
</para>
<programlisting>#include &lt;Dt/Action.h>
#include &lt;limits.h>
#include &lt;locale.h>
...
int info_bridge( char * infolib, char* uulocator)
{
char info_uuid[ MAXFQLOCATORBUFSIZE ];
char exec_host[ MAXHOSTNAMESIZE ];
DtActionArg* args = NULL;
Xegetshorthostname(localhost, MAXHOSTNAMESIZE);
args = (DtActionArg*) XtCalloc( 2, sizeof(DtActionArg) );
...
args[0].argclass = DtACTION_BUFFER;
args[0].u.buffer.bp = (void*) infolib;
args[0].u.buffer.size = strlen( infolib) + 1;
args[0].u.buffer.writable = False;
...
sprintf( info_uuid, "%s%s", "mmdb:LOCATOR=", uulocator );
args[1].argclass = DtACTION_BUFFER;
args[1].u.buffer.bp = (void*) info_uuid;
args[1].u.buffer.size = strlen( info_uuid) + 1;
args[1].u.buffer.writable = False;
actionId = DtActionInvoke(
w,
"DtShowInfoAtLOC",
args,
2,
NULL,
exec_host,
NULL,
True,
NULL,
NULL
);
...
XtFree( args );
}
</programlisting>
</sect3>
</sect2>
</sect1>
</chapter>
<!--fickle 1.14 mif-to-docbook 1.7 01/02/96 16:48:20-->
<?Pub Caret>
<?Pub *0000018925>

View File

@@ -0,0 +1,295 @@
<!-- $XConsortium: ch11.sgm /main/10 1996/09/08 19:40:53 rws $ -->
<!-- (c) Copyright 1995 Digital Equipment Corporation. -->
<!-- (c) Copyright 1995 Hewlett-Packard Company. -->
<!-- (c) Copyright 1995 International Business Machines Corp. -->
<!-- (c) Copyright 1995 Sun Microsystems, Inc. -->
<!-- (c) Copyright 1995 Novell, Inc. -->
<!-- (c) Copyright 1995 FUJITSU LIMITED. -->
<!-- (c) Copyright 1995 Hitachi. -->
<chapter id="HRDC.H4Hlp.div.1">
<title id="HRDC.H4Hlp.mkr.1">「ヘルプの使い方」の作成</title>
<para>この章では、ヘルプ・システムの機能とその使用方法を記述するヘルプ・ボリュームをアプリケーションに組み込む方法について説明します。このヘルプ・ボリュームは、ヘルプ・ダイアログ・ボックスの使い方に関するヘルプを提供します。
</para>
<informaltable id="HRDC.H4Hlp.itbl.1" frame="All">
<tgroup cols="1">
<colspec colname="1" colwidth="4.0 in">
<tbody>
<row rowsep="1">
<entry><para><!--Original XRef content: 'Accessing Help on Help in an Application236'--><xref
role="JumpText" linkend="HRDC.H4Hlp.mkr.2"></para></entry>
</row>
<row rowsep="1">
<entry><para><!--Original XRef content: 'To Set the helpOnHelpVolume Resource237'--><xref
role="JumpText" linkend="HRDC.H4Hlp.mkr.3"></para></entry>
</row>
<row rowsep="1">
<entry><para><!--Original XRef content: 'To Provide a Using Help Command237'--><xref
role="JumpText" linkend="HRDC.H4Hlp.mkr.4"></para></entry>
</row>
<row rowsep="1">
<entry><para><!--Original XRef content: 'To Display Help on Help238'--><xref
role="JumpText" linkend="HRDC.H4Hlp.mkr.5"></para></entry>
</row>
<row rowsep="1">
<entry><para><!--Original XRef content: 'Writing Your Own Help on Help Volume239'--><xref
role="JumpText" linkend="HRDC.H4Hlp.mkr.6"></para></entry>
</row>
<row rowsep="1">
<entry><para><!--Original XRef content: 'To Copy the Help4Help Source Files241'--><xref
role="JumpText" linkend="HRDC.H4Hlp.mkr.7"></para></entry>
</row>
</tbody>
</tgroup>
</informaltable>
<sect1 id="HRDC.H4Hlp.div.2">
<title>「ヘルプの使い方」の作成</title>
<para>「ヘルプの使い方」はヘルプ・システムの使用方法を通知します。特に、ハイパーリンクの使用、トピックのナビゲート、索引の使用、およびヘルプ・トピックの印刷などの作業について説明します。通常は、「ヘルプの使い方」は Help4Help という名前の個別のヘルプ・ボリュームとして提供されます。
</para>
<para>Help4Help ボリュームとそのソース・ファイルは開発者用ツールキットに組み込まれています。デフォルト・ボリュームを「そのまま」使用するか、アプリケーションの設計に合わせてそれを変更することができます。
</para>
<sect2 id="HRDC.H4Hlp.div.3">
<title>アプリケーション・ヘルプの場合</title>
<para>アプリケーション特定のヘルプを記述する場合、アプリケーションのヘルプ・ダイアログに [ヘルプの使い方] を追加する方法には、次の2種類があります。
</para>
<itemizedlist remap="Bullet1"><listitem><para><emphasis>デスクトップ上の「ヘルプの使い方」ボリュームを使用する。</emphasis>
たとえば、デスクトップを実行しているワークステーションには、標準の Help4Help ボリュームがインストールされます。
</para>
</listitem><listitem><para><emphasis>独自の「ヘルプの使い方」ボリュームを作成する。</emphasis>
Help4Help ボリュームの DocBook ソース・ファイルは、Cロケールの場合、<filename>/usr/dt/dthelp/help4help/C</filename> ディレクトリに作成されます。このディレクトリ内で Help4Help を実行して実行時のヘルプ・ファイルを作成してください。「ヘルプの使い方」ボリュームで使用されているグラフィック・ファイルは、<filename>graphics</filename> サブディレクトリに格納されます。
</para>
</listitem></itemizedlist>
</sect2>
<sect2 id="HRDC.H4Hlp.div.4">
<title>スタンドアロン・ヘルプの場合</title>
<para>スタンドアロン・ヘルプを記述する場合、すでにインストールされ使用準備ができているヘルプビュー・プログラムを使用します。この場合、ヘルプビューは、デフォルトとして標準の Help4Help ボリュームにアクセスするので、「ヘルプの使い方」について心配する必要はありません。
</para>
</sect2>
<sect2 id="HRDC.H4Hlp.div.5">
<title>「ヘルプの使い方」の検索方法</title>
<para>ヘルプ・システム(ヘルプビューを含む)を使用する各アプリケーションは、「ヘルプの使い方」トピックのためにアクセスされるヘルプ・ボリュームを識別する <systemitem class="resource">helpOnHelpVolume</systemitem> リソースをもっています。ヘルプビューの場合、このリソースは次のように設定されます。
</para>
<programlisting>DtHelpview*helpOnHelpVolume: Help4Help</programlisting>
<para>独自の「ヘルプの使い方」ボリュームを作成する場合、システムにインストールされる可能性のある別の「ヘルプの使い方」ボリュームと競合しないように固有の名前を付けるようにしてください。
</para>
</sect2>
</sect1>
<sect1 id="HRDC.H4Hlp.div.6">
<title id="HRDC.H4Hlp.mkr.2">アプリケーションの「ヘルプの使い方」へのアクセス</title>
<para>アプリケーションは「ヘルプの使い方」をサポートするために次のことを行います。
</para>
<itemizedlist remap="Bullet1"><listitem><para><systemitem class="resource">helpOnHelpVolume</systemitem> リソースを設定し、アクセスしたいヘルプ・ボリュームを識別します。</para>
</listitem><listitem><para><command>Using Help</command> コマンドを、アプリケーションの[ヘルプ]メニューに追加します。
</para>
</listitem></itemizedlist>
<sect2 id="HRDC.H4Hlp.div.7" role="Procedure">
<title id="HRDC.H4Hlp.mkr.3">helpOnHelpVolume リソースを設定するには</title>
<orderedlist><listitem><para>次のように、アプリケーションのデフォルトのリソース・ファイルに1行追加します。
</para>
<para><symbol role="Variable">App-class</symbol>* <systemitem class="resource">helpOnHelpVolume</systemitem>: <symbol role="Variable">volume</symbol></para>
<para><symbol role="Variable">App-class</symbol> はアプリケーションのクラス名で、<symbol role="Variable">volume</symbol> はアクセスしたい「ヘルプの使い方」ボリュームの名前です。
</para>
<para><emphasis>または</emphasis>アプリケーション内で、作成した各ヘルプ・ダイアログ <systemitem class="resource">helpOnHelpVolume</systemitem> リソースを設定します。
</para>
</listitem></orderedlist>
<sect3 id="HRDC.H4Hlp.div.8">
<title>例</title>
<itemizedlist remap="Bullet1"><listitem><para><filename>dthelpview</filename> のデフォルトのリソース・ファイル (<command>DtHelpview</command>) にある次の行は、「ヘルプの使い方」ボリュームを指定します。
</para>
<programlisting>DtHelpview*helpOnHelpVolume: Help4Help</programlisting>
</listitem><listitem><para>ヘルプ・ダイアログの作成中に「ヘルプの使い方」ボリュームを作成するには、次のように作成関数に渡された引き数のリストに追加します。
</para>
<programlisting>ac = 0;
XtSetArg (al[ac], XmNtitle, "My Application - Help"); ac++;
XtSetArg (al[ac], DtNhelpOnHelpVolume, "Help4Help"); ac++;
helpDialog = DtCreateHelpDialog (parent, "helpDialog", al, ac);</programlisting>
</listitem></itemizedlist>
</sect3>
</sect2>
<sect2 id="HRDC.H4Hlp.div.9" role="Procedure">
<title id="HRDC.H4Hlp.mkr.4">[ヘルプの使い方] コマンドを指定するには</title>
<orderedlist><listitem><para>[ヘルプ]メニューに<literal>[ヘルプの使い方]</literal>というラベルのボタンを追加します。また、必要な起動コールバックを起動して、<function>HelpRequestCB()</function> 関数を呼び出します。
</para>
</listitem><listitem><para><function>HelpRequestCB()</function> 関数にサポートを追加し、「ヘルプの使い方」を表示します。特に、次のことを実行します。
</para>
<itemizedlist><listitem><para>簡易ヘルプ・ダイアログを作成する。
</para>
</listitem><listitem><para>ダイアログのタイトルを「ヘルプの使い方」に設定する。
</para>
</listitem><listitem><para>「ヘルプの使い方」ボリュームのホーム・トピックを表示する。
</para>
</listitem><listitem><para>簡易ヘルプ・ダイアログを管理する。
</para>
</listitem></itemizedlist>
</listitem></orderedlist>
<sect3 id="HRDC.H4Hlp.div.10">
<title>例</title>
<para>次の行は、<function>HelpRequestCB()</function> 関数を呼び出す <literal>[ヘルプの使い方 &hellip;]</literal> というラベルのメニュー・ボタンを作成します。
</para>
<programlisting>/* <emphasis>Create the "ヘルプの使い方 ..." button.</emphasis> */
labelStr = XmStringCreateLtoR ("使い方 ...",
XmSTRING_DEFAULT_CHARSET);
ac = 0;
XtSetArg (al[ac], XmNlabelString, labelStr); ac++;
button = XmCreatePushButtonGadget (parent, "usingHelpButton", al,
ac);
XtManageChild (button);
XmStringFree (labelStr);
/* <emphasis>Add a callback to the button.</emphasis> */
XtAddCallback (button,XmNactivateCallback,HelpRequestCB,
USING_HELP);</programlisting>
<para><systemitem class="constant">USING_HELP</systemitem> は、ユーザがメニュー・ボタンを選択したときに <function>HelpRequestCB()</function> 関数に渡されるクライアント・データです。アプリケーションの別の場所(たとえば <filename>Help.h</filename> ファイル)で固有の整数として定義します。
integer:</para>
<programlisting>#define USING_HELP 47</programlisting>
<para><function>HelpRequestCB()</function> 関数が <systemitem class="constant">USING_HELP</systemitem> を処理する方法を確認するには、次の「ヘルプの使い方」を表示するには」にある例を参照してください。
</para>
</sect3>
</sect2>
<sect2 id="HRDC.H4Hlp.div.11" role="Procedure">
<title id="HRDC.H4Hlp.mkr.5">「ヘルプの使い方」を表示するには</title>
<orderedlist><listitem><para>簡易ヘルプ・ダイアログを作成します(またはキャッシュから取り出します)。
</para>
</listitem><listitem><para>ダイアログに「ヘルプの使い方」ボリュームのホーム・トピックを表示します。
</para>
</listitem></orderedlist>
<para>「ヘルプの使い方」は、一般ヘルプ・ウィンドウに表示できます。しかし、簡易ヘルプ・ダイアログのユーザ・インタフェースはもっと単純なので簡易ヘルプ・ダイアログを使用するようにしてください。このダイアログは、通常「ヘルプの使い方」を必要とする新しいユーザでも容易に使えるものです。
</para>
<sect3 id="HRDC.H4Hlp.div.12">
<title>例</title>
<para>次のプログラム・セグメントは、<function>HelpRequestCB()</function> 関数の一部です。仮定として、ユーザは、アプリケーションの[ヘルプ]メニューから[ヘルプの使い方]を選択するか、簡易ヘルプ・ダイアログの[ヘルプ]ボタンを選択するため、<systemitem class="constant">USING_HELP</systemitem> 定数は、その関数に渡されます。
</para>
<para>次の例は、アプリケーションが[ヘルプの使い方]ダイアログをひとつしか作成せず、そのウィジェットIDを <symbol role="Variable">onHelpDialog</symbol> と呼ばれる変数に保持するものと仮定しています。</para>
<programlisting>case USING_HELP:
if (onHelpDialog == (Widget)NULL)
{
/* <emphasis>Get a quick help dialog for use as the "help on help" dialog.</emphasis> */
onHelpDialog = FetchHelpDialog (True);
if (onHelpDialog == (Widget)NULL)
/* <emphasis>We didn't get a dialog! Add your error handling code here.</emphasis> */
}
/* <emphasis>Set the proper volume and ID to display the home topic of the help on help volume. Also, set the dialog's title.</emphasis> */
ac = 0; XtSetArg (al[ac], XmNtitle, "Help On Help"); ac++;
XtSetArg (al[ac], XmNhelpType, DT_HELP_TYPE_TOPIC); ac++;
XtSetArg (al[ac], XmNhelpVolume, "Help4Help"); ac++;
XtSetArg (al[ac], XmNlocationId, "_hometopic"); ac++;
XtSetValues (onHelpDialog, al, ac);
/* <emphasis>If the "help on help" dialog is already managed, it might be in another workspace, so unmanage it.</emphasis> */
if (XtIsManaged (onHelpDialog))
XtUnmanageChild (onHelpDialog);
/* <emphasis>Manage the "help on help" dialog.</emphasis> */
XtManageChild (onHelpDialog);
break;
</programlisting>
<para><function>HelpRequestCB()</function> 関数の残りの構成方法を確認するには、 <xref role="SecTitleAndPageNum" linkend="HRDC.HReq.mkr.10"> を参照してください。
</para>
</sect3>
<sect3 id="HRDC.H4Hlp.div.13">
<title>関連項目</title>
<itemizedlist remap="Bullet1">
<listitem><para><xref role="SecTitleAndPageNum" linkend="HRDC.CrDia.mkr.7">
</para>
</listitem><listitem><para><xref role="SecTitleAndPageNum" linkend="HRDC.HReq.mkr.5">
</para>
</listitem></itemizedlist>
</sect3>
</sect2>
</sect1>
<sect1 id="HRDC.H4Hlp.div.14">
<title id="HRDC.H4Hlp.mkr.6">独自の「ヘルプの使い方」ボリュームを記述する
</title>
<para>独自の「ヘルプの使い方」ボリュームを作成する必要がある場合、既存の Help4Help ボリュームで開始し、必要な変更を行ってください。Help4Help ボリュームを記述するのに使用されるソース・ファイルは、すべて <filename>/usr/dt/dthelp/help4help/C</filename> ディレクトリに用意されています。
</para>
<para>インストールの重複を避けるには、「ヘルプの使い方」ボリュームに Help4Help 以外の名前を付けます。ユーザのプロダクトに固有の名前を選ぶようにしてください。たとえば、アプリケーションのヘルプ・ボリュームが Newapp の場合は、「ヘルプの使い方」ボリュームは NetwappH4H という名前にします。
</para>
<sect2 id="HRDC.H4Hlp.div.15">
<title>必須のエントリ・ポイント</title>
<para>ヘルプ・ダイアログのコンテキスト・ヘルプを正しく動作させるには、「ヘルプの使い方」ボリュームに、次のエントリ・ポイントIDを作成しなければなりません。これらは、すでに Help4Help ソース・ファイルにあります。)
</para>
<informaltable>
<tgroup cols="2" colsep="0" rowsep="0">
<colspec align="left" colwidth="158*">
<colspec align="left" colwidth="370*">
<tbody>
<row>
<entry align="center" valign="top"><para>ID</para></entry>
<entry align="center" valign="top"><para>トピック記述</para></entry>
</row>
<row>
<entry align="left" valign="top"><para><command>_hometopic</command></para></entry>
<entry align="left" valign="top"><para>ヘルプ・システムの使い方に関するイントロダクションを表示します。このトピックは、一般ヘルプ・ダイアログの[ヘルプ]メニューから[ヘルプの使い方]を選択したり、簡易ヘルプ・ダイアログ・の[F1]キーを押すと、表示されます。このIDは、PartIntro のために自動的に生成されるので、明示的に指定しないようにしてください。
</para></entry>
</row>
<row>
<entry align="left" valign="top"><para><command>_copyright</command></para></entry>
<entry align="left" valign="top"><para>「ヘルプの使い方」ボリュームに関する商標とバージョン情報を表示します。このトピックは、一般ヘルプ・ダイアログの[ヘルプ]メニューから[バージョン]を選択すると表示されます。このIDは、LegalNotice のために自動的に生成されるので、明示的に指定しないようにしてください。
</para></entry>
</row>
<row>
<entry align="left" valign="top"><para><command>history</command></para></entry>
<entry align="left" valign="top"><para>[ヒストリ]ダイアログの使用方法を記述しているトピックを表示します。このトピックは、[ヘルプ]を選択するか、[ヒストリ]ダイアログの[F1]キーを押すと表示されます。
</para></entry>
</row>
<row>
<entry align="left" valign="top"><para><command>printing</command></para></entry>
<entry align="left" valign="top"><para>[印刷]ダイアログの使用方法を記述しているトピックを表示します。このトピックは、[ヘルプ]を選択するか、[印刷]ダイアログの[F1]キーを押すと表示されます。
</para></entry>
</row>
<row>
<entry align="left" valign="top"><para><command>index-search</command></para></entry>
<entry align="left" valign="top"><para>[索引検索]ダイアログの使用方法を記述しているトピックを表示します。このトピックは、[ヘルプ]を選択するか、[索引検索]ダイアログの[F1]キーを押すと表示されます。
</para></entry>
</row>
<row>
<entry align="left" valign="top"><para><command>volume-select</command></para></entry>
<entry align="left" valign="top"><para>[検索ボリューム選択]ダイアログの使用方法を記述しているトピックを表示します。このトピックは、[ヘルプ]を選択するか、[検索ボリューム選択]ダイアログの[F1]キーを押すと表示されます。
</para></entry>
</row>
</tbody>
</tgroup>
</informaltable>
</sect2>
<sect2 id="HRDC.H4Hlp.div.16" role="Procedure">
<title id="HRDC.H4Hlp.mkr.7">Help4Help ソース・ファイルをコピーするには</title>
<orderedlist><listitem><para>次のようにコマンドを使用して、<filename>/usr/dt/dthelp/help4help/C</filename> ディレクトリ全体を新しい作業ディレクトリ ( <symbol role="Variable">new-dir</symbol>) にコピーします。</para>
<para><command>cp -r /usr/dt/dthelp/help4help/C <symbol role="Variable">new-dir</symbol></command></para>
<para>これは <symbol role="Variable">new-dir</symbol> を作成し、すべてのファイルとディレクトリをその中にコピーします。
</para>
</listitem><listitem><para>ファイル(読み取り専用としてコピーされる)の編集を可能にするには、次のようにコマンドを使用してアクセス権を変更します。
</para>
<programlisting>chmod -R u+w <symbol role="Variable">new-dir</symbol></programlisting>
</listitem></orderedlist>
<para>Help4Help ボリュームは、これらの DocBook ソース・ファイルを使用します。
</para>
<itemizedlist><listitem><para><filename>MetaInfo.sgm</filename></para>
</listitem><listitem><para><filename>Toc.sgm</filename></para>
</listitem><listitem><para><filename>Tasks.sgm</filename></para>
</listitem><listitem><para><filename>Home.sgm</filename></para>
</listitem><listitem><para><filename>Concepts.sgm</filename></para>
</listitem><listitem><para><filename>Ref.sgm</filename></para>
</listitem><listitem><para><filename>Appendix.sgm</filename></para>
</listitem></itemizedlist>
<para>グラフィック・ファイルは、<filename>graphics</filename> サブディレクトリに保存されます。
</para>
<para>DocBook を実行する前に <filename>Help4Help.sgm</filename> ファイルの名前が変更されていることを確認してください。「ヘルプの使い方」ボリュームの名前は、他の「ヘルプの使い方」ボリュームと重複しないように、固有の名前でなければなりません。
</para>
<sect3 id="HRDC.H4Hlp.div.17">
<title>例</title>
<para>次のコマンドは「ヘルプの使い方」ボリュームのコピーを作成し、そのファイルを書き込み可能にします。(<filename>projects</filename> サブディレクトリがすでに存在していると仮定しています。)
</para>
<programlisting>cp -r /usr/dt/dthelp/help4help/C /users/dex/projects/NewHelp4Help
chmod -R u+w /users/dex/projects/NewHelp4Help</programlisting>
<para>実行時のヘルプ・ファイルの新しいバージョンを作成するには、最初にディレクトリ <filename>/usr/dt/bin</filename> が検索パス内にあることを確認します。次に、新規ディレクトリに移動し、<filename>Help4Help.sgm</filename> ファイルの名前を変更し、DocBook を実行します。
</para>
<programlisting>cd /users/dex/projects/NewHelp4Help
mv Help4Help.sgm NewH4H.sgm
dtDocBook NewH4H</programlisting>
<para>DocBook ソフトウェアを実行すると、次のコマンドを使用して新しい「ヘルプの使い方」ボリュームを表示できます。
</para>
<para><command>dthelpview -helpVolume NewH4H</command></para><?Pub Caret>
</sect3>
</sect2>
</sect1>
</chapter>
<!--fickle 1.14 mif-to-docbook 1.7 01/02/96 16:48:20-->

View File

@@ -0,0 +1,197 @@
<!-- $XConsortium: ch12.sgm /main/11 1996/09/08 19:41:02 rws $ -->
<!-- (c) Copyright 1995 Digital Equipment Corporation. -->
<!-- (c) Copyright 1995 Hewlett-Packard Company. -->
<!-- (c) Copyright 1995 International Business Machines Corp. -->
<!-- (c) Copyright 1995 Sun Microsystems, Inc. -->
<!-- (c) Copyright 1995 Novell, Inc. -->
<!-- (c) Copyright 1995 FUJITSU LIMITED. -->
<!-- (c) Copyright 1995 Hitachi. -->
<chapter id="HRDC.Inst.div.1">
<title id="HRDC.Inst.mkr.1">インストール・パッケージの準備</title>
<para id="HRDC.Inst.mkr.2">この章では、アプリケーションのインストール・パッケージにあるヘルプ・ファイルについて説明します。また、アプリケーションがデスクトップに登録されるときにヘルプ・ファイルが処理される方法についても説明します。
</para>
<informaltable id="HRDC.Inst.itbl.1" frame="All">
<tgroup cols="1">
<colspec colname="1" colwidth="4.0 in">
<tbody>
<row rowsep="1">
<entry><para><!--Original XRef content: 'Delivering Online Help244'--><xref
role="JumpText" linkend="HRDC.Inst.mkr.4"></para></entry></row>
<row rowsep="1">
<entry><para><!--Original XRef content: 'Creating an Installation Package244'--><xref
role="JumpText" linkend="HRDC.Inst.mkr.5"></para></entry></row>
<row rowsep="1">
<entry><para><!--Original XRef content: 'Registering Your Application and
Its Help247'--><xref role="JumpText" linkend="HRDC.Inst.mkr.9"></para></entry>
</row>
<row rowsep="1">
<entry><para><!--Original XRef content: 'Product Preparation Checklists248'--><xref
role="JumpText" linkend="HRDC.Inst.mkr.12"></para></entry></row></tbody></tgroup>
</informaltable>
<sect1 id="HRDC.Inst.div.2">
<title id="HRDC.Inst.mkr.3">概要</title>
<para>最終的に製品を準備する段階になったら、すべてのヘルプ・ファイルが適切に作成され、インストールされていることを確認しなければなりません。製品パッケージには、
実行時のヘルプ・ファイル (<symbol>volume</symbol><filename>.sdl</filename>) およびそのグラフィック・ファイルの両方が入っています。さらに、フロントパネルのヘルプ・ビューアを使用してボリュームの表示を可能にするヘルプ・ファミリ・ファイルを作成することができます。
</para>
</sect1>
<sect1 id="HRDC.Inst.div.3">
<title id="HRDC.Inst.mkr.4">オンライン・ヘルプの配布</title>
<para>オンライン・ヘルプは、アプリケーションに完全に統合されるか、スタンドアロン・ヘルプ・ボリュームとして提供されます。完全に統合されたヘルプによって、[ヘルプ]メニューか[ヘルプ]キーを使用して、アプリケーションからヘルプ情報に直接アクセスできます。その一方、スタンドアロン・ヘルプは、デスクトップのヘルプ・ビューアを使用してのみ表示できます。
</para>
<para>システム管理者は、アプリケーションが統合されたヘルプを提供しない場合や、カスタマイズされた環境で補足的なヘルプ・ボリュームが作成されない場合に、スタンドアロン・ヘルプ・ボリュームをデスクトップに追加するように選択できます。デスクトップにスタンドアロン・ボリュームを追加する手順については、<xref role="SecTitleAndPageNum" linkend="HRDC.Inst.mkr.10"> を参照してください。
</para>
</sect1>
<sect1 id="HRDC.Inst.div.4">
<title id="HRDC.Inst.mkr.5">インストール・パッケージの作成</title>
<para>インストール・パッケージには、次のヘルプ・ファイルが入っています。
</para>
<itemizedlist><listitem><para>実行時のヘルプ・ファイル</para>
</listitem><listitem><para>グラフィック・ファイル</para>
</listitem><listitem><para>ヘルプ・ファミリ・ファイル (オプション)</para>
</listitem><listitem><para>アプリケーション・デフォルト・ファイル (オプション)</para>
</listitem></itemizedlist>
<para>オンライン・ヘルプで使用されている実行時のヘルプ・ファイルとグラフィック・ファイルは、インストール・パッケーシに入っています。ヘルプ・ファミリ・ファイルは、統合されたアプリケーション・ヘルプのオプションです。しかし、アプリケーション・ヘルプをデスクトップのヘルプ・ビューアを使用してブラウズ可能にしたい場合は、ファミリ・ファイルを作成しなければなりません。スタンドアロン・ヘルプ・ボリュームを配布する場合は、ヘルプ・ファミリ・ファイルを作成しなければなりません。<xref role="SecTitleAndPageNum" linkend="HRDC.CrHV.mkr.11"> を参照してください。
</para>
<para>アプリケーションのヘルプ・ボリュームに実行リンクがある場合、設計者はアプリケーションのデフォルトのリソース・ファイルに実行別名を定義するようにしてください。このためには、実行別名でリンクを自動的に実行するヘルプ・システムのデフォルトの実行ポリシーを利用します。しかし、ヘルプ・ボリュームが、ヘルプ・ビューアのような別の情報ビューアを使用して独立したボリュームとして表示される場合、ヘルプ・システムは実行リンクが選択された時点で確認ダイアログボックスを表示します。
</para>
<para><xref role="Page" linkend="HRDC.Inst.mkr.6"> の <xref role="CodeOrFigureOrTable" linkend="HRDC.Inst.mkr.6"> は、アプリケーションとそのヘルプ・ファイルの典型的なインストール・パッケージを示しています。ヘルプ・ディレクトリは、デフォルトの言語ディレクトリC がデフォルトです)がある別の <filename>help</filename> サブディレクトリにグループ化されます。実行時のヘルプ・ファイル、ファミリ・ファイル、およびグラフィック・ファイルは、このディレクトリにあります。
</para>
<figure>
<title id="HRDC.Inst.mkr.6">アプリケーション・インストール・パッケージ</title>
<graphic id="HRDC.Inst.grph.1" entityref="HRDC.Inst.fig.1"></graphic>
</figure>
<para>アプリケーションが複数の言語でオンライン・ヘルプを提供する場合、各言語を格納するための <symbol role="Variable">language</symbol> サブディレクトリを作成してください(<symbol role="Variable">language</symbol> はユーザの <systemitem class="resource">LANG</systemitem> 環境変数と一致します)。たとえば、英語ユーザ・インタフェースとドイツ語ユーザ・インタフェースの両方を提供するアプリケーションは、英語には <filename>C</filename>、ドイツ語には <filename>german</filename>、というように2つのサブディレクトリに、それぞれ対応するオンライン・ヘルプを保存します。
</para>
<sect2 id="HRDC.Inst.div.5">
<title>実行時ヘルプ・ファイル</title>
<para>DocBook は単一の実行時のヘルプ・ファイル <symbol role="Variable">volume</symbol><filename>.sdl</filename> を作成します。ベース名 <symbol role="Variable">volume</symbol> は、<symbol role="Variable">volume</symbol><filename>.sgm</filename> ファイルのベース名と同一です。ヘルプ・ビューアは、マスタ・ヘルプ・ファイルに保存されている情報を使用し、関連付けられたグラフィック・ファイルにもアクセスします。
</para>
<para>DocBook ソフトウェアによって作成された <symbol role="Variable">volume</symbol><filename>.sgm</filename> や追加のファイルを出荷する必要はありません。
</para>
</sect2>
<sect2 id="HRDC.Inst.div.6">
<title id="HRDC.Inst.mkr.7">グラフィック・ファイル</title>
<para>ヘルプ・ボリュームがグラフィックを使用している場合、通常、イメージ・ファイルは、便宜上別のディレクトリに保存されます。しかし、<symbol role="Variable">volume</symbol><command>.sgm</command> ファイルと同じ場所に保存するように選択することも可能です。
</para>
<para>実行時のヘルプ・ファイルには、実際のグラフィック・イメージは入っていません。その代わりに、各グラフィック・ファイルへの位置への「参照」が入っています。DocBook を実行すると、<command>dtdocbook</command> コンパイラは、グラフィックの相対パス名をヘルプ・ボリュームに組み込みます。
</para>
<para>ヘルプ・ファイルがインストールされると、グラフィック・ファイルは実行時のファイルが作成されたときと同じ相対位置に位置付けられます。そうでない場合は、ヘルプ・ボリュームはグラフィック・ファイルを位置付けることはできません。たとえば、グラフィック・ファイルが <symbol role="Variable">volume</symbol><filename>.sgm</filename> ファイルよりひとつ下のレベルにある <filename>graphics</filename> という名前のサブディレクトリにある場合、インストール・パッケージはその相対位置を確保しておかなければなりません。グラフィック・ファイルは、<symbol role="Variable">volume</symbol><filename>.sdl</filename> ファイルよりひとつ下のレベルにある <filename>graphics</filename> という名前のサブディレクトリに位置付けられなければなりません。
</para>
<figure>
<title>作成ディレクトリとインストール・パッケージの関係</title>
<graphic id="HRDC.Inst.grph.2" entityref="HRDC.Inst.fig.2"></graphic>
</figure>
</sect2>
<sect2 id="HRDC.Inst.div.7">
<title>ヘルプ・ファミリ・ファイル</title>
<para>ヘルプ・ファミリ・ファイル (<symbol>volume</symbol><filename>.hf</filename>) をオプションとして提供できます。ファミリ・ファイルにはヘルプ・ボリュームについての簡単な記述と著作権情報があります。また、このファイルは、ひとつ以上の関連のあるボリュームをひとつの製品のカテゴリにグループ化するときにも使用されます。
</para>
<para id="HRDC.Inst.mkr.8">デスクトップ・ブラウザ・ボリュームからヘルプ・ボリュームへアクセス可能にしたい場合、インストール・パッケージにファミリ・ファイルを作成しなければなりません。ファミリ・ファイルを作成するには、<xref role="SecTitleAndPageNum" linkend="HRDC.CrHV.mkr.11"> を参照してください。
</para>
</sect2>
</sect1>
<sect1 id="HRDC.Inst.div.8">
<title id="HRDC.Inst.mkr.9">アプリケーションとそのヘルプの登録</title>
<para>デスクトップの統合ユーティリティ <command>dtappintegrate</command> は、インストールされたアプリケーション・ファイルと特定のデスクトップ・ディレクトリの間にシンボリック・リンクを作成することによって、アプリケーションとそのヘルプ・ファイルを登録します。アプリケーションの登録によって、ヘルプ・システムが使用するディレクトリ検索パスにヘルプ・ファイルを確実に位置付けることができます。
</para>
<para>登録によって、ヘルプ・システムの重要な2つの機能が使用可能になります。
</para>
<itemizedlist><listitem><para><emphasis>他のボリュームへのハイパーリンク</emphasis> ひとつのヘルプ・ボリュームにあるハイパーリンクは、ボリューム名とボリュームにあるIDだけを使用して、別のヘルプ・ボリュームを参照することができます。転送先ボリュームが登録されている場合、リンクはボリュームをファイル・システムのどこに保存するかを指定する必要はありません。
</para>
</listitem><listitem><para><emphasis>ヘルプ・ファミリのブラウズ</emphasis>
「ヘルプ・ファミリ」も登録する場合、ヘルプ・ボリュームはヘルプ・ビューアを使用してブラウズ可能になります。
</para>
</listitem></itemizedlist>
<para>オンライン・ヘルプを登録すると、提供したヘルプにアクセスしやすくなります。設計者とプログラマにとっては、ボリュームの実際の位置を指定しなくても、ボリュームへの参照には、ボリューム名だけを使用すればよいため、より簡単です。
</para>
<para>ひとつ以上のヘルプ・ボリュームがあるヘルプ・ファミリを登録する場合、フロントパネルの[ヘルプ・ビューア]からの一般的なブラウズにヘルプを使用できるようにします。これによって、アプリケーションを使用せずに、アプリケーション固有のヘルプにアクセスすることができます。また、スタンドアロン・ヘルプを記述している場合は、この方法がヘルプにたどりつく唯一の方法です。
</para>
<sect2 id="HRDC.Inst.div.9">
<title id="HRDC.Inst.mkr.10">スタンドアロン・ヘルプ</title>
<para>アプリケーションのスタンドアロン・ヘルプ・ボリュームやカスタマイズされた環境は、ヘルプ・システムの開発者用キットを使用して作成できます。ヘルプ・ボリュームをデスクトップ・ブラウザ・ボリュームからアクセス可能にするには、システム管理者は実行時のヘルプ・ファイル、関連付けられたグラフィック、およびファミリ・ファイルを <filename>/etc/dt/appconfig/help/</filename><symbol role="Variable">language</symbol> ディレクトリにインストールしてください。
</para>
<para>実行時のヘルプ・ファイルとそのグラフィック・ファイルは、ヘルプ・ボリュームが作成されたときと同じ相対位置にインストールされなければならないことを忘れないでください。グラフィック・ファイルのインストールを見直すには、<xref role="SecTitleAndPageNum" linkend="HRDC.Inst.mkr.7"> を参照してください。
</para>
</sect2>
<sect2 id="HRDC.Inst.div.10">
<title>アプリケーションの登録時に発生すること</title>
<para>アプリケーションの登録により、<symbol>app_root</symbol>/<filename>dt/appconfig/help</filename><symbol>language</symbol> にある実行時のヘルプ・ファイルおよびファミリと <filename>/etc/dt/appconfig/help</filename>/<symbol>language</symbol> ディレクトリの間にシンボリック・リンクが作成されます。
</para>
<para>アプリケーションの登録手順の詳細については、<citetitle>共通デスクトップ環境 上級ユーザおよびシステム管理者ガイド</citetitle> を参照してください。
</para>
</sect2>
<sect2 id="HRDC.Inst.div.11">
<title id="HRDC.Inst.mkr.11">ヘルプ・ボリュームの検索方法</title>
<para>ヘルプ・システムはデスクトップ検索パスを使用してヘルプ・ボリュームを位置付けます。ヘルプがアプリケーション内で要求されたり、ヘルプ・ボリュームがコマンド行に指定された場合、ヘルプ・ボリュームは検索パス・ディレクトリのセットをチェックすることによって検索されます。いくつかの環境変数を変更してヘルプ・ボリュームのディレクトリ検索パスをコントロールすることができます。検索パスの指定の詳細については、<citetitle>共通デスクトップ環境 上級ユーザおよびシステム管理者ガイド</citetitle> を参照してください。
</para>
</sect2>
</sect1>
<sect1 id="HRDC.Inst.div.12">
<title id="HRDC.Inst.mkr.12">製品準備チェックリスト</title>
<para>次のチェックリストは、製品が適切に準備されていることを確認するのに役立ちます。もちろん、ユーザが行うように製品をテストするのがいちばんいい方法です。
</para>
<sect2 id="HRDC.Inst.div.13">
<title>設計者の場合</title>
<orderedlist><listitem><para><emphasis>最後のバージョンの実行時のヘルプ・ファイルが作成された。
</emphasis></para>
<para>次の例は、実行時のファイルの作成の際に推奨するコマンドです。
</para>
<para><command>dtdocbook -r</command> <symbol role="Variable">volume</symbol></para>
<para><command>dtdocbook</command> <symbol role="Variable">volume</symbol></para>
<para><command>-r</command> オプションは、上記の <command>dtdocbook</command> コマンドからファイルを削除します。パーサ・エラーが発生したヘルプ・ボリュームを配布してはいけません。パーサ・エラーが発生すると、dtdocbook はそれらを中間ファイル <symbol role="Variable">volume</symbol><filename>.log</filename> に出力します。</para>
</listitem><listitem><para><emphasis>すべてのハイパーリンクをテストした。</emphasis>
</para>
<para>各ハイパーリンクが適切なトピックを表示し、正しいアクションが実行されることを検証します。
</para>
</listitem><listitem><para><emphasis>実行別名が実行リンクに定義された。</emphasis></para>
<para>実行別名は、アプリケーションのアプリケーション・デフォルト・ファイルにあるリソースとして定義されます。実行別名は、実行されるシェル・コマンドと名前とを関連付けます。ヘルプ・ボリュームで実行リンクを使用した場合は、アプリケーション開発者がこれらのリソースをアプリケーション・デフォルト・ファイルに追加するように調整してください。
</para>
</listitem><listitem><para><emphasis>すべてのグラフィックが受け入れ可能である。</emphasis></para>
<para>グラフィックの表示を、さまざまな色、グレースケール、およびモノクロ・ディスプレイでテストしたことを確認してください。
</para>
</listitem></orderedlist>
</sect2>
<sect2 id="HRDC.Inst.div.14">
<title>製品のインテグレータの場合</title>
<orderedlist><listitem><para><emphasis>実行時のファイルがインストールされた。</emphasis></para>
</listitem><listitem><para><emphasis>すべてのグラフィックが適切な位置にインストールされた。</emphasis></para>
<para>各グラフィック・ファイルは、DocBook ソフトウェアが実行されたときに <filename>.sgm</filename> ファイルとは相対的な位置にあった <filename>.sdl</filename> ファイルに対しても、同じ相対的な位置にインストールされなければなりません。
</para>
</listitem><listitem><para><emphasis>ヘルプ・ボリュームが登録された。</emphasis></para>
<para><command>dtappintegrate</command> スクリプトが、インストール・ディレクトリから登録ディレクトリにシンボリック・リンクを作成するために実行された。
</para>
</listitem><listitem><para><emphasis>製品のファミリ・ファイルがインストールおよび登録された。</emphasis></para>
<para>ファミリ・ファイルは、他のヘルプ・ファイルとともにインストールされます。<command>dtappintegrate</command> を実行すると、ファミリ・ファイルのシンボリック・リンクを作成します。ヘルプ・ボリュームのためにファミリ・ファイルを登録するのは任意です。しかし、ファミリ・ファイルを登録しないと、ヘルプ・ボリュームはフロントパネルのヘルプ・ビューアからはアクセスできません。
</para>
</listitem></orderedlist>
</sect2>
<sect2 id="HRDC.Inst.div.15">
<title>プログラマの場合</title>
<orderedlist><listitem><para><emphasis>アプリケーションは次の必須リソースに対して正しい値を設定している。</emphasis></para>
<programlisting><symbol>App-class</symbol>*helpVolume: <symbol>volume</symbol>
<symbol>App-class</symbol>*helpOnHelpVolume: <symbol role="Variable">help-on-help-volume</symbol></programlisting>
<para><systemitem class="resource">helpVolume</systemitem> リソースは、アプリケーションのためのヘルプ・ボリュームを識別します。<systemitem class="resource">helpOnHelpVolume</systemitem> リソースは、ヘルプ・システムの使用に関するヘルプがあるヘルプ・ボリュームを識別します。
</para>
</listitem><listitem><para><emphasis>実行別名はアプリケーションのデフォルトのリソース・ファイルにある。</emphasis></para>
<para>設計者は、アプリケーションのリソースとして実行別名を定義します。実行別名は、実行するシェル・コマンドと名前とを関連付けます。実行リンクがヘルプ・ボリュームで使用されていた場合は、追加する必要があるリソースを識別していることを設計者が確認するようにしてください。
</para>
</listitem><listitem><para><emphasis>アプリケーションが次のオプションのリソースに対して希望する値を設定している。</emphasis></para>
<programlisting><symbol>App-class</symbol>*DtHelpDialogWidget*onHelpDialog*rows: <symbol>rows</symbol>
<symbol>App-class</symbol>*DtHelpDialogWidget*onHelpDialog*columns: <symbol role="Variable">columns</symbol>
<symbol>App-class</symbol>*DtHelpDialogWidget*definitionBox*rows: <symbol role="Variable">rows</symbol>
<symbol>App-class</symbol>*DtHelpDialogWidget*definitionBox*columns: <symbol role="Variable">columns</symbol>
</programlisting>
<para><systemitem class="resource">onHelpDialog</systemitem> リソースは、「ヘルプの使い方」を表示するために使用される簡易ヘルプ・ダイアログのサイズを制御します。<systemitem class="resource">definitionBox</systemitem> リソースは、定義リンクに使用される簡易ヘルプ・ダイアログのサイズを制御します。
</para>
</listitem><listitem><para><emphasis>アプリケーションはデフォルトのフォント・リソースを使用するかアプリケーションのデフォルトのリソース・ファイルにフォント・リソースを定義している。</emphasis></para>
<para>ほとんどの場合、アプリケーションはデフォルトのフォント・リソースを使用できます。しかし、カスタム・フォントが使用される場合、デフォルトのリソース・ファイルに定義されていなければなりません。サンプルのフォント・スキーマが <filename>/usr/dt/dthelp/fontschemes</filename> ディレクトリに用意されています。フォント・スキーマの詳細については、<xref role="ChapNumAndTitle" linkend="HRDC.Lang.mkr.1"> を参照してください。
</para>
</listitem></orderedlist>
</sect2>
</sect1>
</chapter>
<!--fickle 1.14 mif-to-docbook 1.7 01/02/96 16:48:20-->
<?Pub *0000023101>

View File

@@ -0,0 +1,475 @@
<!-- $XConsortium: ch13.sgm /main/9 1996/08/26 10:45:59 rws $ -->
<!-- (c) Copyright 1995 Digital Equipment Corporation. -->
<!-- (c) Copyright 1995 Hewlett-Packard Company. -->
<!-- (c) Copyright 1995 International Business Machines Corp. -->
<!-- (c) Copyright 1995 Sun Microsystems, Inc. -->
<!-- (c) Copyright 1995 Novell, Inc. -->
<!-- (c) Copyright 1995 FUJITSU LIMITED. -->
<!-- (c) Copyright 1995 Hitachi. -->
<chapter id="HRDC.Lang.div.1">
<title id="HRDC.Lang.mkr.1">母国語のサポート</title>
<para id="HRDC.Lang.mkr.2">この章では、ヘルプ・ボリュームを複数の言語で提供する場合に変更が必要なヘルプ・システムが使用するファイルを説明します。
</para>
<informaltable id="HRDC.Lang.itbl.1" frame="All">
<tgroup cols="1">
<colspec colname="1" colwidth="4.0 in">
<tbody>
<row rowsep="1">
<entry><para><!--Original XRef content: 'Internationalized Online Help253'--><xref
role="JumpText" linkend="HRDC.Lang.mkr.3"></para></entry>
</row>
<row rowsep="1">
<entry><para><!--Original XRef content: 'Character Sets and Multibyte Characters254'--><xref
role="JumpText" linkend="HRDC.Lang.mkr.5"></para></entry>
</row>
<row rowsep="1">
<entry><para><!--Original XRef content: 'DtHelp Message Catalog258'--><xref
role="JumpText" linkend="HRDC.Lang.mkr.8"></para></entry>
</row>
<row rowsep="1">
<entry><para><!--Original XRef content: 'LANG Environment Variable259'--><xref
role="JumpText" linkend="HRDC.Lang.mkr.9"></para></entry>
</row>
<row rowsep="1">
<entry><para><!--Original XRef content: 'Understanding Font Schemes260'--><xref
role="JumpText" linkend="HRDC.Lang.mkr.11"></para></entry>
</row>
<row rowsep="1">
<entry><para><!--Original XRef content: 'Creating a Formatting Table263'--><xref
role="JumpText" linkend="HRDC.Lang.mkr.14"></para></entry>
</row>
<row rowsep="1">
<entry><para><!--Original XRef content: 'Displaying a Localized Help Volume265'--><xref
role="JumpText" linkend="HRDC.Lang.mkr.17"></para></entry>
</row>
<row rowsep="1">
<entry><para><!--Original XRef content: 'Preparing Online Help for International
Audiences265'--><xref role="JumpText" linkend="HRDC.Lang.mkr.18"></para></entry>
</row>
</tbody>
</tgroup>
</informaltable>
<sect1 id="HRDC.Lang.div.2">
<title id="HRDC.Lang.mkr.3">国際化対応のオンライン・ヘルプ</title>
<para>外国のユーザ向けの製品の場合、オンライン・ヘルプをユーザの母国語で提供することが大切です。ヘルプ・システムは、オンライン・ヘルプの記述と表示を実質的にどの言語でもサポートします。
</para>
<para>実行時のヘルプ・ファイルを作成するためのヘルプ・ボリュームを処理する場合、ファイルの記述にどの言語および文字セットを使用したかを DocBook ソフトウェアに必ず指示しなければなりません。言語および文字セットの情報は、ヘルプ・ボリュームを表示するために適切なフォントを決定するためにも使用されます。
</para>
</sect1>
<sect1 id="HRDC.Lang.div.3">
<title id="HRDC.Lang.mkr.4">国際化の要因</title>
<para>次節で説明するいくつかの要因は、オンライン・ヘルプをユーザの母国語で提供するのに役立ちます。
</para>
<sect2 id="HRDC.Lang.div.4">
<title id="HRDC.Lang.mkr.5">文字セット</title>
<para><emphasis>文字セット</emphasis>は、文字を認識するためのコンピュータの内部文字コードのマップ方法を決定します。ほとんどの言語は、ひとつの文字セット全体を表すにはシングル・バイト文字で十分です。しかし、何千もの文字を使用する言語もあります。そのような言語は、ひとつひとつの文字を一意に表すのに2、3、4バイトを必要とします。
</para>
<para>ヘルプ・システムがサポートする文字セットを <xref role="CodeOrFigureOrTable" linkend="HRDC.Lang.mkr.6"> に掲げます。しかし、すべてのプラットフォームに存在するわけではない文字セットもあります。
</para>
<table id="HRDC.Lang.tbl.1">
<title id="HRDC.Lang.mkr.6">共通デスクトップ環境文字セット</title>
<tgroup cols="3" colsep="0" rowsep="0">
<colspec colwidth="1.17in">
<colspec colname="col2" colwidth="1.99in">
<colspec colwidth="2.07in">
<thead>
<row><entry align="left" valign="bottom"><para>言語</para></entry><entry
align="left" valign="bottom"><para>文字セット名</para></entry><entry
align="left" valign="bottom"><para>説明</para></entry></row>
</thead>
<tbody>
<row>
<entry align="left" valign="top"><para>西ヨーロッパおよび南北アメリカ</para></entry>
<entry align="left" valign="top"><para>ISO-8859-1</para></entry>
<entry align="left" valign="top"><para>ISO ラテン 1</para></entry>
</row>
<row>
<entry align="left" colname="col2" valign="top">HP-ROMAN8</entry>
<entry align="left" valign="top">HP ローマン</entry>
</row>
<row>
<entry align="left" colname="col2" valign="top">IBM-850</entry>
<entry align="left" valign="top">PC マルチリンガル</entry>
</row>
<row>
<entry align="left" valign="top"><para>中央ヨーロッパ</para></entry>
<entry align="left" valign="top"><para>ISO-8859-2</para></entry>
<entry align="left" valign="top"><para>ISO ラテン 2</para></entry>
</row>
<row>
<entry align="left" valign="top"><para>キリル文字</para></entry>
<entry align="left" valign="top"><para>ISO-8859-5</para></entry>
<entry align="left" valign="top"><para>ISO ラテン/キリル文字</para></entry>
</row>
<row>
<entry align="left" valign="top"><para>アラビア語</para></entry>
<entry align="left" valign="top"><para>ISO-8859-6</para></entry>
<entry align="left" valign="top"><para>ISO ラテン/アラビア語</para></entry>
</row>
<row>
<entry align="left" valign="top"></entry>
<entry align="left" valign="top"><para>HP-ARABIC8</para></entry>
<entry align="left" valign="top"><para>HP アラビア語 8</para></entry>
</row>
<row>
<entry align="left" valign="top"></entry>
<entry align="left" valign="top"><para>IBM-1046</para></entry>
<entry align="left" valign="top"><para>PC アラビア語</para></entry>
</row>
<row>
<entry align="left" valign="top"><para>ヘブライ語</para></entry>
<entry align="left" valign="top"><para>ISO-8859-8</para></entry>
<entry align="left" valign="top"><para>ISO ラテン/ヘブライ語</para></entry>
</row>
<row>
<entry align="left" valign="top"></entry>
<entry align="left" valign="top"><para>HP-HEBREW8</para></entry>
<entry align="left" valign="top"><para>HP ヘブライ 8</para></entry>
</row>
<row>
<entry align="left" valign="top"></entry>
<entry align="left" valign="top"><para>IBM-856</para></entry>
<entry align="left" valign="top"><para>PC ヘブライ語</para></entry>
</row>
<row>
<entry align="left" valign="top"><para>ギリシャ語</para></entry>
<entry align="left" valign="top"><para>ISO-8859-7</para></entry>
<entry align="left" valign="top"><para>ISO ラテン/ギリシャ語</para></entry>
</row>
<row>
<entry align="left" valign="top"></entry>
<entry align="left" valign="top"><para>HP GREEK8</para></entry>
<entry align="left" valign="top"><para>HP ギリシャ語 8</para></entry>
</row>
<row>
<entry align="left" valign="top"><para>トルコ語</para></entry>
<entry align="left" valign="top"><para>ISO-8859-9</para></entry>
<entry align="left" valign="top"><para>ISO ラテン 5</para></entry>
</row>
<row>
<entry align="left" valign="top"></entry>
<entry align="left" valign="top"><para>HP-TURKISH8</para></entry>
<entry align="left" valign="top"><para>HP トルコ語 8</para></entry>
</row>
<row>
<entry align="left" valign="top"><para>日本語</para></entry>
<entry align="left" valign="top"><para>EUC-JP</para></entry>
<entry align="left" valign="top"><para>日本語 EUC (JISX0201, JISX0208, JISX0212)
</para></entry>
</row>
<row>
<entry align="left" valign="top"></entry>
<entry align="left" valign="top"><para>HP-SJIS</para></entry>
<entry align="left" valign="top"><para>HP 日本語シフトJIS</para></entry>
</row>
<row>
<entry align="left" valign="top"></entry>
<entry align="left" valign="top"><para>HP-KANA8</para></entry>
<entry align="left" valign="top"><para>HP 日本語カタカナ8 (JISX0201 1976)
</para></entry>
</row>
<row>
<entry align="left" valign="top"></entry>
<entry align="left" valign="top"><para>IBM-932</para></entry>
<entry align="left" valign="top"><para>PC 日本語シフトJIS</para></entry>
</row>
<row>
<entry align="left" valign="top"><para>韓国語</para></entry>
<entry align="left" valign="top"><para>EUC-KR</para></entry>
<entry align="left" valign="top"><para>韓国 EUC</para></entry>
</row>
<row>
<entry align="left" valign="top"><para>中国語</para></entry>
<entry align="left" valign="top"><para>EUC-CN</para></entry>
<entry align="left" valign="top"><para>簡体字中国語 EUC (中国) (GB2312)
</para></entry>
</row>
<row>
<entry align="left" valign="top"></entry>
<entry align="left" valign="top"><para>EUC-TW</para></entry>
<entry align="left" valign="top"><para>繁体字中国語 EUC (台湾) (CNS
11643.*)</para></entry>
</row>
<row>
<entry align="left" valign="top"></entry>
<entry align="left" valign="top"><para>HP-BIG5</para></entry>
<entry align="left" valign="top"><para>HP 繁体字中国語 Big5</para></entry>
</row>
<row>
<entry align="left" valign="top"></entry>
<entry align="left" valign="top"><para>HP-CCDC</para></entry>
<entry align="left" valign="top"><para>HP 繁体字中国語 CCDC</para></entry>
</row>
<row>
<entry align="left" valign="top"></entry>
<entry align="left" valign="top"><para>HP-15CN</para></entry>
<entry align="left" valign="top"><para>HP 繁体字中国語 EUC</para></entry>
</row>
<row>
<entry align="left" valign="top"><para>タイ語</para></entry>
<entry align="left" valign="top"><para>TIS-620</para></entry>
<entry align="left" valign="top"><para>タイ語</para></entry>
</row>
</tbody>
</tgroup>
</table>
<para>DocBook ファイルを記述するとき、どんなヘルプ・テキストにもマルチバイト文字を使用できます。しかし、DocBook のマークアップ自体タグ名、エンティティ名、IDなどは、ビット文字で入力しなければなりません。
</para>
</sect2>
<sect2 id="HRDC.Lang.div.8">
<title>DocBook ソフトウェア</title>
<para>実行時のヘルプ・ファイルを作成するためにヘルプ・ボリュームを処理する場合、DocBook ソフトウェアに、ファイルを作成するときに使用する言語と文字セットを伝えなければなりません。言語と文字セットの情報は、ヘルプ・トピックを表示するための適切なフォントを決定するために使用されます。言語と文字セットが指定されない場合、DocBook は、デフォルト ISO-8859-1 を仮定します。
</para>
<para>言語と文字セットは <systemitem class="environvar">LANG</systemitem> 環境変数、あるいは Part の Lang 属性を使用して指定することができます。
</para>
<note>
<para>DocBook ファイルを記述するとき、どんなヘルプ・テキストにもマルチバイト文字を使用できます。しかし、DocBook のマークアップ自体タグ名、エンティティ名、IDなどは、ビット文字で入力しなければなりません。
</para>
</note>
</sect2>
<sect2 id="HRDC.Lang.div.9">
<title id="HRDC.Lang.mkr.8">DtHelp</title>
<para>ヘルプ・ダイアログのメニュー、ボタン、ラベルもユーザの母国語で表示されるべきです。これを実現するために、ヘルプ・ダイアログは、それらの文字列を <filename>DtHelp.cat</filename> という名前の<emphasis>メッセージ・カタログ</emphasis>から読み取ります。メッセージ・カタログのソース・ファイル <filename>DtHelp.msg</filename> には、メニュー、ボタン、メッセージの文字列が指定されています。必要な言語が提供されていない場合は、サンプルのメッセージ・カタログ (<filename>/usr/dt/dthelp/nls/C/DtHelp.msg</filename>) を翻訳してから、<command>gencat</command> コマンドで実行時のメッセージ・カタログ・ファイルを作成しなければなりません。手順については、<xref role="SecTitleAndPageNum" linkend="HRDC.Lang.mkr.16"> を参照してください。
</para>
<para>新規のメッセージ・カタログをインストールする正しいディレクトリを決定するには、システムに付属のマニュアルを参照してください。
</para>
</sect2>
<sect2 id="HRDC.Lang.div.10">
<title id="HRDC.Lang.mkr.9">LANG 環境変数</title>
<para>ユーザの <systemitem class="environvar">LANG</systemitem> 環境変数は、次の2つの理由により重要です。
</para>
<itemizedlist><listitem><para><systemitem class="environvar">LANG</systemitem> の値は、正しいヘルプ・ボリュームをの位置を見つけるために使用されます。
</para>
</listitem><listitem><para>ヘルプ・トピックが表示されるとき、正しいフォントおよび書式化の規則は、ユーザの <systemitem class="environvar">LANG</systemitem> 環境変数に基づいて選択されます。これは、ヨーロッパやアメリカの言語よりも複雑な行の折り返し規則を持つアジアの言語において特に重要です。
</para>
</listitem></itemizedlist>
<sect3 id="HRDC.Lang.div.11">
<title>関連項目</title>
<itemizedlist remap="Bullet1"><listitem><para><citetitle>共通デスクトップ環境 国際化対応プログラマーズ・ガイド</citetitle></para>
</listitem><listitem><para>ご使用のコンピュータのオペレーティング・システム用の NLS 関連のマニュアルまたはプログラマ用ツールキット
</para>
</listitem></itemizedlist>
</sect3>
</sect2>
<sect2 id="HRDC.Lang.div.13">
<title>フォーマット・テーブル</title>
<para>日本語や中国語などのマルチバイト言語には、<emphasis>フォーマット・テーブル</emphasis>が必要です。フォーマット・テーブルは、行頭にできない文字と行末にできない文字のリストを提供します。ヘルプ・ファイルが処理されるときに、フォーマット・テーブルは行が確実に折り返されるようにします。<xref role="SecTitleAndPageNum" linkend="HRDC.Lang.mkr.14"> は、新規テーブルの作成方法、またヘルプ開発者用キットで提供されるサンプル・テーブルの編集方法を説明しています。
</para>
</sect2>
<sect2 id="HRDC.Lang.div.14">
<title>フォント・スキーマ</title>
<para>DocBook ソフトウェアのおもな機能のひとつは、マークアップされたファイルを、ヘルプ・システムが解釈できる実行時の形式に変換することです。テキストは、型ファミリ、サイズ、傾斜、線の太さなどの特定の属性を指定してフォーマットされています。<emphasis>フォント・スキーマ</emphasis>は、別名のように、ヘルプ・システムが、ヘッダ、プロシージャ、リストなどの DocBook 要素にフォントを割り当てるために使う単なる名前です。フォント・スキーマにより、ヘルプ・システムが使用するひとかたまりのテキスト属性を特定のフォントにマップすることができます。
</para>
<para>標準の共通デスクトップ環境フォントを使用するアプリケーションは、追加のフォント・リソースを定義する必要はありません。それ以外のフォント・セットにアプリケーションが依存する場合は、そのアプリケーション用にフォント・スキーマを作成して追加しなければなりません。
</para>
<sect3 id="HRDC.Lang.div.15">
<title>関連項目</title>
<itemizedlist remap="Bullet1"><listitem><para><filename moreinfo="RefEntry">DtStdInterfaceFontNames(5)</filename> のマニュアル・ページ</para>
</listitem><listitem><para><filename moreinfo="RefEntry">DtStdAppFontNames
(5)</filename> のマニュアル・ページ</para>
</listitem></itemizedlist>
</sect3>
</sect2>
</sect1>
<sect1 id="HRDC.Lang.div.16">
<title id="HRDC.Lang.mkr.11">フォント・スキーマの理解</title>
<para>DocBook マークアップ言語を使用してヘルプ・ボリュームを記述する場合は、テキストのフォントおよぴサイズは指定しません。DocBook ソフトウェアを起動すると、入力した要素が、テキスト属性を含む実行時のヘルプ・ファイルにフォーマットされます。
</para>
<para><emphasis>フォント・スキーマ</emphasis> は、テキスト属性を実際のフォント指定にマップします。たとえば、ヘルプ・トピックがボールドの sans serif (サンセリフ) フォントを使用してフォーマットされている場合、フォント・スキーマは、どの共通
デスクトップ環境標準フォントまたはXフォントが実際にテキスト表示に使用されているかを識別します。
</para>
<para>フォント・スキーマを使用するおもな目的のひとつは、フォント・サイズの選択肢を提供することです。DocBook ソフトウェアは、ほとんどのトピックの本文を10ポイントにフォーマットします。しかし、実際に表示されるフォントは使用されているフォント・スキーマが決定するため、10ポイントのテキストは、すべて14ポイント・フォントを使用するように指定されます。
</para>
<sect2 id="HRDC.Lang.div.17">
<title id="HRDC.Lang.mkr.12">フォント・リソース</title>
<para>各フォント・スキーマは、実際はXリソースのセットです。Xリソースは、ヘルプを表示しているアプリケーションによって読み取られます。フォント・スキーマを変更したい場合は、フォント・リソースをアプリケーションのデフォルトのリソース・ファイルに設定できます。
</para>
<para>フォント・スキーマ内の各リソースの一般的な形式は次のとおりです。</para>
<para>*<symbol role="Variable">pitch</symbol>.<symbol role="Variable">size</symbol>.<symbol role="Variable">slant</symbol>. <symbol role="Variable">weight</symbol>.<symbol role="Variable">style</symbol>. <symbol role="Variable">lang</symbol>.<symbol role="Variable">char-set</symbol>: <symbol role="Variable">font specification</symbol></para>
<para>各フィールドの意味を次に示します。</para>
<informaltable>
<tgroup cols="2" colsep="0" rowsep="0">
<colspec align="left" colwidth="116*">
<colspec align="left" colwidth="412*">
<tbody>
<row>
<entry align="left" valign="top"><para><symbol role="Variable">pitch</symbol></para></entry>
<entry align="left" valign="top"><para>文字間の水平方向の間隔を指定します。このフィールドは、<command>p</command> (プロポーショナル) または <command>m</command> (等幅) のいずれかです。</para></entry>
</row>
<row>
<entry align="left" valign="top"><para><symbol role="Variable">size</symbol></para></entry>
<entry align="left" valign="top"><para>希望するフォントの高さを指定します。DocBook でフォーマットされたヘルプ・ファイルでは、この値は、<symbol>6</symbol>、<symbol>8</symbol>、<symbol>10</symbol>、<symbol>12</symbol>、または <symbol>14</symbol> のいずれかです。</para></entry>
</row>
<row>
<entry align="left" valign="top"><para><symbol role="Variable">slant</symbol></para></entry>
<entry align="left" valign="top"><para>・希望するフォントの傾斜を指定します。このフィールドは、通常、垂直な文字なら <command>roman</command>、傾斜した文字なら <command>italic</command> のいずれかになります。</para></entry>
</row>
<row>
<entry align="left" valign="top"><para><symbol role="Variable">weight</symbol></para></entry>
<entry align="left" valign="top"><para>希望するフォントの線の太さを指定します。このフィールドは、通常、<command>medium</command> または <command>bold</command> のいずれかです。</para></entry>
</row>
<row>
<entry align="left" valign="top"><para><symbol role="Variable">style</symbol></para></entry>
<entry align="left" valign="top"><para>希望するフォントの一般的なスタイルを指定します。DocBook でフォーマットされたヘルプ・ファイルでは、この値は <symbol>serif</symbol> または <symbol>sans_serif</symbol> のいずれかです。</para></entry>
</row>
<row>
<entry align="left" valign="top"><para><symbol role="Variable">lang</symbol></para></entry>
<entry align="left" valign="top"><para>この言語を使用してコンパイルされたボリュームが、これらのフォントを使用するように指定します。通常、指定された <symbol role="Variable">char_set</symbol> を使用するすべてのボリュームが、これらのフォントを使用するように、* (アスタリスク) をエントリに使用します。
</para></entry>
</row>
<row>
<entry align="left" valign="top"><para><symbol role="Variable">char-set</symbol></para></entry>
<entry align="left" valign="top"><para>ヘルプ・テキストの記述に使用する文字セットを使用します。この値は、DocBook を実行したときに指定した文字セットと一致しなければなりません。デフォルトは <symbol>ISO-8859-1</symbol> です。一部の特殊文字は、<command>symbol</command> 文字セットを使用して表示されます。
</para></entry>
</row>
</tbody>
</tgroup>
</informaltable>
<para>* (アスタリスク) を使用すると、特定の属性のすべての値をもつフォントを指定できます。たとえば、記号セット(特殊文字と特殊記号)は、サイズと文字セットのみに基づいて一意のフォントを識別します。
</para>
<para>フォント・リソースは、フォント・スキーマ内で次のように表示されます。
</para>
<programlisting>*.6.*.*.*.*.DT-SYMBOL-1: -adobe-symbol-medium-r-normal-*-*-60-*-*-
p-*-adobe-fontspecific
*.8.*.*.*.*.DT-SYMBOL-1: -adobe-symbol-medium-r-normal-*-*-80-*-*-
p-*-adobe-fontspecific
*.10.*.*.*.*.DT-SYMBOL-1: -adobe-symbol-medium-r-normal-*-*-100-*-
*-p-*-adobe-fontspecific
*.12.*.*.*.*.DT-SYMBOL-1: -adobe-symbol-medium-r-normal-*-*-120-*-
*-p-*-adobe-fontspecific
*.14.*.*.*.*.DT-SYMBOL-1: -adobe-symbol-medium-r-normal-*-*-140-*-
*-p-*-adobe-fontspecific</programlisting>
<para><symbol>char-set</symbol> フィールドは、* (アスタリスク) を使用できない唯一のフィールドです。</para>
<para>日本語や韓国語などのマルチバイト言語を表示するには、フォント・セットを使用してフォント・リソースを指定しなければなりません。フォント・セットは実際にはフォントのグループです。フォント・セットのリソース・エントリは、複数のフォント名が、, (コンマ) で区切られ、指定が : (コロン) で終了する点を除き、単一のフォントと同様です。次の例は、日本語フォント・セット用の完全に指定したフォント・リソースです。
</para>
<programlisting>bridge-gothic-medium-r-normal--18-180-75-75-c-80-jisx0201.1976-0,
bridge-gothic-medium-r-normal--18-180-75-75-c-160-jisx0208.1983-0,
bridge-gothic-medium-r-normal--18-180-75-75-c-160-jisx0212.1990-0:</programlisting>
<para>マルチバイト言語のフォントを指定するには、最小限の XLFD フォント指定を提供し、システムがフォント・セットを生成するために文字セットの順を指定できるようにすることも可能です。
</para>
<programlisting>*.12.roman.medium.*.ja_JP.EUC-JP: -*-*-*-*-*-*-*-120-*-*-*-*-*-*:
</programlisting>
<para>フォント・セットを指定するときには、必ず指定を : (コロン) で終了してください。これにより、ヘルプ・システムは情報を表示するためのフォント・セットを読み込みます。フォント・セットは、マルチバイト言語の表示に使用されます。シングルバイト情報をもつボリュームについては、標準フォント指定を使用してください。
</para>
<sect3 id="HRDC.Lang.div.18">
<title>フォント・スキーマの例</title>
<para><filename>/usr/dt/dthelp/fontschemes</filename> ディレクトリには、4つのフォント・スキーマが格納されています。
</para>
<informaltable>
<tgroup cols="2" colsep="0" rowsep="0">
<colspec align="left" colwidth="165*">
<colspec align="left" colwidth="363*">
<tbody>
<row>
<entry align="left" valign="top"><para><computeroutput>fontDef.fns</computeroutput></para></entry>
<entry align="left" valign="top"><para>ヘルプ・システムが使用するデフォルト・フォント</para></entry>
</row>
<row>
<entry align="left" valign="top"><para><computeroutput>fontLarge.fns</computeroutput></para></entry>
<entry align="left" valign="top"><para>大きなフォントの例</para></entry>
</row>
<row>
<entry align="left" valign="top"><para><computeroutput>fontMulti.fns</computeroutput></para></entry>
<entry align="left" valign="top"><para>マルチバイト・フォントの例</para></entry>
</row>
<row>
<entry align="left" valign="top"><para><computeroutput>fontX11.fns</computeroutput></para></entry>
<entry align="left" valign="top"><para>X11 フォントの例</para></entry>
</row>
</tbody>
</tgroup>
</informaltable>
</sect3>
</sect2>
<sect2 id="HRDC.Lang.div.19" role="Procedure">
<title id="HRDC.Lang.mkr.13">フォント・スキーマを選択するには</title>
<para>オンライン・ヘルプを表示するアプリケーション用のデフォルトのリソース・ファイルを編集します。現在のフォント・リソースがある場合は、新規スキーマに置換します。
</para>
<para>自分だけのためにこの変更を行う場合は、アプリケーションのリソース・ファイルを自分のホーム・ディレクトリにコピーしてから編集を行ってください。
</para>
<sect3 id="HRDC.Lang.div.20">
<title>例</title>
<para><filename>DtStopWatch</filename> という名前の個人用アプリケーションの大きいサイズのフォントを(ヘルプ・ダイアログで)使用するには、次の手順を実行ます。
</para>
<para>ホーム・ディレクトリへ移動します。</para>
<programlisting>cd</programlisting>
<para>次に、アプリケーションのデフォルトのリソース・ファイル <filename>DtStopWatch</filename> をコピーし、書き込み可能にします。
</para>
<programlisting>cp /usr/dt/app-defaults/C/DtStopWatch.
chmod u+w DtStopWatch</programlisting>
<para>最大のスキーマ (<filename>fontLarge.fns</filename>) を追加するように <filename>DtStopWatch</filename> ファイルを編集します。ファイルの終端に行き、次のファイルの内容を挿入します。
</para>
<para><filename>/usr/dt/dthelp/fontschemes/fontLarge.fns</filename></para><?Pub Caret>
<para>新しい <filename>DtStopWatch</filename> ファイルを保存します。</para>
<para><filename>DtStopWatch</filename> アプリケーションを起動し、[ヘルプ]を選択し、ヘルプ・トピックが新しいフォント・スキーマを使用して表示されるか確認します。
</para>
</sect3>
</sect2>
</sect1>
<sect1 id="HRDC.Lang.div.21">
<title id="HRDC.Lang.mkr.14">フォーマット・テーブルの作成</title>
<para>日本語や中国語などのマルチバイト言語には、<emphasis>フォーマット・テーブル</emphasis>が必要です。このテーブルには、3つのメッセージ・セットが含まれています。1番目のセットは行頭にできない文字から成ります。2番目のセットは行末にできない文字をリストしています。3番目のセットは、シングルバイト文字とマルチバイト文字の間に発生する改行文字の処理方法を示しています。
</para>
<para>フォーマット・テーブルは、ASCII ファイルで、ファイル名は必ず拡張子 <filename>.msg</filename> が付きます。<xref role="CodeOrFigureOrTable" linkend="HRDC.Lang.mkr.15"> は、中国語(簡体字)用のフォーマット・テーブルからの抜粋です。
</para>
<figure>
<title id="HRDC.Lang.mkr.15">フォーマット・テーブルの例</title>
<graphic id="HRDC.Lang.grph.1" entityref="HRDC.Lang.fig.1"></graphic>
</figure>
<para>$ (ドル記号) とひとつの空白で始まる行はすべてコメントです。
</para>
<sect2 id="HRDC.Lang.div.22">
<title>フォーマット・テーブルの例</title>
<para>マルチバイト文字セット用のフォーマット・テーブルの例は、<filename>/usr/dt/dthelp/nls/zh_CN.dt-eucCN</filename> ディレクトリにあり、名前は <filename>fmt_tbl.msg</filename> です。</para>
<para>テーブルの例は、文字を追加したり削除したりして変更できます。フォーマット・テーブルを編集するには、ヘルプ情報用に選択した言語の文法を構成できるエディタを使用してください。マルチバイト言語でヘルプ情報を作成したい場合は、フォーマット・テーブルを作成する必要があります。
</para>
</sect2>
<sect2 id="HRDC.Lang.div.23" role="Procedure">
<title id="HRDC.Lang.mkr.16">メッセージ・カタログを作成するには</title>
<para><filename>DtHelp.msg</filename> ファイルを翻訳したり、新しいフォーマット・テーブルを作成したり、テーブルの例 (<filename>fmt_tbl.msg</filename>) を変更した場合は、ヘルプ・システムが使用するメッセージ・カタログを必ず更新してください。
</para>
<para>カタログ・ファイルを生成するには、次のコマンド構文を使用します。
</para>
<para><command>gencat</command> <symbol>file</symbol><filename>.cat</filename> <symbol>file</symbol><filename>.msg</filename></para>
<para>標準デスクトップ・アプリケーションのメッセージ・カタログは <filename>/usr/dt/lib/nls/msg/</filename><symbol>lang</symbol> ディレクトリにあります。メッセージ・カタログをインストールするには、ご使用のオペレーティング・システムのマニュアアルを、ガイドラインとして参照してください。
</para>
<sect3 id="HRDC.Lang.div.24">
<title>関連項目</title>
<itemizedlist remap="Bullet1"><listitem><para><command>gencat</command>(1) のマニュアル・ページ</para>
</listitem></itemizedlist>
</sect3>
</sect2>
</sect1>
<sect1 id="HRDC.Lang.div.25">
<title id="HRDC.Lang.mkr.17">ローカライズされたヘルプ・ボリュームの表示</title>
<para>現在のシステムとは異なるロケールのために作成されたヘルプ・ボリュームを表示するには、そのヘルプ・ボリュームに合うように <systemitem class="environvar">LANG</systemitem> 環境変数を設定しなければなりません。<systemitem class="environvar">LANG</systemitem> 環境変数の値は、プラットフォーム固有です。この変数がよくわからない場合は、環境を設定するための正しい値およびプロシージャをシステム管理者に確認してください。
</para>
</sect1>
<sect1 id="HRDC.Lang.div.26">
<title id="HRDC.Lang.mkr.18">オンライン・ヘルプの国際化対応の確認事項</title>
<para>オンライン・ヘルプを外国のユーザに提供する場合に確認すべき事項を以下のチェックリストにまとめます。
</para>
<itemizedlist remap="Bullet1"><listitem><para>ヘルプ・トピックは外国のユーザを想定して書かれているか?
</para>
</listitem><listitem><para>DocBook ソフトウェアは、正しい <systemitem class="environvar">LANG</systemitem> の設定を使用して実行したか?別の文字セットで作成した場合、<filename>DtHelp.msg</filename> メッセージ・カタログを翻訳し、新しい文字セットをサポートするフォント・スキーマを提供しなければなりません。
</para>
</listitem><listitem><para>ヘルプ・テキストにマルチバイト文字を使用していても、DocBook マークアップ内では、すべてのタグ名、エンティティ名、ID が8ビットの文字セットで入力されているか?
</para>
</listitem><listitem><para>ユーザの <systemitem class="environvar">LANG</systemitem> 環境変数が正しい言語に設定されているとき、ヘルプ・ファイルを適切に見つけて表示できるようにインストールしてあるか?
</para>
</listitem><listitem><para>ヘルプ・システムをアプリケーションに統合した場合、<function>XtSetLanguageProc()</function> 関数を使用して、ロケールを適切に設定したか?</para>
</listitem></itemizedlist>
<sect2 id="HRDC.Lang.div.27">
<title>関連項目</title>
<itemizedlist remap="Bullet1"><listitem><para><xref role="HeadingAndPage"
linkend="HRDC.Inst.mkr.11"></para>
</listitem><listitem><para><command>XtSetLanguageProc</command>(3) のマニュアル・ページ
</para>
</listitem><listitem><para><command>gencat</command>(1) のマニュアル・ページ</para>
</listitem><listitem><para>ご使用のコンピュータのオペレーティング・システム用の NLS 関連のマニュアルまたはプログラマ用ツールキット
</para>
</listitem></itemizedlist>
</sect2>
</sect1>
</chapter>
<!--fickle 1.14 mif-to-docbook 1.7 01/02/96 16:48:20-->

View File

@@ -0,0 +1,343 @@
<!-- $XConsortium: glossary.sg
/main/1 1996/01/07 20:10:08 vobad
$ -->
<!-- (c) Copyright 1995 Digital Equipment Corporation. -->
<!-- (c) Copyright 1995 Hewlett-Packard Company. -->
<!-- (c) Copyright 1995 International Business Machines Corp. -->
<!-- (c) Copyright 1995 Sun Microsystems, Inc. -->
<!-- (c) Copyright 1995 Novell, Inc. -->
<!-- (c) Copyright 1995 FUJITSU LIMITED. -->
<!-- (c) Copyright 1995 Hitachi. -->
<glossary id="HRDC.Gloss.div.1">
<title>用語集</title>
<glossentry><glossterm>Standard Generalized Markup Language (SGML)</glossterm>
<glossdef>
<para>情報の交換方法の確立を目的とする国際規格ISO 8879: 1986です。SGML は、情報の構造の指定をマークアップによって行い、内容とは別に表示や書式を規定します。DocBook マークアップ言語は、この SGML 規格に準拠しています。
</para>
</glossdef>
</glossentry>
<glossentry><glossterm>Tagged Image File Format (TIFF)</glossterm>
<glossdef>
<para>標準のグラフィック・ファイル書式です。ヘルプ・システムのダイアログ・ボックスは TIFF 5.0 イメージをサポートしています。TIFF イメージは、ファイル拡張子 <filename>.tif</filename> で識別できます。
</para>
</glossdef>
</glossentry>
<glossentry><glossterm>Xウィンドウ・ダンプ</glossterm>
<glossdef>
<para>Xウィンドウ・システムのディスプレイから取り込んだイメージです。ウィンドウ・イメージの取り込みには <command>xwd</command> ユーティリティを使用します。Xウィンドウのダンプ・イメージ・ファイルは、ファイル名拡張子 <filename>.xwd</filename> で識別できます。
</para>
</glossdef>
</glossentry>
<glossentry><glossterm>Xピックスマップ</glossterm>
<glossdef>
<para>マルチカラー・イメージです。ピックスマップ・イメージ・ファイルは、ファイル名拡張子 <filename>.pm</filename> で識別できます。</para>
</glossdef>
</glossentry>
<glossentry><glossterm>Xビットマップ</glossterm>
<glossdef>
<para>ファアグラウンド・カラーとバックグラウンド・カラーから成る2色イメーシです。ビットマップ・イメージ・ファイルは、ファイル名拡張子 <filename>.bm</filename> で識別できます。
</para>
</glossdef>
</glossentry>
<glossentry><glossterm>アプリケーション定義リンク</glossterm>
<glossdef>
<para>あるアプリケーションの動作を呼び出すために特別に設計されたハイパーリンクです。動作を呼び出すには、ヘルプはアプリケーションで作成したダイアログに表示されなければなりません。(アプリケーション定義のハイパーリンクは、ヘルプ・ビューでは無視されます。)
</para>
</glossdef>
</glossentry>
<glossentry><glossterm>アプリケーション・ヘルプ</glossterm>
<glossdef>
<para>特定のアプリケーション(ソフトウェア)のためのオンライン・ヘルプです。
</para>
</glossdef>
</glossentry>
<glossentry><glossterm>一般ヘルプ・ダイアログ・ボックス</glossterm>
<glossdef>
<para>ヘルプ情報が表示されるウィンドウです。一般ヘルプ・ダイアログ・ボックスには、メニュー・バー、トピック・ツリー(トピックのリストを表示します)、およびヘルプ・トピック表示領域があります。<emphasis>「簡易ヘルプ・ダイアログ・ボックス」</emphasis>も参照してください。
</para>
</glossdef>
</glossentry>
<glossentry><glossterm>インライン・グラフィック</glossterm>
<glossdef>
<para>1行のテキスト内に表示される小さなグラフィック(イラスト)です。
</para>
</glossdef>
</glossentry>
<glossentry><glossterm>ウィジェット</glossterm>
<glossdef>
<para>グラフィカル・ユーザ・インタフェースの基本的な構成ブロックです。Motif ウィジェット・セットは、アプリケーション・ユーザ・インタフェースの構築に適したすべての種類のウィジェットを提供します。
</para>
</glossdef>
</glossentry>
<glossentry><glossterm>エンティティ</glossterm>
<glossdef>
<para>名前の付いているテキスト文字列またはファイルです。ほとんどのエンティティは(&lt;!Entity> 要素を使用して)設計者が名付けますが、あらかじめ定義されているものもあります。<emphasis>「エンティティの宣言」</emphasis>と<emphasis>「エンティティの参照」</emphasis>も参照してください。</para>
</glossdef>
</glossentry>
<glossentry><glossterm>エンティテイの参照</glossterm>
<glossdef>
<para>前に &amp; (アンパサンド)、後に ; (セミコロン) が付いているエンティティ名を使用して、エンティティ名を記述した場所に、そのエンティティ名を挿入するように、DocBook に指示することです。<emphasis>エンティティ</emphasis>と<emphasis>エンティティの宣言</emphasis>も参照してください。</para>
</glossdef>
</glossentry>
<glossentry><glossterm>エンティティの宣言</glossterm>
<glossdef>
<para>エンティティ名とその値を確立するマークアップです。<emphasis>エンティティ</emphasis>と<emphasis>エンティティの参照</emphasis>も参照してください。</para>
</glossdef>
</glossentry>
<glossentry><glossterm>エントリ・ポイント</glossterm>
<glossdef>
<para>ヘルプを要求すると、直接表示されるヘルプ・ボリュームにあるポイントです。つまり、ユーザが「入力」するトピックの場所またはオンライン・ヘルプを読み始める場所です。IDをもつあらゆるトピックまたはトピック内の場所が、エントリ・ポイントになります。
</para>
</glossdef>
</glossentry>
<glossentry><glossterm>簡易ヘルプ・ダイアログ・ボックス</glossterm>
<glossdef>
<para>ヘルプ・トピック表示領域とひとつ以上のボタンを備えた簡素化したヘルプ・ダイアログ・ボックスです。その他の機能を提供する<emphasis>一般ヘルプ・ダイアログ・ボックス</emphasis>も参照してください。
</para>
</glossdef>
</glossentry>
<glossentry><glossterm>強調表示</glossterm>
<glossdef>
<para>テキスト上で注意を促す要素です(通常は<emphasis>イタリック文字</emphasis>です。)
</para>
</glossdef>
</glossentry>
<glossentry><glossterm>クローズ・コールバック</glossterm>
<glossdef>
<para>ヘルプ・ダイアログ・ボックスを閉じたときに呼び出されるアプリケーション機能です。
</para>
</glossdef>
</glossentry>
<glossentry><glossterm>警告 (warning)</glossterm>
<glossdef>
<para>発生する可能性がある損害や回復不可能なデータ損失をユーザに警告する情報です。<emphasis>注意 (caution)</emphasis>と<emphasis>注 (note)</emphasis>も参照してください。
</para>
</glossdef>
</glossentry>
<glossentry><glossterm>コンテキスト・ヘルプ</glossterm>
<glossdef>
<para>ユーザがアプリケーションで行う作業に関するオンライン情報です。ヘルプ・トピックの選択は、ユーザのコンテキストに基づいて行われるため、[F1]キーを押すと「コンテキスト・ヘルプ」が表示される場合もあります。
</para>
</glossdef>
</glossentry>
<glossentry><glossterm>索引</glossterm>
<glossdef>
<para>ヘルプ・ボリューム中に現われる重要な語句のリストです。索引では語句がアルファベット順になっており、知りたい項目についてのヘルプを検索できます。ユーザが(一般ヘルプ・ダイアログ・ボックスの)[索引]ボタンを選択すると、ヘルプ・システムは索引を表示します。<emphasis>「索引検索ダイアログ・ボックス」</emphasis>を参照してください。</para>
</glossdef>
</glossentry>
<glossentry><glossterm>索引検索ダイアログ・ボックス</glossterm>
<glossdef>
<para>ヘルプ・ボリュームの索引エントリのリストを表示するダイアログ・ボックスです。現在のボリューム、選択したボリューム、すべてのヘルプ・ボリュームの索引を表示することができます。ユーザが索引で単語や語句または関連するトピックを検索して、その検索文字列を含む項目の一覧を表示させることができます。
</para>
</glossdef>
</glossentry>
<glossentry><glossterm>索引ボリューム</glossterm>
<glossdef>
<para>デスクトップは、システムにインストールされたヘルプをリストする特別な索引ボリュームを表示することにより、ヘルプ・ビュー・プログラムを「ヘルプ・ブラウザ」として使用します。<command>dthelpgen</command> と呼ばれるユーティリティは、このボリュームをユーザのホーム・ディレクトリに作成します。
</para>
</glossdef>
</glossentry>
<glossentry><glossterm>索引ボリューム選択ダイアログ・ボックス</glossterm>
<glossdef>
<para>ユーザのシステムで使用可能なヘルプ・ボリュームの一覧を表示するダイアログ・ボックスです。ユーザが、索引検索ダイアログ・ボックスで[選択]を選択すると、このダイアログは、ユーザが選択できるヘルプ・ボリュームの一覧を表示します。ひとつまたは複数のボリューム名を選択することができ、関連する索引情報が索引検索ダイアログ・ボックスに表示されます。
</para>
</glossdef>
</glossentry>
<glossentry><glossterm>実行時ヘルプ・ファイル</glossterm>
<glossdef>
<para><command>dtdocbook</command> コマンドで生成されるファイルです。これらのファイルは、ヘルプ・システムを使用するユーザに配布されます。
</para>
</glossdef>
</glossentry>
<glossentry><glossterm>実行別名</glossterm>
<glossdef>
<para>実行リンクが実行するコマンド文字列またはスクリプトへ名前を割り当てるリソースです。
</para>
</glossdef>
</glossentry>
<glossentry><glossterm>実行ポリシー</glossterm>
<glossdef>
<para>ヘルプ・システムが提供するリソースで、実行リンクの動作を制御するときに設定することができます。システム管理者またはユーザが、指定されたアプリケーションに対して、適切なセキュリティ・レベルを確立できるようにします。
</para>
</glossdef>
</glossentry>
<glossentry><glossterm>実行リンク</glossterm>
<glossdef>
<para>シェル・コマンドまたはシェル・スクリプトを実行するハイパーリンクです。DocBook では、OLink 要素がこの機能があります。
</para>
</glossdef>
</glossentry>
<glossentry><glossterm>自動ヘルプ</glossterm>
<glossdef>
<para>特定の条件またはエラーが生じると、システムがヘルプを表示します。「システム起動」ヘルプと呼ばれることもあります。たとえば、エラー・ダイアログは「自動ヘルプ」の形式です。<emphasis>「半自動ヘルプ」</emphasis>と<emphasis>「手動ヘルプ</emphasis>」も参照してくだざい。
</para>
</glossdef>
</glossentry>
<glossentry><glossterm>手動ヘルプ</glossterm>
<glossdef>
<para>どんなヘルプが必要か、どうすればそれが得られるかを、ユーザがわかっていなければ使用できないオンライン・ヘルプです。たとえば[ヘルプ]メニューのコマンドの大半は、いつ何を表示するかをユーザが選択するので、「手動」ヘルプです。<emphasis>自動ヘルプ</emphasis>と<emphasis>半自動ヘルプ</emphasis>も参照してください。</para>
</glossdef>
</glossentry>
<glossentry><glossterm>新規ウィンドウ表示ハイパーリンク</glossterm>
<glossdef>
<para>選択されると新しいダイアログ・ボックスに情報を表示するハイパーリンクです。新規ウィンドウ表示リンクは、他のボリュームへのリンクを目的としています。ユーザは、新規ウィンドウが表示されることによって「新しいコンテキスト」だとわかります。
</para>
</glossdef>
</glossentry>
<glossentry><glossterm>図</glossterm>
<glossdef>
<para>ヘルプ情報で表示されるグラフィックまたはイラストです。
</para>
</glossdef>
</glossentry>
<glossentry><glossterm>スタンドアロン・ヘルプ</glossterm>
<glossdef>
<para>アプリケーション・ソフトウェアとは無関係に使用されるヘルプ情報です。たとえば、コンピュータ・プログラミングの基本を説明するオンライン・ヘルプは、特定のアプリケーションに関連付けられてはいません。スタンドアロン・ヘルプ・ボリュームは、<command>dthelpview</command> コマンドを使用して表示することができます。</para>
</glossdef>
</glossentry>
<glossentry><glossterm>正規マークアップ</glossterm>
<glossdef>
<para>DocBook 2.2.1 文書型定義 (DTD) において規定されるタグのセットおよび適合使用規則です。DTD で設定された規則にしたがうことによって、設計者は SGML (Standard Generalized Markup Language) に準拠したヘルプ・ソース・ファイルを作成することができます。
</para>
</glossdef>
</glossentry>
<glossentry><glossterm>ダイアログ・キャッシュ</glossterm>
<glossdef>
<para>作成されても使用されていないヘルプ・ダイアログのリストです。アプリケーションは、新しいヘルプ・ダイアログを必要とする場合、まずダイアログ・キャッシュに未使用のダイアログがないかどうか検索します。みつかればそれを使用し、みつからない場合は、すべてのダイアログが使用中ということであり、新しいダイアログを作成します。
</para>
</glossdef>
</glossentry>
<glossentry><glossterm>タグ</glossterm>
<glossdef>
<para>要素の開始と終了をマークするテキスト文字列です。開始タグは、&lt; (左三角括弧)、それに続く特別な文字列(文字のみを含みます)、オプションの属性と値、および終了を示す > (右三角括弧) から成ります。</para>
<para>終了タグは、&lt; (左三角括弧)、/ (順スラッシュ)、同じ特別な文字列、および > (右三角括弧) から成ります。</para>
</glossdef>
</glossentry>
<glossentry><glossterm>注 (note)</glossterm>
<glossdef>
<para>ユーザに注意してほしい重要な情報であることを示します。情報の内容が特に重大な場合は、代わりに注意 (caution) や警告 (warning) が使われます。<emphasis>注意 (caution)</emphasis>と<emphasis>警告 (warning)</emphasis>も参照してください。
</para>
</glossdef>
</glossentry>
<glossentry><glossterm>注意</glossterm>
<glossdef>
<para>データが失われるおそれがあることをユーザに知らせる警告です。<emphasis>注</emphasis>と<emphasis>警告</emphasis>も参照してください。</para>
</glossdef>
</glossentry>
<glossentry><glossterm>登録</glossterm>
<glossdef>
<para>ヘルプ・ボリュームが、ブラウズや他のボリュームへのリンクに関して、にアクセス可能であることを宣言する過程です。
</para>
</glossdef>
</glossentry>
<glossentry><glossterm>トピック</glossterm>
<glossdef>
<para>特定の主題に関する情報です。通常、これは約1画面分の情報です。オンライン・ヘルプのトピックは、ハイパーリンクによって互いにリンクされています。
</para>
</glossdef>
</glossentry>
<glossentry><glossterm>トピック階層</glossterm>
<glossdef>
<para>ホーム・トピックが(ハイパーリンクによって)だんだん詳細なトピックに分岐していく、ヘルプ・ボリュームの分岐構造です。<emphasis>ホーム・トピック</emphasis>も参照してください。
</para>
</glossdef>
</glossentry>
<glossentry><glossterm>トピック・ツリー</glossterm>
<glossdef>
<para>一般ヘルプ・ダイアログ・ボックスで、ヘルプ情報を表示するために選択できるトピックのリストです。
</para>
</glossdef>
</glossentry>
<glossentry><glossterm>パーサ</glossterm>
<glossdef>
<para>DocBook ソフトウェアの一部であり、(設計者が作成した)ソース・ファイルを読み取り、ヘルプ・システム・ダイアログが読み取れる実行時のヘルプ・ファイルに変換します。設計者がマークアップを不正確に(または不完全に)使用した場合、パーサは障害を検出して「パーサ・エラー」の発生を通知します。
</para>
</glossdef>
</glossentry>
<glossentry><glossterm>ハイパーリンク</glossterm>
<glossdef>
<para>テキスト(単語または語句)のセグメント、あるいはそれに対応する動作を示すグラフィック・イメージです。もっとも典型的なハイパーリンクは、関連するトピックにつながる「ジャンプ」リンクです。ユーザがジャンプ・リンクを選択すると、関連するトピックが表示されます。また、他の動作、つまりシステム・コマンドの実行や特定のアプリケーションの呼び出しなどを起動することもできます。
</para>
</glossdef>
</glossentry>
<glossentry><glossterm>ハイパーリンク・コールバック</glossterm>
<glossdef>
<para>ユーザがハイパーリンクを選択したときに呼び出されるアプリケーションの関数です。ヘルプ・ダイアログで自動的に処理されないタイプのハイパーリンクを処理します。
</para>
</glossdef>
</glossentry>
<glossentry><glossterm>半自動ヘルプ</glossterm>
<glossdef>
<para>ユーザがヘルプを要求すると、システムが現在の状況に応じてどのヘルプ情報を表示するかを決定する形式のオンライン・ヘルプです。「コンテキスト・ヘルプ」([F1]キーを押します)は、半自動ヘルプの一例です。<emphasis>自動ヘルプ</emphasis>と<emphasis>手動ヘルプ</emphasis>を参照してください。
</para>
</glossdef>
</glossentry>
<glossentry><glossterm>ヒストリ・ダイアログ・ボックス</glossterm>
<glossdef>
<para>ユーザが使用したトピックを順にリスト表示するダイアログ・ボックスです。ヒストリの順序は、ユーザが最初に使用したトピックに戻りやすくするために、逆の順序で表示することもできます。
</para>
</glossdef>
</glossentry>
<glossentry><glossterm>文書型定義 DTD (Document Type Definition)</glossterm>
<glossdef>
<para>構造化(または階層)情報を作成するために使用する一連の要素の記述です。文書型定義は、各要素の構文を規定し、ドキュメントにおける要素の使用方法と使用場所を管理します。
</para>
</glossdef>
</glossentry>
<glossentry><glossterm>ヘルプ・キー</glossterm>
<glossdef>
<para>通常は[F1]ファンクション・キーですが、現在のコンテキストのヘルプを要求するためのキーです。[F1]キーに代わる[ヘルプ]キーが用意されているキーボードもあります。Motif アプリケーションでは、ウィジェットにヘルプ・コールバックを追加すると、ヘルプ・キーが使用可能になります。
</para>
</glossdef>
</glossentry>
<glossentry><glossterm>ヘルプ・コールバック</glossterm>
<glossdef>
<para>ユーザが[F1]キーを押したときに呼び出されるアプリケーションの関数です。
</para>
</glossdef>
</glossentry>
<glossentry><glossterm>ヘルプの使い方</glossterm>
<glossdef>
<para>ヘルプ・ダイアログ・ボックスの使用方法を説明したヘルプ情報です。ヘルプ・ウィンドウを使用しているときは[F1]キーを押すことにより、または一般のヘルプ・ダイアログ・ボックスで[ヘルプ]メニューから[ヘルプの使い方]を選択することにより、この情報を取得できます。
</para>
</glossdef>
</glossentry>
<glossentry><glossterm>ヘルプ・ファミリ</glossterm>
<glossdef>
<para>参照するアプリケーションが関連している一連のヘルプ・ボリュームです。
</para>
</glossdef>
</glossentry>
<glossentry><glossterm>ヘルプ・ボリューム</glossterm>
<glossdef>
<para>主題に関する完全な情報です。また、マークアップ・テキストを含む一連のソース・ファイルまたは DocBook を使用することによって生成される実行時のヘルプ・ファイルのいずれかを指すこともあります。
</para>
</glossdef>
</glossentry>
<glossentry><glossterm>他のボリュームへのハイパーリンク</glossterm>
<glossdef>
<para>他のヘルプ・ボリュームのトピックにジャンプするハイパーリンクです。これは、 Link 要素で入力できます。ここで Linkend 属性がリンクされる要素のIDを指定します。
</para>
<programlisting>&lt;link lnkend="some-id">&lt;/link></programlisting>
</glossdef>
</glossentry>
<glossentry><glossterm>マニュアル・ページへのリンク</glossterm>
<glossdef>
<para>起動されると「マニュアル・ページ」を表示するハイパーリンクです。マニュアル・ページとは、システム・コマンドについてのオンラインの簡潔な説明です。マニュアル・ページ上の情報は、DocBook システムでは提供されません。
</para>
</glossdef>
</glossentry>
<glossentry><glossterm>要素</glossterm>
<glossdef>
<para>本のタイトル、段落、リスト、またはトピックなど、情報の論理部分です。一部の要素のタグは、コンテキストによって仮定されますが、通常、要素の範囲は<emphasis>タグ</emphasis>によってマークされます。
</para>
</glossdef>
</glossentry>
<glossentry><glossterm>例表示</glossterm>
<glossdef>
<para>改行がそのまま維持され、コンピュータのフォントで表示されるテキストの本文です。一般には、コンピュータ・ファイルの一部の例です。
</para>
</glossdef>
</glossentry>
</glossary>
<!--fickle 1.14 mif-to-docbook 1.7 01/02/96 16:48:20-->

View File

@@ -0,0 +1,10 @@
<!-- $XConsortium: part1.sgm /main/1 1996/01/23 18:29:12 vobadm $ -->
<!-- (c) Copyright 1995 Digital Equipment Corporation. -->
<!-- (c) Copyright 1995 Hewlett-Packard Company. -->
<!-- (c) Copyright 1995 International Business Machines Corp. -->
<!-- (c) Copyright 1995 Sun Microsystems, Inc. -->
<!-- (c) Copyright 1995 Novell, Inc. -->
<!-- (c) Copyright 1995 FUJITSU LIMITED. -->
<!-- (c) Copyright 1995 Hitachi. -->
<Title>³µÍ×</Title>
<!--fickle 1.14 mif-to-docbook 1.7 01/02/96 16:48:20-->

View File

@@ -0,0 +1,10 @@
<!-- $XConsortium: part2.sgm /main/1 1996/01/23 18:29:40 vobadm $ -->
<!-- (c) Copyright 1995 Digital Equipment Corporation. -->
<!-- (c) Copyright 1995 Hewlett-Packard Company. -->
<!-- (c) Copyright 1995 International Business Machines Corp. -->
<!-- (c) Copyright 1995 Sun Microsystems, Inc. -->
<!-- (c) Copyright 1995 Novell, Inc. -->
<!-- (c) Copyright 1995 FUJITSU LIMITED. -->
<!-- (c) Copyright 1995 Hitachi. -->
<Title>設計者が行う作業</Title>
<!--fickle 1.14 mif-to-docbook 1.7 01/02/96 16:48:20-->

View File

@@ -0,0 +1,10 @@
<!-- $XConsortium: part3.sgm /main/1 1996/01/23 18:30:08 vobadm $ -->
<!-- (c) Copyright 1995 Digital Equipment Corporation. -->
<!-- (c) Copyright 1995 Hewlett-Packard Company. -->
<!-- (c) Copyright 1995 International Business Machines Corp. -->
<!-- (c) Copyright 1995 Sun Microsystems, Inc. -->
<!-- (c) Copyright 1995 Novell, Inc. -->
<!-- (c) Copyright 1995 FUJITSU LIMITED. -->
<!-- (c) Copyright 1995 Hitachi. -->
<Title>¥×¥í¥°¥é¥Þ¤¬¹Ô¤¦ºî¶È</Title>
<!--fickle 1.14 mif-to-docbook 1.7 01/02/96 16:48:20-->

View File

@@ -0,0 +1,10 @@
<!-- $XConsortium: part4.sgm /main/1 1996/01/23 18:30:35 vobadm $ -->
<!-- (c) Copyright 1995 Digital Equipment Corporation. -->
<!-- (c) Copyright 1995 Hewlett-Packard Company. -->
<!-- (c) Copyright 1995 International Business Machines Corp. -->
<!-- (c) Copyright 1995 Sun Microsystems, Inc. -->
<!-- (c) Copyright 1995 Novell, Inc. -->
<!-- (c) Copyright 1995 FUJITSU LIMITED. -->
<!-- (c) Copyright 1995 Hitachi. -->
<Title>¹ñºÝ²½Âбþ</Title>
<!--fickle 1.14 mif-to-docbook 1.7 01/02/96 16:48:20-->

View File

@@ -0,0 +1,150 @@
<!-- $XConsortium: preface.sgm /main/12 1996/09/08 19:41:20 rws $ -->
<!-- (c) Copyright 1995 Digital Equipment Corporation. -->
<!-- (c) Copyright 1995 Hewlett-Packard Company. -->
<!-- (c) Copyright 1995 International Business Machines Corp. -->
<!-- (c) Copyright 1995 Sun Microsystems, Inc. -->
<!-- (c) Copyright 1995 Novell, Inc. -->
<!-- (c) Copyright 1995 FUJITSU LIMITED. -->
<!-- (c) Copyright 1995 Hitachi. -->
<preface id="HRDC.Pref.div.1">
<title>はじめに</title>
<para>このマニュアルでは、共通デスクトップ環境アプリケーション・ソフトウェアのオンライン・ヘルプの開発方法について説明します。ヘルプ・トピックの作成方法や、オンライン・ヘルプを Motif&trade;アプリケーションに統合する方法についても説明します。
</para>
<sect1 id="HRDC.Pref.div.2">
<title>対象読者</title>
<para>このマニュアルの対象読者は、次のとおりです。
</para>
<itemizedlist remap="Bullet1"><listitem><para>オンライン・ヘルプ情報を設計、作成、検証する設計者
</para>
</listitem><listitem><para>完全なヘルプ機能を備えたソフトウェア・アプリケーションの作成を目的としている開発者
</para>
</listitem></itemizedlist>
</sect1>
<sect1 id="HRDC.Pref.div.3">
<title>このマニュアルの構成</title>
<para>このマニュアルは4部から構成されています。第1部「概要」では、アプリケーション・ヘルプの設計段階で必要な設計者と開発者の協力と役割について述べます。第2部「設計者が行う作業」では、オンライン・ヘルプを構成し記述する設計者に必要な情報を提供します。第3部「プログラマが行う作業」では、ヘルプ・システムのアプリケーション・プログラマのツールキットを説明します。第4部「国際化対応」では、多言語環境でオンライン・ヘルプを使用する場合に、設計者とプログラマの両方に必要な情報を提供します。
</para>
<para>このマニュアルは、次の章から構成されています。</para>
<para>第1部「概要」</para>
<para><!--Original XRef content: 'Chapter&numsp;1, &ldquo;Introducing the
Help System'--><xref role="ChapNumAndTitleLead-in" linkend="HRDC.Intro.mkr.1"><emphasis
role="Lead-in"></emphasis>は、オンライン・ヘルプの作成にあたり、設計者と開発者の協力的な役割について説明します。
</para>
<para>第2部「設計者が行う作業」</para>
<para><literal><!--Literal closed to allow XRef:--></literal> <!--Original
XRef content: 'Chapter&numsp;2, &ldquo;Organizing and Writing a Help Volume'--><xref
role="ChapNumAndTitleLead-in" linkend="HRDC.OrgH.mkr.1"><emphasis role="Lead-in">
</emphasis>は、ヘルプ・ボリュームの構成に必要な要素を説明します。
</para>
<para><!--Original XRef content: 'Chapter&numsp;3, &ldquo;Writing a Help
Topic'--><xref role="ChapNumAndTitleLead-in" linkend="HRDC.WrTop.mkr.1"><emphasis
role="Lead-in"></emphasis>は、ヘルプ・システム・マークアップ言語を概説し、さまざまなタイプの情報をフォーマットするのに使用する要素の例を示します。グラフィックを入れる方法とハイパーリンクの作成についても説明します。
</para>
<para><!--Original XRef content: 'Chapter&numsp;4, &ldquo;Processing and
Displaying a Help Volume'--><xref role="ChapNumAndTitleLead-in" linkend="HRDC.CrHV.mkr.1"><emphasis
role="Lead-in"></emphasis>は、ひとつまたは複数のマークアップ・ファイルを処理して、オンライン表示を行うための実行時のファイルを生成する方法を説明します。
</para>
<para><citetitle>共通デスクトップ環境 DocBook 文書型定義ガイド</citetitle><?Pub Caret>は、アルファベット順にDocBookマークアップ言語の要素を列挙し、それらの使用方法について説明しています。
</para>
<para><!--Original XRef content: 'Chapter&numsp;6, &ldquo;Summary of Special
Character Entities'--><xref role="ChapNumAndTitleLead-in" linkend="HRDC.ChEnt.mkr.1"><emphasis
role="Lead-in"></emphasis>は、特殊文字をヘルプ・トピックのテキストに入力するのに使用する文字と、それに対応するエンティティ名のリストを示します。
</para>
<para><!--Original XRef content: 'Chapter&numsp;7, &ldquo;Command Summary'--><xref
role="ChapNumAndTitleLead-in" linkend="HRDC.CmdS.mkr.1"><emphasis role="Lead-in">
</emphasis>端末エミュレータ・ウィンドウにコマンドを入力して、ヘルプ・ボリュームを処理および表示する方法を要約します。
</para>
<para><!--Original XRef content: 'Chapter&numsp;8, &ldquo;Reading the DocBook
Document Type Definition'--><xref role="ChapNumAndTitleLead-in" linkend="HRDC.Sgml.mkr.1"><emphasis
role="Lead-in"></emphasis>は、DocBook DTD (文書型定義)の概要と、それを利用して完全に SGML (Standard Generalized Markup Language) に準拠するヘルプ・ファイルを作成する方法を説明します。
</para>
<para>第3部「プログラマが行う作業」</para>
<para><!--Original XRef content: 'Chapter&numsp;9, &ldquo;Creating and Managing
Help Dialog Boxes'--><xref role="ChapNumAndTitleLead-in" linkend="HRDC.CrDia.mkr.1"><emphasis
role="Lead-in"></emphasis>は、ヘルプ・ダイアログ・ウィジェットの概要と使い方を説明します。
</para>
<para><!--Original XRef content: 'Chapter&numsp;10, &ldquo;Responding to
Help Requests'--><xref role="ChapNumAndTitleLead-in" linkend="HRDC.HReq.mkr.1"><emphasis
role="Lead-in"></emphasis>, explains how an application provides entry points
to access different types of help.</para>
<para><!--Original XRef content: 'Chapter&numsp;11, &ldquo;Handling Events
in Help Dialogs'--><xref role="ChapNumAndTitleLead-in" linkend="HRDC.DiaEv.mkr.1"><emphasis
role="Lead-in"></emphasis>は、コールバック構造を使用して、ハイパーリンク・イベントを処理する方法を示します。
</para>
<para><!--Original XRef content: 'Chapter&numsp;12, &ldquo;Providing Help
on Help'--><xref role="ChapNumAndTitleLead-in" linkend="HRDC.H4Hlp.mkr.1"><emphasis
role="Lead-in"></emphasis>は、ユーザにヘルプ・システムの使い方を示すヘルプ・モジュールの作成方法を説明します。
</para>
<para><literal><!--Literal closed to allow XRef:--></literal> <!--Original
XRef content: 'Chapter&numsp;13, &ldquo;Preparing an Installation Package'--><xref
role="ChapNumAndTitleLead-in" linkend="HRDC.Inst.mkr.1"><emphasis role="Lead-in">
</emphasis>は、アプリケーションでオンライン・ヘルプを提供するために、インストール・パッケージに含まれているものについて説明します。
</para>
<para>第4部「国際化対応」</para>
<para><!--Original XRef content: 'Chapter&numsp;14, &ldquo;Native Language
Support'--><xref role="ChapNumAndTitleLead-in" linkend="HRDC.Lang.mkr.1"><emphasis
role="Lead-in"></emphasis>は、ヘルプ・システムで使用する言語依存ファイルを示します。
</para>
<para><emphasis role="Lead-in">用語集</emphasis>は、このマニュアルに出てくる語句とその定義のリストです。
</para>
</sect1>
<sect1 id="HRDC.Pref.div.4">
<title>関連文書</title>
<para>関連する「共通デスクトップ環境」の文書を、以下に示します。
</para>
<itemizedlist remap="Bullet1"><listitem><para><citetitle>共通デスクトップ環境 上級ユーザおよびシステム管理者ガイド
</citetitle></para>
</listitem><listitem><para><citetitle>共通デスクトップ環境 国際化対応プログラマーズ・ガイド
</citetitle></para>
</listitem><listitem><para><citetitle>CDE/Motif スタイル・ガイドおよび認証チェックリスト
</citetitle></para>
</listitem><listitem><para><citetitle>共通デスクトップ環境 ユーザーズ・ガイド</citetitle></para>
</listitem><listitem><para><citetitle>共通デスクトップ環境 DocBook 文書型定義ガイド</citetitle></para>
</listitem></itemizedlist>
<para>SGML (Standard Generalized Markup Language) の技術的な説明については、次の文書を参照してください。
</para>
<itemizedlist remap="Bullet1"><listitem><para><citetitle>The SGML Handbook</citetitle> by Charles F. Goldfarb, Oxford University Press (ISBN 0-19-853737-9).
</para>
</listitem></itemizedlist>
</sect1>
<sect1 id="HRDC.Pref.div.5">
<title>表記上の規則</title>
<para>次の表に、このマニュアルで使用する表記上の規則を示します。
</para>
<table id="HRDC.Pref.tbl.1" frame="Topbot">
<title>表記上の規則</title>
<tgroup cols="3" colsep="0" rowsep="0">
<colspec colwidth="1.21in">
<colspec colwidth="1.77in">
<colspec colwidth="3.04in">
<thead>
<row><entry align="left" valign="bottom"><para><literal>文字または記号</literal></para></entry><entry align="left" valign="bottom"><para><literal>意味</literal></para></entry><entry align="left" valign="bottom"><para><literal>使用例</literal></para></entry></row></thead>
<tbody>
<row>
<entry align="left" valign="top"><para><filename>AaBbCc123</filename></para></entry>
<entry align="left" valign="top"><para>コマンド、ファイル、ディレクトリの名前、画面の出力表示
</para></entry>
<entry align="left" valign="top"><para><filename>.login</filename>ファイルを編集します。
</para><para><command>ls -a</command>を使用してすべてのファイルをリストします。
</para><para><command>system%</command> <filename moreinfo="RefEntry">You have mail.</filename></para></entry>
</row>
<row>
<entry align="left" valign="top"><para><emphasis>AaBbCc123</emphasis></para></entry>
<entry align="left" valign="top"><para>変数を示します。</para><para>実際に使用する特定の名前または値で置き換えます。
</para></entry>
<entry align="left" valign="top"><para>ファイルを削除するには、<command>rm</command> <userinput> </userinput><symbol role="Variable">filename</symbol>を入力します。</para></entry>
</row>
<row>
<entry align="left" valign="top"><para><emphasis>AaBbCc123</emphasis></para></entry>
<entry align="left" valign="top"><para>文書名、新規の語句または用語、および強調すべき語句を示します。
</para></entry>
<entry align="left" valign="top"><para><emphasis>共通デスクトップ環境 ユーザーズ・ガイド
</emphasis><userinput></userinput>を参照してください。
これらは、<symbol role="Variable">class</symbol>オプションと呼ばれます。
これを行うには、<emphasis>rootでなければなりません</emphasis>。
</para></entry>
</row></tbody></tgroup></table>
</sect1>
</preface>
<!--fickle 1.14 mif-to-docbook 1.7 01/02/96 16:48:20-->
<?Pub *0000014819>