オープンソース

一覧へ

3. 記事を新規作成する

3.1. フォルダ構造について

Wiki.jsで記事を作成する前に、記事を保存するフォルダ構造について理解しておく必要があります。 ここでは、Wiki.jsのフォルダ構造について解説します。

Wiki.jsでは、記事や画像などのデータをフォルダ構造を用いて管理しています。 ただし、記事を管理するための構造は、一般的なフォルダ構造と異なります。

特徴的なのは 新しいフォルダを作成する必要がないという点です。 記事を作成する際に、新しいファイルの場所(パス)を指定するだけで、自動的に階層構造が作られます。

Note

Wiki.jsでは、あらかじめシステム側で予約されているフォルダ名やファイル名が存在します。 予約されているフォルダ名やファイル名は使用することができません。 詳しくは ディレクトリ/ファイル作成時の注意点 を参照してください。

次は、Wiki.jsのフォルダ構造と、Windowsなどで採用されている一般的なフォルダ構造の比較画像です。

Wiki.jsのフォルダ構造のイメージ

つまり、記事を作成する場合、階層構造の頂点(/)からファイルまでの場所(絶対パス)を記述するだけで、間のフォルダを作成する必要がありません。 この仕組みがあるため、煩雑なフォルダの作成や管理の手間を省くことができます。

Note

フォルダの構造のことを「パス」と呼びます。

ただし、この仕組みは記事を作成する場合のみの挙動です。 画像などのファイルをアップロードする場合は、別の動きをするため注意が必要です。

3.2. 記事を作成する

記事を新規作成するには、画面右上の 新規作成 ボタンをクリックします。

Wiki.jsの記事新規作成

ページの場所を設定する画面が表示されます。 ここでは、既に登録済みの記事のフォルダも一覧表示されます。

Wiki.jsの記事の場所

以下を設定します。

  1. 記事で使用する言語を指定します
    • Wiki.jsでは、同一の記事であっても、異なる言語で記事を書くことができます。
    • 環境や管理者の設定によっては、言語の切り替えができない場合があります。
  2. 記事の場所(パス)を指定します
    • フォルダを選択して、記事のファイル名を指定します。 新たにフォルダを作成する場合は、パスを全て指定することも可能です。
    • 作成したいパスを入力すると、フォルダは自動で作成されます。
      • たとえば、 universe/planets/earth のように入力すると自動的に universe と planets のサブフォルダが作成されます。
    • パスには空白は使用できません。代わりに-(ハイフン)を使用してください。
    • 末尾にスラッシュは含めないでください。
    • ファイル名にドットを含むことはできません。
    • システムで予約されているため使用できない文字もあります。詳しくは ディレクトリ/ファイル作成時の注意点 を参照してください。

設定後、 選択 をクリックします。

次に文章を作成するツールである「エディタ」を選択します。 Wiki.js は、複数のエディタを用いてページの作成を行うことができるため、エディタの選択画面が表示されます。 使用するエディタを選択します。

Wiki.jsエディタの選択画面

選択可能なエディタは以下の通りです。

  • Visual Editor:一般的な文書作成ソフトのようなエディタ
    • 一般的な文書作成ツール(Wordなど) と同じように操作ができるため初心者でも操作しやすいエディタです。
    • はじめて操作する人は Visual Editorをおすすめします。
  • Markdown:Markdownと呼ばれるマークアップ言語による編集方法
  • AsciiDoc:AsciiDocと呼ばれるマークアップ言語による編集方法
  • Code:HTMLによる編集方法
  • From Template:他のファイルを元にした編集方法

Note

エディタの選択は、Windows上で文書を書く場合に、メモ帳やOfficeなど複数の選択があるのと同じようなことだと捉えてください。

エディタを選択すると、ページのプロパティを設定する画面が表示されます。

Wiki.jsプロパティ

入力する項目は以下の通りです。

  • タイトル:ページのタイトルを入力します
  • 簡単な説明:タイトルの下に表示されるページの概要を入力します
  • 言語:記事で使用する言語を指定します
    • Wiki.jsでは、同一の記事であっても、異なる言語で記事を書くことができます。
    • 環境や管理者の設定によっては、言語の切り替えができない場合があります。
    • デフォルトでは、ページの場所を設定する画面で設定した言語が選択されます。
  • パス:記事の場所(パス)を指定します
    • ページの場所を設定する画面で設定したパスが指定されます。変更することも可能です。
  • カテゴリー:タグを設定します
    • 入力項目に設定したいタグを入力します。
    • 設定したタグは後から記事の検索で使用できます

タグは以下の手順で設定できます。

Wiki.jsタグの追加

入力項目に、設定したいタグの文字を入力します。 同じ文字を含むタグがすでにある場合、選択肢に表示されます。選択することでタグを設定できます。 新しくタグを作成し設定する場合は、タグを入力後、エンターキーを押すことでタグを設定できます。

入力後、 OK をクリックします。

ここまでで、ページのプロパティ設定は完了です。 続いて、選択したエディタで記事を作成する画面が表示されます。

以下は、Visual Editorを選択した場合の例です。

Wiki.jsプロパティ

記事の内容を入力後、右上の 作成 をクリックします。 これで新規ページの作成は完了です。

エディタの詳しい操作方法については以下を参照してください。

一覧へ