docs(man): add a page for I18nRubyGem

Signed-off-by: Masatake YAMATO <yamato@redhat.com>

docs/man-pages.rst

@@ -25,6 +25,7 @@ Man pages
 	ctags-lang-elm(7) <man/ctags-lang-elm.7.rst>
 	ctags-lang-fortran(7) <man/ctags-lang-fortran.7.rst>
 	ctags-lang-gdscript(7) <man/ctags-lang-gdscript.7.rst>
+	ctags-lang-i18nrubygem(7) <man/ctags-lang-i18nrubygem.7.rst>
 	ctags-lang-iPythonCell(7) <man/ctags-lang-iPythonCell.7.rst>
 	ctags-lang-inko(7) <man/ctags-lang-inko.7.rst>
 	ctags-lang-javascript(7) <man/ctags-lang-javascript.7.rst>

docs/man/ctags-lang-i18nrubygem.7.rst

@@ -0,0 +1,75 @@
+.. _ctags-lang-i18nrubgem(7):
+
+==============================================================
+ctags-lang-i18nrubgem
+==============================================================
+
+Random notes about tagging input for I18n Ruby Gem with Universal Ctags
+
+:Version: 6.0.0
+:Manual group: Universal Ctags
+:Manual section: 7
+
+SYNOPSIS
+--------
+|	**ctags** ... \
+|		--extras=+q \
+|		--language-force=I18nRubyGem \
+|		--languages=+I18nRubyGem \
+|		INPUT...
+
+DESCRIPTION
+-----------
+This man page gathers random notes about tagging input for I18n Ruby
+Gem [RUBYI18N]_.  This parser doesn't have any file name patterns or
+file extensions activating the parser, you must specify
+``--language-force=I18nRubyGem`` explicitly.
+
+"input.yaml"
+
+.. code-block:: YAML
+
+	---
+	ja:
+	  msg:
+	    error: エラー
+	    function: 関数
+
+"output.tags"
+with "--options=NONE -o - --extras=+q --language-force=I18nRubyGem --languages=+I18nRubyGem --fields=+E input.yaml"
+
+.. code-block:: tags
+
+	error	input.yaml	/^    error: エラー$/;"	k	keyInMiddle:ja.msg	extras:subparser
+	function	input.yaml	/^    function: 関数$/;"	k	keyInMiddle:ja.msg	extras:subparser
+	ja.msg.error	input.yaml	/^    error: エラー$/;"	k	keyInMiddle:ja.msg	extras:qualified,subparser
+	ja.msg.function	input.yaml	/^    function: 関数$/;"	k	keyInMiddle:ja.msg	extras:qualified,subparser
+	msg.error	input.yaml	/^    error: エラー$/;"	k	keyInMiddle:ja	extras:subparser,localeless
+	msg.function	input.yaml	/^    function: 関数$/;"	k	keyInMiddle:ja	extras:subparser,localeless
+
+
+With the options, the parser emits three tag entries for a key:
+"error", "js.msg.error", and "msg.error" for the key "error", The
+parser emits "error" at the first line always.
+
+To emit "ja.msg.error", a full qualified (``qualified``) extra tag, at
+the third line, you must specify ``--extras=+q``.
+
+To emit "msg.error", a ``localeless`` extra tag, at the fifth line
+always. The parser creates a ``localeless`` extra tag by truncating
+the first component (e.g. "ja.") from the associated full qualified
+extra tag (e.g. "ja.msg.error").  ``localeless`` extra is enabled by
+default. If you don't need ``localeless`` extra tags, specify
+``--extras-I18nRubyGem=-{localeless}``.
+
+The parser doesn't make tag entries for top-level and mid-level components like
+``ja`` and ``msg`` by default. If you need them, specify
+``--kinds-I18nRubyGem=+{keyInMiddle}``.
+
+SEE ALSO
+--------
+:ref:`ctags(1) <ctags(1)>`
+
+REFERENCES
+----------
+.. [RUBYI18N] Ruby I18n, https://github.com/ruby-i18n/i18n

man/GNUmakefile.am

@@ -37,6 +37,7 @@ GEN_IN_MAN_FILES = \
 	ctags-lang-fortran.7 \
 	ctags-lang-gdscript.7 \
 	ctags-lang-iPythonCell.7 \
+	ctags-lang-i18nrubygem.7 \
 	ctags-lang-inko.7 \
 	ctags-lang-javascript.7 \
 	ctags-lang-julia.7 \

man/ctags-lang-i18nrubygem.7.rst.in

@@ -0,0 +1,75 @@
+.. _ctags-lang-i18nrubgem(7):
+
+==============================================================
+ctags-lang-i18nrubgem
+==============================================================
+------------------------------------------------------------------------
+Random notes about tagging input for I18n Ruby Gem with Universal Ctags
+------------------------------------------------------------------------
+:Version: @VERSION@
+:Manual group: Universal Ctags
+:Manual section: 7
+
+SYNOPSIS
+--------
+|	**@CTAGS_NAME_EXECUTABLE@** ... \
+|		--extras=+q \
+|		--language-force=I18nRubyGem \
+|		--languages=+I18nRubyGem \
+|		INPUT...
+
+DESCRIPTION
+-----------
+This man page gathers random notes about tagging input for I18n Ruby
+Gem [RUBYI18N]_.  This parser doesn't have any file name patterns or
+file extensions activating the parser, you must specify
+``--language-force=I18nRubyGem`` explicitly.
+
+"input.yaml"
+
+.. code-block:: YAML
+
+	---
+	ja:
+	  msg:
+	    error: エラー
+	    function: 関数
+
+"output.tags"
+with "--options=NONE -o - --extras=+q --language-force=I18nRubyGem --languages=+I18nRubyGem --fields=+E input.yaml"
+
+.. code-block:: tags
+
+	error	input.yaml	/^    error: エラー$/;"	k	keyInMiddle:ja.msg	extras:subparser
+	function	input.yaml	/^    function: 関数$/;"	k	keyInMiddle:ja.msg	extras:subparser
+	ja.msg.error	input.yaml	/^    error: エラー$/;"	k	keyInMiddle:ja.msg	extras:qualified,subparser
+	ja.msg.function	input.yaml	/^    function: 関数$/;"	k	keyInMiddle:ja.msg	extras:qualified,subparser
+	msg.error	input.yaml	/^    error: エラー$/;"	k	keyInMiddle:ja	extras:subparser,localeless
+	msg.function	input.yaml	/^    function: 関数$/;"	k	keyInMiddle:ja	extras:subparser,localeless
+
+
+With the options, the parser emits three tag entries for a key:
+"error", "js.msg.error", and "msg.error" for the key "error", The
+parser emits "error" at the first line always.
+
+To emit "ja.msg.error", a full qualified (``qualified``) extra tag, at
+the third line, you must specify ``--extras=+q``.
+
+To emit "msg.error", a ``localeless`` extra tag, at the fifth line
+always. The parser creates a ``localeless`` extra tag by truncating
+the first component (e.g. "ja.") from the associated full qualified
+extra tag (e.g. "ja.msg.error").  ``localeless`` extra is enabled by
+default. If you don't need ``localeless`` extra tags, specify
+``--extras-I18nRubyGem=-{localeless}``.
+
+The parser doesn't make tag entries for top-level and mid-level components like
+``ja`` and ``msg`` by default. If you need them, specify
+``--kinds-I18nRubyGem=+{keyInMiddle}``.
+
+SEE ALSO
+--------
+ctags(1)
+
+REFERENCES
+----------
+.. [RUBYI18N] Ruby I18n, https://github.com/ruby-i18n/i18n