ホーム
Glyphsチュートリアル非公式和訳
プラグインを作成する

プラグインを作成する

広告

原文: Writing plug-ins

チュートリアル

スクリプト

執筆者：

en zh

2025年1月30日更新（初版公開：2016年1月11日）

プラグインは、通常サードパーティから提供される、ソフトウェアアプリケーションに追加機能を提供します。この概要では、Glyphs 2.3以降のプラグイン開発について説明します。恥ずかしがらずに、美味しいコーヒーを一杯用意して、リラックスしてください。あなたより先に、他の人もやっているのですから。

プラグインは、通常サードパーティから提供される、ソフトウェアアプリケーションに追加機能を提供します。このチュートリアルでは、プラグイン開発の進め方の概要を説明します。詳細な説明は、GlyphsSDKリポジトリのReadme.mdファイルにあります。

恥ずかしがらずに、美味しいコーヒーを一杯用意して、リラックスしてください。あなたより先に、他の人もやっているのですから。

ステップ1：プラグインのテンプレートを入手する

私たちは、様々な目的（ファイル書き出し、カスタムアウトラインフィルタなど）のためのプラグインの骨組みをGitHubページで提供しています。もしすでにGitに慣れているなら、お気に入りのバージョン管理アプリ（Git自身のものや、他にも多くのアプリがあります）でフォルダ構造をチェックアウトすると良いでしょう。Subversionクライアントですが、Versions.appはこのチュートリアルの著者の推薦です）。

プロのヒント

コードのバージョン管理システムに慣れておきましょう。後で仕事の様々な分野で役立ちます。

もしコードバージョン管理の概念にあまり慣れていない場合でも、他の人のコードの購読者としてだけでも、Glyphs SDKメインページからGlyphs SDK（ソフトウェア開発キット）全体を含むZIPファイルをダウンロードすることもできます。

さて、私たちのSDKページはこちらです：https://github.com/schriftgestalt/GlyphsSDK/tree/Glyphs3、そしてプラグインのテンプレートはPython Templatesというサブフォルダにあります。そこには、あなたが生命を吹き込むのを待っているプラグインの骨組みがあります。これらのプラグインテンプレートにはそれぞれ、理解を深めるための完全に機能するサンプルコードが含まれています。

  • File format: 独自のフォントフォーマットを書き出す
  • Filter without dialog: フィルタメニューまたは書き出し時にフォントを変更する
  • Filter with dialog: 上記と同じですが、ユーザーインターフェースダイアログを使用します
  • General plug-in: 特別な目的はありません。何が起こるか見てみましょう
  • Palette: サイドバーにパレットビューを追加する
  • Reporter: 編集ビューとプレビューに描画して、グリフの特徴を説明する
  • Select Tool: 選択ツールを独自の機能で強化する

Glyphs.appでは、プラグインはMacのいわゆるパッケージの形で提供され、GlyphsのPluginsフォルダ（~/Library/Application Support/Glyphs/Pluginsにあります。~はユーザーアカウントのホームフォルダを表します）に入れる必要があります。アプリのアイコンにドラッグするか、ダブルクリックすると、Glyphsが自動的にそこに配置します。これらのパッケージはFinderでは単一のファイルのように見え、動作しますが、実際にはフォルダであり、その内容はFinderでそのようなパッケージを右クリックし、「パッケージの内容を表示」を選択することでアクセスできます。

このようなプラグインのフォルダ構造は次のようになります。あなたの主なコードはContents/Resources/plugins.pyファイルに入ります。他に注目すべきファイルは、プラグインに関する様々な情報を保持するInfo.plistと、ダイアログを持つプラグインでは、ユーザーインターフェースダイアログビューを含む2つの.nib/.xibファイルです。

多くの現代的なテキストエディタは、フォルダ全体を一度に開くこともでき、サイドパネルに編集するファイルのツリービューを提供します。したがって、.glyphsFilterファイルパッケージ全体をテキストエディタで一度に開くことができます。

現在、この目的で最も人気のあるテキストエディタは、TextMate、SublimeText、またはVisual Studio Codeです。

ステップ2：いくつかの____Names____をリネームする

GitHubリポジトリのPython Templatesページには、プラグイン内のファイル構造の設定方法に関する詳細情報が含まれています。4つのアンダースコアを含むすべてのもの（____PluginClassName____など）を、最大3つのファイルでリネームする必要があります。

