概観 - ユーザドメインにおけるファイルが内蔵の振舞いと優越するか、または一助となるのを持ちながら、ヘルプシステムをカスタム設計するのは存します。 したがって、下のすべての経路が以下に比例してあります。
ツ????長さのクラス="minigray">/Users/<ログイン>/Library/Application support/Smile/ - 以下に言及されたというわけではないすべてのフォルダーがデフォルトで存在しています: あなたはそれらのいくつかを作成しなければならないかもしれません。
- 以下での各操作のために、私たちは、あなたがモデルとしてアプリケーションのフォルダーで Moreもの/ドキュメンテーションもの/ディレクトリのファイルを使用するのを勧めます。
- ヘルプシステムをカスタム設計すると、1番目は、 補助的なヘルプリソースを提供するために含意されます。 次の章はユーザには自動的に利用可能な状態でしたがって、どうそのような新しいリソースをそれらがある提供するかを説明します、 ヘルプ>Documentationメニューで。以下のもう1つの章はそれらのリソースをまた、 文脈上のメニューで利用可能にする方法を説明します。最終的に、最後の章はヘルプシステムへの ユーザのアクセスをカスタマイズする方法を説明します: 例えば、あなたは助けの範囲をあなたのアプリケーションに特定の項目に制限したがっているかもしれません。
- あなたが以下で説明されるようにヘルプシステムに関連する何らかの新しいファイルをインストールした後に、あなたの変化をテストするのを試みる前に、 ヘルプシステムをリセットしてください。 ヘルプシステムをリセットするには、⌥と ヘルプ>Documentationを選択してください。 キーは押されました。
補助的なヘルプリソースを提供します。 - ヘルプシステムは以下の種類に関するリソースを扱います:
- あなたが ヘルプメニューにインストールすることができるのに 原稿を書きます。
- テキストヘルプファイルか特定のツールのための速いユーザガイド。(ヘルプファイルは例えば与えられたライブラリのコマンドの速い概要を提供します)。
- ローカルのハイパーテキストページ、ユーザのコンピュータで位置するhtmlファイル
- Satimage-ソフトウェアのサイトのハイパーテキストページ、より最新の情報を含むかもしれないウェブに位置するhtmlファイル
- PDFドキュメント
- リンク、ウェブに関する他の位置かリソースへのURL
あなたはSatimage-ソフトウェアのサイトの新しいファイル以外のどんな種類の新しいリソースもインストールすることができます。 - 追加商品を ヘルプメニューにインストールするために、以下でファイル(通常スクリプト、あなただけがまた、テキストファイルか対話をインストールすることができる)をどんな入れ子のレベルにもインストールします。
ツ????長さのクラス="minigray">より多くのstuff/Documentation/ 規則は User Scriptsメニューのように同じです。 - 追加 テキストヘルプファイルをインストールするために、以下にそれをコピーしてください。
ツ????長さのクラス="minigray">より多くのもの/ドキュメンテーションstuff/en/text/ 新しいテキストファイルの名前は Smileヘルプページからクリック可能な Textヘルプファイルページで目立つでしょう。 - 追加ローカルのハイパーテキストページをインストールするために、それをindex.htmlと命名してください、そして、フォルダーにそれ(ことによると他のファイルがある)を同封してください、そして、以下にそのフォルダーをコピーしてください。
ツ????長さのクラス="minigray">より多くのもの/ドキュメンテーションstuff/en/html/ 望ましくは、htmlのヘッダーの <タイトル>[ここのページタイトル]</タイトル>などの線を含めてください。 新しいハイパーテキストファイルの名前は Smileヘルプページからクリック可能な ハイパーテキストドキュメンテーションページで目立つでしょう。 - 追加 PDFドキュメントをインストールするために、以下にそれをコピーしてください。
ツ????長さのクラス="minigray">ドキュメンテーション/ 新しいPDFファイルの名前は Smileヘルプページからクリック可能な PDFドキュメンテーションページで目立つでしょう。 - 追加リンクをインストールするために、 リンクというファイルを以下にインストールしてください。
ツ????長さのクラス="minigray">_より多くのもの/ドキュメンテーションもの/en/Smile助け_toc/ 以下(あなたが括弧の間のすべての言及を適合させなければならないところ)のモデルに従って、ファイルは1かいくつかのブロックを入れてあるべきです。<li> 「<b><a href=」[リンクのURL]「>[リンクに表示されたテキスト]</a></b>」 <dd> [リンクのための記述] 新しいリンクは Smileヘルプページからクリック可能な Linksページで目立つでしょう。 文脈上の援助メニューをカスタム設計します。追加のドキュメンテーションを提供するか、または上で説明されるようにリソースを助けるなら、あなたは、それらに文脈上のメニューで利用可能であって欲しいことができます。 この趣旨で、 .plist拡張子が以下にある状態で、ファイルとしてp-リストをインストールしてください。 ツ????長さのクラス="minigray">より多くのもの/ドキュメンテーションstuff/en/indexes/ p-リストは辞書であるべきです。 文脈上のメニューを持つために、与えられた用語(例えば、コマンド、または特定のキーワード)を認識してください、そして、キーとしてその用語で主要な値の組をp-リストにインストールしてください。 値は任意の主要な値の3組がある辞書自体であるべきです:(そこでは、キーがそうです)。 概要(テキストヘルプファイルを開くための)。(そこでは、 地方の_はhtmlして(ローカルのハイパーテキストドキュメンテーションページを開くために)、 出典を明示して(操作者かライブラリとしてソースを見る)、値はストリングのアレイでなければなりません(AppleScript用語によるリスト))。 - 概要キーの下の各ストリングは以下に比例してテキストヘルプファイルのマッキントッシュ経路であるべきです。
ツ????長さのクラス="minigray">より多くのもの/ドキュメンテーションstuff/en/text/ - 地方の_htmlキーの下の各ストリングは以下に比例してhtmlファイルのマッキントッシュ経路であるべきです。
ツ????長さのクラス="minigray">より多くのもの/ドキュメンテーションstuff/en/html/ - ソースキーの下の各ストリングは以下に比例してスクリプトかテキストファイルのマッキントッシュ経路であるべきです。
ツ????長さのクラス="minigray">クラススクリプト/文脈追加/ ここに、 水泳コマンドを定義するだろう swimlibという架空のライブラリを記録するそのような.plistファイルに関する例があります。<?xmlバージョン=、「=の「UTF-8インチ?」をコード化する1インチ> <!DOCTYPE plist PUBLIC「-//Apple Computer//DTD PLIST1.0//EN」、「 http://www.apple.com/DTDs/PropertyList-1.0.dtd ">" <plistバージョン= 「1インチの>」 <dict> ツ????lt; 主要な>水泳</主要な> ツ????????lt; dict> ツ????????????lt; 主要な>概要</キー> ツ????????????lt; アレイ> ツ????????????????lt; >Howを結んで、</ストリング>を泳いでください。 ツ????????????lt; /アレイ> ツ????????????lt; 主要な>地方の_html</キー> ツ????????????lt; アレイ> ツ????????????????lt; ストリング>SwimLib: index.html</ストリング> ツ????????????????lt; ストリング>SwimLib: 主な_commands.html</ストリング> ツ????????????lt; /アレイ> ツ????????lt; /dict> ツ????lt; 主要な>水泳</主要な> ツ????????lt; dict> ツ????????????lt; 主要な>概要</キー> ツ????????????lt; アレイ> ツ????????????????lt; >Howを結んで、</ストリング>を泳いでください。 ツ????????????lt; /アレイ> ツ????????????lt; 主要な>地方の_html</キー> ツ????????????lt; アレイ> ツ????????????????lt; ストリング>SwimLib: 主な_commands.html</ストリング> ツ????????????lt; /アレイ> ツ????????????lt; 主要な>ソース</主要な> ツ????????????lt; アレイ> ツ????????????????lt; ストリング>swimlib</ストリング> ツ????????????lt; /アレイ> ツ????????lt; /dict> </dict> </plist> SmileのためのAppleScriptライブラリの作者であるなら、あなたはライブラリに、私たちが自動的に索引ファイルを作って、インストールするために以下に提供する指示とスクリプトを使用することができます。 また、指示はヘルプシステムと共にあなたのライブラリをどう分配するかを提示します。 ライブラリに索引をつけるための輸入スクリプト ヘルプシステムへのユーザのアクセスをカスタマイズします。 - ユーザが ヘルプ>Documentationを選択するとき、Smileが開くページをカスタム設計するために、 Smile_help.htmlというhtmlファイルを以下にインストールしてください。
ツ????長さのクラス="minigray">より多くのもの/ドキュメンテーションstuff/en/html/ また、ページでリンクを変えないなら、あなたは _Smile_助けhtml.html、 _Smile_助けtext.html、 _Smile_助けpdf.html、および _Smile_助けlinks.htmlという同じフォルダーファイルにインストールするべきです。 - ハイパーテキストドキュメンテーションページがデフォルトで表示するリストをカスタム設計するために、 htmlというファイルを以下にインストールしてください。
ツ????長さのクラス="minigray">_より多くのもの/ドキュメンテーションもの/en/Smile助け_toc/ ファイルはリターンで切り離された線として構造化されます。 各線は以下に比例してテキストファイルのマッキントッシュ経路を含むべきです。 ツ????長さのクラス="minigray">より多くのもの/ドキュメンテーションstuff/en/html/ そして、タブによって切り離されたファイルのための短い記述。 htmlのヘッダーが <タイトル>[ここのページタイトル]</タイトル>線を入れると、 ハイパーテキストドキュメンテーションページは、ページへのリンクに表示するのにテキストとしてページタイトルを使用するでしょう。 - Textヘルプファイルページがデフォルトで表示するリストをカスタム設計するために、 テキストというファイルを以下にインストールしてください。
ツ????長さのクラス="minigray">_より多くのもの/ドキュメンテーションもの/en/Smile助け_toc/ ファイルはリターンで切り離された線として構造化されます。 各線は以下に比例してテキストファイルのマッキントッシュ経路を含むべきです。 ツ????長さのクラス="minigray">より多くのもの/ドキュメンテーションstuff/en/text/ そして、タブによって切り離されたファイルのための短い記述。 人影のない線は Textヘルプファイルページの線スペースを加えるでしょう。 - PDFドキュメンテーションページがデフォルトで表示するリストをカスタム設計するために、 pdfというファイルを以下にインストールしてください。
ツ????長さのクラス="minigray">_より多くのもの/ドキュメンテーションもの/en/Smile助け_toc/ ファイルはリターンで切り離された線として構造化されます。 各線は以下に比例してpdfファイルのマッキントッシュ経路を含むべきです。 ツ????長さのクラス="minigray">ドキュメンテーション/ そして、タブによって切り離されたファイルのための短い記述。 人影のない線は PDFドキュメンテーションページの線スペースを加えるでしょう。 'Smile:'リンクをハイパーテキスト(html)ページにインストールします。'Smile: 'URL計画(「議定書を作る」)は、ユーザがウェブページをリンクをクリックするとき、あなたがウェブページに埋め込まれたスクリプトを輸入するか、またはドキュメンテーションファイル(テキスト、PDFまたはhtml)を自動的に、開かせるのを可能にします。 スクリプトを輸入するとき、スクリプトを自動的にSmileに移して、新しいAppleScript端末に置くか、または前部窓の端まで追加するでしょう。ここに、そのようなリンクを作る指示があります。 あなたはそのようなリンクをウェブページ、例えば、またはメールに埋め込みたがっているかもしれません。 - 'Smile: 'URLは以下のひもで始まるはずです: Smile:(メールでは、コロン: Smile://の後に二重スラッシュを追加してください。)
- URLの残りは、キーと各キーの前の主要な値の組の系列と、各値の前の =です :
: key1=value1とkey2=value2をSmileんで示してください。 - 方法キーが必要です。
方法のための有効値は以下の通りです。 輸入、 importswは helptextに helppdf、および helphtmlを 追加します。 - 方法=輸入は2個の任意のキーを含意します: ヘッダー、 wname、および1個の必要なキー: src。
- ヘッダーのための有効値は以下の通りです。 いいえ、 std、 リブ、 objは 立ち並んでいます。
- wnameのための値はどんなストリングであるかもしれません。
- srcのための値はbase64としてコード化されたテキストでなければなりません( タイプされたコマンドなしでSmileのencode64[…]を使用してください)。
- 方法=輸入は srcでSmileの新しい窓にコード化されたテキストを輸入するでしょう。
ヘッダーが ヘッダーが ノーでないなら、テキストを前に置く、どうスクリプトを使用するか:(テキストは簡潔に命令されます)。 正常なスクリプトには、 stdを使用してください、そして、ライブラリに、 リブを使用してください、そして、スクリプトとして物に供給されるのが意図されたスクリプトに objを使用してください、そして、スクリプトが1行ずつ使用を走らせるように、 立ち並んでください。 wnameは新しいAppleScript端末に名前として使用されます。以下のhtmlは以下をリンクさせるでしょう: クリック可能な例。<a href=「: 方法=輸入をSmileんで示してください。そうすれば、例のwname=%20for%20Smile%20schemeとヘッダー=はstdします」。 src=ZGxlMgAAAABURVhUAAAAFmRkKCJhaW4ndCB0aGF0IGNvb2w/ Iik=「>のクリック可能な例の</a>」 - 方法=importswは新しいスクリプトウィンドウへのその importsw輸入以外の 輸入に似ています。 importswは ヘッダー情報を使用しません。
- =が追加する方法は、1個の必要なキー、 srcを扱って、 srcを現在、アクティブウィンドウに追加します。
- helptext、 helppdf、または方法= helphtmlが以下のことのために、それぞれ、1個の必要なキー、 ファイル、ファイル親類のMac経路(ストリングとしての)を扱います。
- より多くのもの/ドキュメンテーションもの/<ユーザ言語>/text/
- ドキュメンテーション/<ユーザ言語>/pdf/
- より多くのもの/ドキュメンテーションもの/<ユーザ言語>/html/
これらのフォルダーが以下の位置のどちらかにあるかもしれません。 - /Application/Smilexyz/(xyz: バージョン番号)
- /Users/<ログイン>/Library/Application support/Smile/
- /Library/Application support/Smile/
helptext、 helppdf、または方法= helphtmlはSmile、ユーザのデフォルトpdfビューアーのPDFファイルの中でそれぞれテキストファイルを開くか、またはユーザのデフォルトブラウザでhmtlファイルを開きます。 <ユーザ言語>フォルダーでファイルを見つけないなら、彼らは enで再試行します。「 escapeURL(」 %への空間を20インチなどにする)と共にあなたのURLをコード化しているほうがよいです。以下のhtmlは以下をリンクさせるでしょう: クリック可能な例。<a href=、「helptext&Smile: &方法=ファイル=一般的な%20purpose%20routinesの>のクリック可能な例の「</a>」 |