Help File
About
出力するドキュメントに共通な値の設定を行う項目。重要な項目の方が多い。
- 重要”でない”項目
- ContentPlacement
- NameingMethod
- RootNamespaceContainer
- RootNamespaceTitle
Properties
- ContentPlacement
- About : 良く分からない。
- Value : 初期値「AdoveNamespaces」。後に記述されるコンテンツテーブル中の名前空間の前後に現れる(記述される)、追加や概念的なアイテムを設定する?。要するに追加項目を任意に設定することができるということか…?(TOC=Table of contents)
- CopyrightHref
- About : コピーライト(著作)表記に併設されるURLの設定。
- Value : 初期値「空値」。ページのフッターに表示されるコピーライトのテキストが参照するURLを設定する。
- CopyrightText
- About : コピーライト(著作)表記の設定。
- Value : 初期値「空値」。ページのフッターに表示されるコピーライトの項目に設定したテキストが表示される。
- FeedbackEmailAdress
- About : Feedback(を得るための)メールアドレスの設定。
- Value : 初期値「空値」。各ページのフッターに表示されるメールアドレスの設定。
- FeedbackEmailLinkText
- About : EmailLinkに表示されるテキストの設定。
- Value : 初期値「空値」。出力されるe-mailの項目に表示されるテキストの設定?
- FooterText
- About : フッターに表示するテキストの設定。
- Value : 初期値「空値」。全てのページのフッターに設定したテキストが表示される。
- HeaderText
- About : ヘッダーに表示するテキストの設定。
- Value : 初期値「空値」。全てのページのヘッダーに設定したテキストが表示される。
- HelpTitle
- About : ヘルプファイルのタイトルについて設定する。
- Value : 初期値「A Sandcastle Documented Class Library」。良く分からない。
- HtmlHelpName
- About : HtmlHelpファイルのファイル名を設定する。
- Value : 初期値「Documentaiotn」。HtmlHelp形式でコンパイルされたヘルプファイルの名前を設定する。ファイルパスや拡張子が入らないように設定する必要がある。MSHelp2形式で出力される場合には、コレクションの名前空間:namespaceとしてこの項目が扱われる。
- Language
- About : ドキュメントで利用される主な言語の設定。
- Value : 初期値「英語(米国)」。日本語などを選択することができる。
- NameingMethod
- About : 命名規則の設定?
- Value : 初期値「Guid」。ヘルプ項目のフィある名に使われる命名規則を設定する?
- Preliminary
- About : 暫定的なドキュメントであることを示す設定。
- Value : 初期値「False」。「True」の場合、全てのページのヘッダに「Preliminary documentation」の警告を含める。これは結構使えるかもしれない。
- PresentationStyle
- About : 出力ドキュメントの見た目を設定する。
- Value : 初期値「vs2005」。「hana,Prototype,vs2005」から出力するドキュメントの見た目を選択する。
- RootNamespaceContainer
- About :
- Value : 初期値「False」。
- RootNamespaceTitle
- About : 任意の名前空間を指定できる?
- Value : 初期値「空値」。
- SdkLinkTarget
- About : 良く分からない…。
- Value : 初期値「Blank」。
- SyntaxFilters
- About : 出力するドキュメントが対象とする言語の設定。
- Value : 初期値「Standard」。出力するドキュメントの言語形式を決定する。初期値「Standard」は「VB,C++,C#」向けの出力になっている。CsharpやVB,C++から複数選択できる。