メタデータ

この記事では、WSOFTDocsの記事にメタデータを指定する方法について説明します。

taiseiue | 2022-12-01

WSOFTDocsのメタデータは、OGPタグの生成、SEO対およびサイトの体験を改善する目的で使用します。メタデータは、記事の先頭でYAML形式で記述します。属性では大文字と小文字が区別され、属性と値の間にコロンを使用します。

既存の記事を変数する場合、メタデータを変更する必要はおそらくありません。しかし、新しい記事を追加する場合は、特定のメタデータ値をファイルの先頭に含める必要があります。

Markdown記事の先頭のメタデータの例を次に示します。

Markdown

---
title         : メタデータ
summary       : この記事では、WSOFTDocsの記事にメタデータを指定する方法について説明します。
date          : 2022-12-01
---

次の表に、必ず指定する必要がある項目を示します。これらの項目が不足している場合、適切な項目をこちらが追記したり、入力をお願いするフィードバックを送信する可能性があります。

項目名	指定すべき値	説明
`title`	記事のタイトル	記事の一番上やブラウザーのタブに表示されます。
`summary`	記事の概要	タイトルの下に表示されます。検索エンジンが使用することもあります。
`date`	記事の公開日	記事が作成されたか、大幅に編集され"最新"の状態になった日付を示します。この項目が省略できるのはトップページのみです。

必須の項目に加えて、必要に応じて、以下の表にある項目を指定することもできます。

項目名	指定すべき値	説明
`long_title`	記事の長いタイトル	記事のタイトルが長い場合に、完全なタイトルを表示するために使用します。これは記事の上部などに使用されます。
`author`	記事の筆者	記事の筆者を明示的に指定する必要がある場合に使用します。この項目は従来別の筆者が書いた記事を、他者が複製した場合などに元の筆者を表す場合に使用します。
`author_url`	筆者へのURL	記事の筆者のアドレスなどのリンクを指定します。この項目は`author`と同時に使用します。
`image`	記事のサムネイル	記事のサムネイルとして使用される画像へのパスを指定します。省略した場合WSOFTDocsのサムネイルが選択されます。
`order`	記事の並び替え番号	記事の一覧表示時に、この記事が表示される場所を指定します。一覧は、自然順ソートで大きいものから並びます。

以下の項目を指定することで、記事内の特定の要素の表示状態を制御できます。

項目名	指定すべき値	説明
`disable_nav`	`true`	ページにナビゲーション（他の記事一覧）を表示させたくない場合に指定します。
`disable_toc`	`true`	ページに目次を表示させたくない場合に指定します。
`disable_edit`	`true`	ページに編集ボタンを表示させたくない場合に指定します。
`disable_tools`	`true`	ページにツールバー（印刷や編集ボタンなど）を表示させたくない場合に指定します。

以下の項目は、特定の用途に使用されることがありますが、基本的には使用すべきでない項目です。

項目名	指定すべき値	説明
`edit_url`	編集ページへのURL	編集ボタンを押したときに開くリンクを指定します。
`extra_css`	適用するCSSへのパス	記事に外部のスタイルシートを適用する場合に指定します。
`extra_javascript`	適用するスクリプトへのパス	記事に外部のスクリプトを適用する場合に指定します。