アジョブジ星通信

日常系バンザイ。

Sandcastle Help File BuilderのMAML初級

前回の続きです。昼間のustでやったことのまとめです。初歩的なことすらわかってませんが日本語情報がないので書きます。

Content Layoutファイルを作る

プロジェクトを右クリックして[Add]→[New Item]→[Content Layout]で拡張子.contentファイルを適当なところ(プロジェクトと同じフォルダが無難)に保存します。このファイルは自作ページをまとめるファイルのようです。

自作ページを作る

ContentLayoutファイルをProjectExplorerでダブルクリックすると新しい子ウィンドウが表示されるはずです。SHFBではContent Layout Editor Windowと呼んでるらしい。Find IDの下のListBoxで右クリックして[Add Sibling Topic]→[Standard Templates]→[Conceptual]で拡張子.amlファイルを保存します。これがXMLを拡張したMAMLと呼ばれるものらしいです。このファイルを編集してページを作ります。

サンプル

<?xml version="1.0" encoding="utf-8"?>
<topic id="80af5af4-1fe1-4d1b-9fab-8f2d680f91c6" revisionNumber="1">
  <developerConceptualDocument xmlns="http://ddue.schemas.microsoft.com/authoring/2003/5" xmlns:xlink="http://www.w3.org/1999/xlink">
    <introduction>
      <para>冒頭に表示されます。</para>
    </introduction>
    <section>
      <title>セクション1(省略可)</title>
      <content>
        <para>内容</para>
      </content>
    </section>
  </developerConceptualDocument>
</topic>

動くかどうかなんて知りません(未検証の言訳)。SHFBのソースコードに入ってるヘルプのソースが一番参考になるかと。
大体の構造は見ればわかりますよね(だんだんテキトーになってきた)。introductionが冒頭でsectionが中身です。sectionタグをたくさん置けば中身を分けることもできます。paraが文字のようです。ほかにも使えるタグはあるのですがこれくらいしかわかってないので説明しません。
「タイトルを設定するタグがないじゃないか!」
これはContentLayoutEditorで設定します。下のPropertyGridのTitleという項目を編集してください。

自作ページをトップページに設定する

これは簡単です。トップページにしたいトピックを選んでContentLayoutEditorの左上にあるチェックをクリックするだけです。

結論:SHFBのヘルプの日本語版落ちてないかな…。

ではまた