Linux

BookStackの初期セットアップ①(日本語化、本棚、本、チャプターなど)

スポンサーラベル
Linux

BookStackは、知識や情報を整理しやすい構造を持つオープンソースのドキュメント管理ツールです。前回はBookStackをAlmaLiunux9.4にインストール手順を紹介しました。
https://syachiku.net/bookstack-install/

今回は実際にBookStackを利用するためのセットアップを進めていきます。
BookStackで扱う情報は本棚に例えて管理され、以下のような階層構造で管理されます。

  1. Shelf(シェルフ): Bookの集まりをまとめる単位です。プロジェクトやカテゴリごとにBookを整理する際に使用します。
  2. Book(ブック): ドキュメントの基本単位であり、ChapterやPageをまとめて管理します。
  3. Chapter(チャプター): Book内で情報をさらに整理するための単位です。複数のPageを含むことができます。
  4. Page(ページ): 実際の情報やコンテンツが記載される場所です。

この階層構造により、情報を論理的に整理し、簡単にアクセスできるようになります。

1. 日本語化

BookStackは多言語対応しており、日本語に切り替えることで操作がよりスムーズになります。

日本語化の手順

  • 管理者としてログイン
    初期インストールで設定した管理者アカウントを使用してログインします。
  • 設定画面を開く
    画面右上のアバターをクリックし、「設定(Settings)」を選択します。
  • アプリケーション設定に移動
    左メニューから「アプリケーション設定(App Settings)」をクリックします。
  • 言語を日本語に変更
    「Primary Locale」のドロップダウンメニューからjaを選択し、「保存(Save)」をクリックします。

日本語化が反映されない場合は、以下のコマンドでキャッシュをクリアしてください。
php artisan cache:clear
php artisan config:clear
php artisan view:clear

2. Shelfの作成

Shelfは、複数のBookをまとめて管理するための機能です。例えば、プロジェクトごとにBookを整理したい場合に役立ちます。

Shelfの作成手順

  • 「Shelf」を選択
    左のメニューから「Shelf」をクリックし、「新しい本棚」を選択します。
  • 詳細を入力
    • 名前: Shelfの名前を入力します(例: プロジェクトA)。
    • 説明: 必要に応じて説明を追加します。
  • Bookを追加
    Shelfに含めたいBookを選択して追加します。
  • 保存
    「保存」ボタンをクリックしてShelfを作成します。

3. Bookの作成

Bookは、情報を章(Chapter)ごとに整理するための単位です。

Bookの作成手順

  • 「Book」を選択
    左のメニューから「Book」をクリックし、「新しいブック」を選択します。
  • 詳細を入力
    • 名前: Bookの名前を入力します(例: 業務マニュアル)。
    • 説明: 必要に応じて説明を追加します。
  • カバー画像の設定(任意)
    Bookの表紙となる画像をアップロードできます。
  • 保存
    「保存」ボタンをクリックしてBookを作成します。

4. Chapterの作成

Chapterは、Bookの中で情報をさらに整理するための単位です。
Chapterを作らなくてもPageは作成することができます。Pageの増えてきた際にChapterを作成し、Pageを移動することができます。

Chapterの作成手順

  • Book内で操作
    作成したいBookを開きます。
  • 「チャプターを作成」を選択
    メニューの「チャプターを作成」をクリックします。
  1. 詳細を入力
    • 名前: Chapterの名前を入力します(例: 初期設定)。
    • 内容: 必要に応じて内容を入力します。
  2. 保存
    「保存」ボタンをクリックしてChapterを作成します。

4. pageの作成

  • ページの作成: Chapter内に個別のページを追加することで、さらに詳細な情報を記録できます。
  • 図をDrao.ioを使って簡単に作成できます。
  • 権限設定: BookやShelfごとにアクセス権を設定することも可能です。これによってプロジェクトメンバーだけ編集可能、などの制御をおこなうことができます。

以上で、BookStackの初期セットアップは完了です。これでより効率的にドキュメントを管理できるようになります!次回は引き続きもっと細かいセットアップをしたいと思います。

今回は以上となります。

コメント

タイトルとURLをコピーしました