README.md

ctp-website

The Dropbox folder hierarchy needs to be as follows:

• RCM CiE Toolkit Final
  • en / es / etc. (ISO 639-1 two-letter language code)
    • 1. toolkit (folder name must match this exactly)
      • (overview toolkit docs go here outside of any subfolders)
      • (a zip of the entire toolkit should be saved here outside of any subfolders)
      • folders for sections and documents can be named anything but should sort into the order you want them to display
    • 2. modalities (folder name must match this exactly)
      • 1. Cash for Work Box (the words should be translated but the number 1 must be included)
      • 2. Modalities Box (the words should be translated but the number 2 must be included)
    • 3. resources (folder name must match this exactly)
      • 1. Guidance (the words should be translated but the number 1 must be included)
      • 2. Learning (the words should be translated but the number 2 must be included)
      • 3. Training (the words should be translated but the number 3 must be included)
      • 4. Coordination (the words should be translated but the number 4 must be included)
    • 4. data management (folder name must match this exactly)
      • 1. Mobile Data Collection (the words should be translated but the number 1 must be included)
      • 2. Spreadsheet Tools (the words should be translated but the number 2 must be included)
      • 3. Cash IM Resourcs (the words should be translated but the number 3 must be included)

Adding Language support

The site is configured to support 2-letter core language codes. So english is 'en' not 'en-US' and/or 'en-GB'. Using a longer code will not function.

1. tell app config the language exists
2. add 2-letter language code to authorized_locales array in _config.yml
3. include locale file (to support date/time localization)
4. several already in place (in _locales dir), otherwise get from here
5. include _data/2-letter code.yml to support site content translations
6. copy _data/en.yml, then update text values
7. note that the url for the nav items can be updates for your language. this needs to align with the permalink in the page frontmatter (see item 4.2 below)
8. create folder of page templates
9. copy 'en' dir, rename copy as your 2-letter language code
10. in frontmatter for all templates there within, you need to add the language code and pagename to the permalink (i.e. /toolkit/ becomes /fr/boite-a-outils/ for the french translation)