search

tomaz / appledoc

Objective-c code Apple style documentation set generator.
http://gentlebytes.com
4.19k stars 645 forks source link

Localized the GBApplicationStringsProvider class to support documentation localization. #565

Closed TorreyBetts closed 9 years ago

TorreyBetts commented 9 years ago

Localizing the GBApplicationStringsProvider class is the first step for allowing appledoc to output localized API documentation.This also partially addresses issues such as #560, where one would want to easily customize the template text. Keep in mind this is a first step toward proper localization of appledoc to support outputting documentation for other locales and the process will get further refined to become as simple as possible.

For everyone that reads this pull request, the process for localization with this first step involves the following steps:

  1. Translate the Localizable.strings file. This file uses a "key" = "value" format, you'd translate the "value" portion. Optionally, if your build machine OS X uses your target language as the displayed language, you can add your localization folder to the project with files for translation copied there. To read more about localizing with Xcode, read this topic.
  2. Translate the hard coded strings in the HTML documents in the Templates/html path or copy the Templates folder to another location and translate. Be sure to avoid translating template text. If you plan on using a copy of the Templates folder, you can specify it's path to the appledoc command line with the --templates "/path/to/template" option when building documentation.
tomaz commented 9 years ago

Thanks!

tomaz commented 9 years ago

@TorreyBetts BTW - I want to bring appledoc forward, but don't have time for coding, so I'm looking for devs that would be interested in joining the team. Given you already submitted two larger updates; if you feel for it, let me know - no obligations of course, everyone in their own constraints. If you're not interested, I can still add you as appledoc collaborator on GitHub, then you have read/write access, review and merge PR etc. Whichever, thanks a lot for all your contributions so far :+1:

TorreyBetts commented 9 years ago

As a user of appledoc since 2012, I'm definitely with you and willing to help bring it forward as my time permits. What would joining the team entail versus being a collaborator?

tomaz commented 9 years ago

Cool, will add you to project and Slack channel. But otherwise, it's not that much of a difference really. You can participate in decision making process, and in a way you are more on the side of "official appledoc developer" so to speak :) That being said, everyone will participate only as much as they can at any given time, so no obligations on your side. For the moment I'm still in the process of gathering a team, so no immediate work. But I have couple things that can be tested in advance to decide what to go with.