Merge pull request #479 from zonuexe/modify-readme

Modify README

Author: zonuexe

README.ja.md

@@ -27,7 +27,7 @@ PHP 5.4以降を開発しやすくするための機能をアップデートす
 インストール
 ------------
 
-**PHPモードはEmacs 24以降が必要です**。古いバージョンのEmacsでも動作するかもしれませんが、保証外です。 古いバージョンのEmacsのPHPモードを使用することによる問題のバグ報告は積極的に対応しません。
+**PHPモードはEmacs 24.3以降で動作します**。古いバージョンのEmacsでも動作するかもしれませんが、保証外です。 古いバージョンのEmacsのPHPモードを使用することによる問題のバグ報告は積極的に対応しません。
 
 GNU Emacs 24以降では、[package][]機能を使って[MELPA][]からPHPモードをインストールすることができます。 *[Marmalade][]パッケージリポジトリには2004年のオリジナル版PHPモードしか登録されていません*。そのため、MELPAを使用してPHPモードをインストールすることを推奨します。単にパッケージマネージャを使いたくない場合は、`php-mode.el`ファイルをダウンロードして`load-path`の通ったディレクトリに配置し、必要に応じて `(require 'php-mode)` をEmacsの設定に追加すると、PHPファイルを開くたびに自動的にPHPモードが有効になります。
 
@@ -41,7 +41,7 @@ GNU Emacs 24以降では、[package][]機能を使って[MELPA][]からPHPモー
 バグを報告する
 --------------
 
-報告の際には `php-mode-version` コマンドを実行して、その出力をバグレポートに含めてください。問題を再現するための手がかりになります。
+報告の際には `M-x php-mode-debug` コマンドを実行して、その出力をバグレポートに含めてください。問題を再現するための手がかりになります。
 
 Settings
 --------
@@ -77,7 +77,7 @@ Settings
 実験的および作業中の機能
 -------------------------------------
 
-### CC Mode, CEDET, EDE, and Semantic ###
+### CC Mode, CEDET, EDE, and Semantic
 
 In 2013 Daniel Haxney began rewriting parts of PHP Mode in terms of Emacs' built-in CC Mode.  This laid the foundation for incorporating some of the inherit IDE-ish features of Emacs, such as CEDET, EDE, and Semantic.  Support for these tools continues to improve thanks to the work of Andrea Turso, Steven Rémot, Joris Steyn, and others.  If you wish to test, contribute to, or simply experiment with such features then [this thread is a good place to start](https://github.com/emacs-php/php-mode/issues/256).
 
@@ -203,7 +203,7 @@ class Product
 }
 ```
 
-アノテーションは `@` から始まる行で、わかりやすく強調表示されます。ただしPHPモードは[PSR-5: PHPDoc (草案)](https://github.com/phpDocumentor/fig-standards/blob/master/proposed/phpdoc.md)の完全なサポートは実装していません。
+アノテーションは `@` から始まる行で、わかりやすく強調表示されます。ただしPHPモードは[PSR-5: PHPDoc (草案)](https://github.com/phpDocumentor/fig-standards/blob/master/proposed/phpdoc.md)の完全なサポートは実装していません。我々は将来的にこれらの強調表示を厳密にサポートしたいと考えていますが、現在の実装は限定的です。詳しくは[#478](https://github.com/emacs-php/php-mode/issues/478)をご覧ください。
 
 ### コーディングスタイル
 
@@ -221,7 +221,7 @@ PHPモードはデフォルトでは`php-enable-default-coding-style`関数で
 (add-hook 'php-mode-hook 'php-enable-default-coding-style)
 ```
 
-#### Symfony2 Style ####
+#### Symfony2 Style
 
 このスタイルではメソッドチェーンのインデントの継続とぶらさがったセミコロンを整形できます。
 

README.md

