Pickles 2

  • HOME
  • ドキュメント

Pickles 2 ドキュメント

ここでは、 ウェブサイト制作ツール "Pickles 2" の使い方について説明しています。

導入とセットアップ

Pickles 2 の実行環境をセットアップする手順については セットアップ手順 を参照してください。

基本的なセットアップができたあとの、アプリケーションやプロジェクトの設定については 設定 を参照してください。

ウェブサイトの制作手順

Pickles 2 は、1つのウェブサイトを「サイトマップ」「テーマ」「コンテンツ」の3要素に分解して構築するフレームワークです。

サイトマップ/ブログ

サイト全体のページの一覧、論理的階層構造(パンくず)、各ページに紐付くプロパティ情報(ページタイトルなど)を管理します。CSV形式、または Excel形式のファイルで編集できます。

テーマ

ページ要素のうち、ヘッダー、フッター、ナビゲーションなど、サイト全体を通して共通の規則にしたがって生成されるべき部分を一元管理する概念です。コンテンツ領域以外のHTMLソースを自動的に生成します。

コンテンツ

ページ要素のうち、内容部分だけが表現されたファイルです。 1ページに1ファイルが基本ですが、ヘッダーフッターさえ含まない、純粋な内容だけが含まれます。

ドラッグ&ドロップベースのブロックエディタ "Broccoli" についてはこちらを参照してください。

静的HTMLの出力 "パブリッシュ"

Pickles 2 は、最終的に静的なHTMLファイル群を出力するCMSです。 この操作を「パブリッシュ」と呼んでいます。

パブリッシュ操作の手順については パブリッシュ を参照してください。

ブロックエディタ "Broccoli"

ドラッグ・アンド・ドロップベースのパワフルなHTML編集ツール "Broccoli" を搭載しています。

Broccoli を利用するための設定や、モジュールの開発等については、 ブロックエディタ "Broccoli" を参照してください。

コマンドラインからの操作

Pickles 2 は、コマンドラインインターフェイスを通じて様々な操作ができるように設計されています。 Pickles 2 を操作するサードパーティ製アプリケーションの開発時などに有用です。

コマンドラインからの操作方法については コマンドラインオプション を参照してください。

PXコマンド

PXコマンドは、 Pickles 2 の独自のインターフェイスの1つです。コマンドラインオプション または URLへのパラメータ付与によって呼び出すことができます。

Pickles 2 の内部の機能へアクセスし、各種情報の取得やサイトの編集のようなサービスを利用するためのインターフェイスを提供します。

詳しくは PXコマンド を参照してください。

プラグイン

Pickles 2 は、プラグインの仕組みを持っています。プロジェクト独自の機能を拡張したり、配布されている Composer パッケージから機能を追加することができます。

Pickles 2 プラグインの仕組み、導入方法、開発方法については、 プラグイン を参照してください。

その他

バグ報告・ご要望など

バグや誤植を見つけたり、機能を改善するアイデアなどがあれば、お問い合わせフォームよりご連絡ください。

または、GitHub issue に投稿してお知らせください。(投稿するにあたり、GitHub にユーザー登録をする必要があります)

  • HOME
  • ドキュメント