Internationalize hardcoded rdoc-ref links
Nobody has claimed this yet.
- Dominant language
- Ruby
- Stars
- 930
- Forks
- 465
- Avg merge
- 3d 10h
- Merged PRs (30d)
- 27
Description
Currently rdoc-ref:REF@label link is converted to label at <code>REF</code>, with the hardcoded word at and in the hardcoded order.
For doc/extension.ja.rdoc written in Japanese in Ruby, this template needs to be localized.
Also, the current I18N feature of RDoc is based on PO files.
That does not suit with files per locales like doc/extension.ja.rdoc above.
We will need a way to specify locales for each doc, such as :locale: directive, e.g., :locale: ja.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reading RDoc's current I18N implementation, which is based on PO files, and compare it with the locale-specific doc/extension.ja.rdoc example. Define how a locale directive such as :locale: ja should work and how localized rdoc-ref output should be verified; done means the hardcoded wording and order can be localized for per-locale documentation.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- ruby
- Domain
- documentation, internationalization, localization
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100