@@ -29,7 +29,7 @@ Please submit any bug reports or feature requests by creating issues on [the Git
 Installation
 ------------
 
-**PHP Mode requires Emacs 24 or later.**  PHP Mode may work with older versions of Emacs but this is not guaranteed.  Bug reports for problems related to using PHP Mode with older versions of Emacs will most like *not* be addressed.
+**PHP Mode works on Emacs 24.3 or later.**  PHP Mode may work with older versions of Emacs but this is not guaranteed.  Bug reports for problems related to using PHP Mode with older versions of Emacs will most like *not* be addressed.
 
 With GNU Emacs 24 or later then you can use its [package][] feature to install PHP Mode from [MELPA][].  *The [Marmalade][] package repository only has the original PHP Mode from 2004.*  Therefore we recommend you use MELPA to install PHP Mode.  If you simply do not wish to use the package manager, then all you need to do is download the `php-mode.el` file, place it inside your `load-path`, and optionally add `(require 'php-mode)` to your Emacs configuration to automatically enable PHP Mode whenever you open a PHP file.
 
@@ -43,17 +43,17 @@ Additionally, you can add `skeleton/php-ext.el` to your `load-path` to [enable t
 Reporting Bugs
 --------------
 
-When reporting a bug please run the function `php-mode-version` and include its output in your bug report.  This helps up reproduce any problem you may have.
+When reporting a bug please run the function `M-x php-mode-debug` and include its output in your bug report.  This helps up reproduce any problem you may have.
 
 
 Experimental and In-Progress Features
 -------------------------------------
 
-### CC Mode, CEDET, EDE, and Semantic ###
+### CC Mode, CEDET, EDE, and Semantic
 
 In 2013 Daniel Haxney began rewriting parts of PHP Mode in terms of Emacs' built-in CC Mode.  This laid the foundation for incorporating some of the inherit IDE-ish features of Emacs, such as CEDET, EDE, and Semantic.  Support for these tools continues to improve thanks to the work of Andrea Turso, Steven Rémot, Joris Steyn, and others.  If you wish to test, contribute to, or simply experiment with such features then [this thread is a good place to start](https://github.com/emacs-php/php-mode/issues/256).
 
-### PHP 7 Support ###
+### PHP 7 Support
 
 PHP 7 has been released.  PHP Mode supports the following features and changes from PHP 7:
 
@@ -67,23 +67,23 @@ PHP 7 has been released.  PHP Mode supports the following features and changes f
 Features
 --------
 
-### New Keywords ###
+### New Keywords
 
 Now PHP Mode supports syntax highlighting for new keywords which PHP 5.4 introduced, e.g. those related to traits, such as `insteadof`.  Also supported are the older keywords `clone` and `default`.
 
-### Constants ###
+### Constants
 
 Syntax highlighting includes every magic constant and predefined constant listed on the official PHP site.  However, some constants from specific extensions are not currently included.
 
-### Traits, Interfaces, and Namespaces ###
+### Traits, Interfaces, and Namespaces
 
 Traits, interfaces, and namespaces now appear under Imenu listings. Fontification behaves properly for namespaces as well, so that code like `namespace Foo\Bar\Baz` no longer looks like a warning.  This is also true for namespace aliases, e.g. `use <namespace> as <alias>`; currently the aliased name is not listed in Imenu, but future versions will address this.
 
-### Treatment of Underscores ###
+### Treatment of Underscores
 
 PHP Mode treats underscores as ‘symbol constituents’ (in Emacs terminology) so that you can use keys like `M-f` and `M-b` to move through the individual parts of a variable name like `$foo_bar_baz`.
 
-### Chained Method Calls ###
+### Chained Method Calls
 
 PHP Mode can align method calls over multiple lines anchored around the `->` operator, e.g.:
 
@@ -97,7 +97,7 @@ This behaviour is off by default, but you can customize the variable `php-lineup
 
 **Note:** Alignment will only work if you use one of the php-mode coding styles or inherit one of the styles.
 
-### Nested Array Formatting ###
+### Nested Array Formatting
 
 Nested function calls and `array()` structures now look better by default (or at least in my opinion).  Here is an example of the style:
 
@@ -111,7 +111,7 @@ $results = Post::model()->find(
 );
 ```
 
-### Anonymous Functions ###
+### Anonymous Functions
 
 Anonymous functions such as
 
@@ -121,19 +121,19 @@ $greet = function($name) { ... };
 
 will now appear on Imenu; in this case the name will be `$greet`.
 
-### Flymake Support ###
+### Flymake Support
 
 By customizing the variable `php-executable` you can enable Flymake mode in order to see warnings and errors in real-time as you write code.
 
-### Search Local Documentation ###
+### Search Local Documentation
 
 The key command `C-c C-f` will search the PHP website for documentation on the word under the cursor.  However, if you have a [local copy of the PHP documentation](http://us2.php.net/download-docs.php) then PHP Mode will try searching that documentation first.  All you need to do is customize the variable `php-manual-path` and give it the path to your copy of the documentation.  If PHP Mode cannot find something locally then it will still fallback on searching the PHP website.
 
-### Executing Regions of PHP ###
+### Executing Regions of PHP
 
 The command `php-send-region`, which is bound to `C-c C-r` by default, will execute the selected region of PHP code.  In conjunction with the Emacs command `C-x h` you can use this to execute an entire file.  Any output will appear in a buffer called `*PHP*`.
 
-### PHPDoc Tag / Annotation Highlighting ###
+### PHPDoc Tag / Annotation Highlighting
 
 PHPDoc is a documentation format similar to [JavaDoc](https://en.wikipedia.org/wiki/Javadoc).
 
@@ -180,9 +180,9 @@ class Product
 
 The annotations are the lines that begin with the `@` character, and PHP Mode will give these special highlighting to help them stand out.
 
-PHP Mode has not fully supported [PSR-5: PHPDoc (Draft)](https://github.com/phpDocumentor/fig-standards/blob/master/proposed/phpdoc.md) yet.
+PHP Mode has not fully supported [PSR-5: PHPDoc (Draft)](https://github.com/phpDocumentor/fig-standards/blob/master/proposed/phpdoc.md) yet.  We want to support them, but the current implementation still limited.  See issue [#478](https://github.com/emacs-php/php-mode/issues/478) for details.
 
-### Coding Styles ###
+### Coding Styles
 
 By default PHP Mode tries to provide a reasonable style for indentation and formatting, which you can use via the function `php-enable-default-coding-style`.  However, it provides other options suited for particular projects which you may find useful.  Other coding styles are available through these functions:
 
@@ -198,7 +198,7 @@ They will help format your code for PEAR/PSR-2 projects, or work on Drupal, Word
 (add-hook 'php-mode-hook 'php-enable-default-coding-style)
 ```
 
-#### Symfony2 Style ####
+#### Symfony2 Style
 
 With this style method call chains can be formatted with indented continuation and a hanging semi-colon:
 
@@ -212,19 +212,19 @@ With this style method call chains can be formatted with indented continuation a
 
 This style is used widely throughout Symfony2 source code even if it is not explicitly mentioned in their conventions documents.
 
-### Extra Constants ###
+### Extra Constants
 
 If you commonly use a framework or library that defines a set of constants then you may wish to customize the value of `php-extra-constants`.  It is a list of strings that PHP Mode will treat as additional constants, i.e. providing them the same level syntax highlighting that PHP Mode uses for built-in constants.
 
-### Web Mode Constants and Keywords ###
+### Web Mode Constants and Keywords
 
 If you use [Web Mode][] then PHP Mode will attempt to use any additional PHP constants and keywords that Web Mode allows you to define.
 
-### Avoid HTML Template Compatibility ###
+### Avoid HTML Template Compatibility
 
 Many developers use PHP Mode to edit pure PHP scripts (e.g. files with only PHP and no HTML). A basic compatibility layer with HTML has historically been part of PHP Mode but it does not work perfectly and can cause some bad side effects such as slowness and incorrect font locking.  Configuring the `php-template-compatibility` property with a `nil` will cancel any attempt of HTML compatibility.  [Web Mode](http://web-mode.org/) is a great alternative to PHP Mode if you need to work with PHP scripts that do contain HTML and other markup.
 
-### Subword Mode ###
+### Subword Mode
 
 GNU Emacs comes with [Subword Mode][], a minor mode that allows you to navigate the parts of a [camelCase][] as if they were separate words.  For example, PHP Mode treats the variable `$fooBarBaz` as a whole name by default.  But if you enable Subword Mode then Emacs will treat the variable name as three separate words, and therefore word-related commands (e.g. `M-f`, `M-b`, `M-d`) will only affect the camelCase part of the name under the cursor.
 
@@ -236,11 +236,11 @@ If you want to always use Subword Mode for PHP files then you can add this to yo
 
 The key-binding `C-c C-w` will also toggle Subword Mode on and off.
 
-### Amaka Support ###
+### Amaka Support
 
 Viewing and editing build scripts for [Amaka](http://trashofmasters.github.io/amaka/) will automatically enable PHP Mode.
 
-### Insert current class/namespace ###
+### Insert current class/namespace
 
 ```el
 (with-eval-after-load 'php-mode