WordPress マニュアル Codex の紹介 - 2016年3月の今だけ限定、超簡単本家 WordPress.org へのコントリビュートあります | WordPressもくもく勉強会

WordPress マニュアル Codex の紹介2016年3月の今だけ限定、超簡単本家 WordPress.org へのコントリビュートあります

What is WordPress “Codex”?

2016年3月13日立花 明 / Akira Tachibana

WordPressもくもく勉強会第12回 in CoEdo

自己紹介

• 立花 明

• IT 関連会社勤務 (非 WordPress)

• 好きなこと: 何かを集めること、並べること

– 新しい趣味のため、集め始めない、並べ始めないと自戒

• WordPress との関係

– 2014年: ブログで利用

– 2015年: Codex に参加。翻訳と執筆

– 2016年: Developer Resources 構築支援

– 究極の目的: 早く立ち上げて、日本語版の話がしたい

2WordPressもくもく勉強会 第12回 in CoEdo2016/3/13

Codex とは?

– WordPress 公式オンラインマニュアル

– WordPress 知識の百科事典

– http://wpdocs.osdn.jp

2016/3/13 WordPressもくもく勉強会 第12回 in CoEdo 3

英語版、あるいは本家版

• https://codex.wordpress.org

2016/3/13 WordPressもくもく勉強会 第12回 in CoEdo 4

日本版 = 本家版の翻訳 + 独自記事

• 独自記事の例

– インストール情報

– レンタルサーバー情報

– 文字列に関する注記

2016/3/13 WordPressもくもく勉強会 第12回 in CoEdo 5

翻訳

追記

Codex の特徴

• Wiki ベース

• アカウントがあれば誰でも編集可能

– 「承認」「レビュー」等は不要

– 逆に不安であれば「レビュー」を求めることも可能

• 履歴が残り、任意の版で差分が取れます。

– 安心して、思う存分、編集可能。スパムも多数ですが...。

– 自己紹介ページも履歴が残るので、注意(?)

• 本家版 Codex は別システム「Developer Resources」に移行中

– ここでは DevHub、HelpHub 等を含めて総称します。2016/3/13 WordPressもくもく勉強会 第12回 in CoEdo 6

Developer Resources: Codex の後継

• 鋭意、制作中

– https://developer.wordpress.org/

2016/3/13 WordPressもくもく勉強会 第12回 in CoEdo 7

Plugin Handbook

Core Contributor Handbook

Code Reference

Codex の使い方

• 入門用チュートリアルとしてはお薦めしません。

– そのような記事もありますが、良い書籍が多数あります。

– 出版日を確認しましょう。

2016/3/13 WordPressもくもく勉強会 第12回 in CoEdo 8

出版年月が新しい順番

おまけ - WordPress 近刊一覧

自社のブランド力を上げる! オウンドメディア制作・運用ガイド WordPress・Facebook・Twitterで作るメディア構築ノウハウ

– 深谷歩 / 2016/5/20 / 翔泳社

一歩先にいくWordPressのカスタマイズがわかる本

– 相原知栄子、大曲仁 / 2016/4/9 / 翔泳社

動画で学ぶWordPressの学校 初めてWebサイトを立ち上げるときに読む本

– たにぐちまこと / 2016/3/18 / KADOKAWA/アスキー・メディアワークス

WordPress Web開発逆引きレシピ WordPress4.x/PHP7対応

– 藤本壱 / 2016/3/16 / 翔泳社

ビジネスサイトをこれからつくる WordPressデザイン入門 サイト制作から納品までのはじめの一歩

– 秋元英輔、清野奨 / 2016/2/15 / SBクリエイティブ2016/3/13 WordPressもくもく勉強会 第12回 in CoEdo 9

Codex の使い方

• 関数やタグのリファレンスマニュアルとして

– 右上の検索ボックスや、Google で検索

– ヒント: Google でサイト「site:wpdocs.osdn.jp」を指定

• トピックに関するガイドとして(例: バックアップ方法)

– トップ画面の目的別の目次を参照

2016/3/13 WordPressもくもく勉強会 第12回 in CoEdo 10

Codex の使い方

• 新機能を調べる

– 左メニューの「特集」

– Version 4.4

– Version 4.3

• 新しい文書を調べる

– 左メニューの「最近の更新」

2016/3/13 WordPressもくもく勉強会 第12回 in CoEdo 11

Codex の使い方 注意点

• 翻訳が追いついていないものもあるので疑問に感じたら原文を参照

– 各ページの一番下

• ただし本家版も記述が古い / 存在しない場合あり

– 履歴 (History)で最終更新日を確認

2016/3/13 WordPressもくもく勉強会 第12回 in CoEdo 12

対応する本家版を開く 最新版との差分表示

本家版での残念なお知らせ

• 既存マニュアルが Developer Resources に移行中

– 移行後、情報が減っている場合が多数あり

• Version 4.0 以降の新規関数やクラスの記載がCodex にはなく、Developer Resources のみ

– Developer Resources は国際化予定ですが、対応時期は未定です。

– つまり、当面は英語だけ

– Developer Resources には履歴機能がありません。

– 結果、更新されても差分が分からない。