プラグイン名については、2つの異なる名前のバリエーションを扱います。

  • ____PluginName____は、人間が読める名前で、Glyphsの「環境設定」ウィンドウの「プラグイン」タブのような場所に表示されます。この名前には、スペースやUnicode文字を含めることができます。
  • ____PluginClassName____は、あなたのコード内のPythonクラスの機械が読める名前で、いくつかの場所に配置する必要があります。これは一意である必要があります。同じクラス名を持つ2つのプラグインを隣り合わせてインストールすることはできません。「機械が読める」と書きましたが、プラグインのユーザーがこのクラス名を目にする相互作用が1つあります。ファイル書き出し時にカスタムパラメータを介してフィルタを呼び出す場合です。ですから、親しみやすくユニークな名前にしてください。ここではASCII文字のみが許可され、スペースは許可されません。PascalCaseNames（先頭が大文字のキャメルケース）をお勧めします。

Info.plistのセクションは、Glyphsにあなたのプラグインの更新場所を知らせ、プラグインが古くなったときにユーザーに通知できるようにします。これが機能するためには、現在のバージョン番号を含むオンラインのInfo.plistへのURLを入力する必要があります。これは手動で編集されたファイルでも、オンラインショップから自動生成されたファイルでも、ダウンロード可能なプラグイン内のまさにそのInfo.plistでも構いません。

もし配布にGitHubを使用している場合、あなたのInfo.plistへのディープリンクは次のようになります：https://raw.githubusercontent.com/*user*/*plugin*/master/*filename*/Contents/Info.plist。*user*をあなたのGitHubユーザー名に、*plugin*をGitHubリポジトリの名前に、*filename*をサフィックスを含むあなたのプラグインの名前に置き換えてください（例：MyPlugin.glyphsFilter）。

今こそ、Python Templatesページで詳細を読む良い機会です。

ステップ3：インターフェースビルダーでダイアログを作成する

一部のプラグインタイプは、Glyphs.app内でダイアログを開くことができます。

Glyphsアプリケーション全体と同様に、私たちはダイアログを作成するためにApple自身のCocoa、具体的にはInterface Builderを使用しています。このためには、AppleのXcodeをインストールする必要があります。これはAppStoreで無料で入手できます。まだ持っていない場合は、今すぐ高速インターネット接続を見つけて、ダウンロードを開始する良い機会です。それはかなりの4ギガバイトです。

もし代わりにTal Leming氏のVanillaライブラリを使いたい場合は、ダイアログを持つすべてのプラグインのReadmeファイルに有用な情報があります。

あなたのPythonコードとCocoaユーザーインターフェースは、IBOutlets（あなたのコードがユーザーインターフェースに話しかける）とIBActions（ユーザーインターフェースがあなたのコードに話しかける）を使って互いに通信します。

これらはPythonコードで次のように定義されます。IBOutletsはクラス変数として次のように定義されます。

class CSVFileExport (FileFormatPlugin):
    textField = objc.IBOutlet() # ユーザーインターフェースのテキストフィールド

そして、IBActionsは@objc.IBActionで始まるクラスメソッドです。

    @objc.IBAction
    def buttonClicked_(self, sender):
        # ボタンがクリックされたときに何かをする

そして、XcodeのInterface Builderでダイアログを作成すると、次のようになります。

必要な詳細はすべて、Python Templatesページに記載されています。ステップバイステップガイドを進んで、その時々で橋を渡ってください。

ステップ4：ステップバイステップガイド

各プラグインの扱い方は、それぞれのプラグインのGithubページで詳しく説明されています。

ステップ5：プラグインマネージャ

作業が終わったら、「ウインドウ > プラグインマネージャ」経由で簡単にインストールできるように、プラグインを利用可能にすることができます。Glyphs Packages gitリポジトリの指示に従い、あなたのプラグインに必要な行を追加し、プルリクエストを作成してください。

注意：リポジトリにはGlyphsの異なるバージョン用のブランチがあります。マスターブランチにはGlyphs 2.x用のプラグインマネージャの内容が保存されており、glyphs3ブランチにはGlyphs 3用の内容を追加できます。

おめでとうございます

これだけです！これでGlyphsプラグインを始めるのに十分なはずです。どこかで行き詰まったら、遠慮なくフォーラムで質問してください。

執筆者：Jan Gerner (Yanone)、編集者：Rainer Erich Scheichelbauer & Rafał Buchner

更新履歴 2018-11-18: 軽微な誤字を修正。

更新履歴 2020-12-14: プラグインマネージャのセクションを更新。

更新履歴 2020-12-15: Glyphs 3向けに更新。

更新履歴 2022-08-01: タイトル、関連記事、軽微なフォーマットを更新。

更新履歴 2025-01-30: いくつかのリンクを更新（Thierry氏に感謝）、camelCaseをPascalCaseに変更。

関連記事

すべてのチュートリアルを見る →

コメント

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