– つまり、現在の英語版を訳出して 日本版 Codex に転載はできるが、更新が困難

2016/3/13 WordPressもくもく勉強会 第12回 in CoEdo 13

日本語ユーザーとして

• しばらく以下を組み合わせて使用する

– 日本語 Codex

– 英語 Code Reference (Version 4.0 ～)

– 英語各種 Handbook

2016/3/13 WordPressもくもく勉強会 第12回 in CoEdo 14

コントリビュート

• WordPress を使いやすくする活動

– WordPress 本体(コア)、プラグイン、テーマ作成

– ドキュメントの整備

– WordCamp の運営、広報活動 等々

• ボランティア

– やっても、やらなくてもいい

– 動機はいろいろ

– 「それがぼくには楽しかったから」

– 勉強になるから

– 転職や就職に有利だから(?) 等々

2016/3/13 WordPressもくもく勉強会 第12回 in CoEdo 15

もし、コントリビュートしてみたいと思ったら

• Codex は比較的簡単なのでおすすめ

– 「実績」がログとして残ります!

– 間違っても誰かが修正できるので気にしない!

• コア、テーマ、プラグインの翻訳もオンラインで可能

– ただし日本語ガイドラインがあります。

• 勉強会もあります

– 3/18(金) 19:00 -

2016/3/13 WordPressもくもく勉強会 第12回 in CoEdo 16

私の最近のコントリビュート

• 上から簡単な順

1. タイプミスやリンク切れの修正

2. 本家版のコード例(Example) を Developer Resources にコピペ

3. 本家版の記事を Developer Resources にコピペ

4. 本家版の記事の翻訳、執筆

• 以下のスライドでは1と2の手順を紹介

– 残りも含めてブログで紹介予定

2016/3/13 WordPressもくもく勉強会 第12回 in CoEdo 17

0. まず、アカウント作成

• アカウントは2種類

– 日本版Codex用

– To: [email protected]

– Subject:日本語Codex編集希望

– 本文: 希望のアカウント

– 本家版Codex用 = WordPress.org アカウント = 日本語を含むフォーラムのアカウント

– 登録: https://wordpress.org/support/register.php

– 顔写真: http://ja.gravatar.com/

• アカウント名は共通にできると便利

• 写真は重要。後悔しないように...。2016/3/13 WordPressもくもく勉強会 第12回 in CoEdo 18

1. タイプミスやリンク切れの修正

1. ログイン

2. 右端の「編集」をクリック

3. 編集

4. 「ページを保存」をクリック

– お気軽にどうぞ

2016/3/13 WordPressもくもく勉強会 第12回 in CoEdo 19

2. Codex のコード例 (Example) の移行

2016/3/13 WordPressもくもく勉強会 第12回 in CoEdo 20

• 現在、本家版では Example を移行しています。

– 単純なコピペ作業です。

コピペ

2. Codex のコード例 (Example) の移行

• 手順

1. 予約用文書を開く

http://bit.ly/1Ldd67Z

– 項目

– 関数名

– 元の Codex 文書へのリンク

– 新しい Developer Resources 文書へのリンク

– 担当者名

– Example の数

– 進捗2016/3/13 WordPressもくもく勉強会 第12回 in CoEdo 21

2. Codex のコード例 (Example) の移行

• 手順

2. 予約用文書の担当者名に本家版アカウントを記入

3. 元の文書を開いて Example を1つコピー

4. 新しい文書を開いて末尾の「User Contributed Notes」をクリックして、貼付け

5. Example の数だけ繰り返す

6. 予約用文書の Example の数を記入し、進捗を「Ready for Review」に変える

7. 予約用文書を閉じる

2016/3/13 WordPressもくもく勉強会 第12回 in CoEdo 22

おまけ - コア、テーマ、プラグインの翻訳

• 翻訳システムが整備されました

– https://translate.wordpress.org/

• コアだけでなく、テーマ、プラグインも対象

2016/3/13 WordPressもくもく勉強会 第12回 in CoEdo 23

おまけ - コア、テーマ、プラグインの翻訳

• コントリビュートも分かりやすく表示

2016/3/13 WordPressもくもく勉強会 第12回 in CoEdo 24

おまけ - コア、テーマ、プラグインの翻訳

• 一つだけ注意

「WordPress 翻訳ガイドライン」があります。

• 間違えやすい点

– 半角英字、半角記号の前後にスペースを入れる

– 半角数字の前後にスペースは入れない

– 受動態は、能動態で訳す 等々

2016/3/13 WordPressもくもく勉強会 第12回 in CoEdo 25

まとめ

• Codex = WordPress 公式マニュアル

– Wiki ベースの百科事典

– 2016年3月現在、本家版は Developer Resrouces に移行中

• Codex の使い方

• Codex へのコントリビュート

• おまけ

– コア、テーマ、プラグインの翻訳

26WordPressもくもく勉強会 第12回 in CoEdo2016/3/13

ありがとうございました。

• Unofficial Tokyo Web Site

– http://unofficialtokyo.com

• ブログ記事(予定)

– 「Codex の使い方とコントリビュート」

27WordPressもくもく勉強会 第12回 in CoEdo2016/3/13