Opened 2 years ago

Last modified 2 years ago

#4730 new change

Document the variable naming pattern for website project

Reported by: saroyanm Assignee:
Priority: Unknown Milestone:
Module: Unknown Keywords:
Cc: juliandoucette, lisabielik, Shikitita Blocked By:
Blocking: Platform: Unknown / Cross platform
Ready: no Confidential: no
Tester: Unknown Verified working: no
Review URL(s):

Description (last modified by saroyanm)

Background

We do deal with a huge load of translation variables and letting developers/content developers make sense for each single string take huge amount of time.

What to change

Document the variable naming convention pattern.

[heading]-[tag]-[unordered increasing numeration]

Example HTML:

<h2>
  {{ios-support[Title of section] iOS support}}
</h2>
<ul>
  <li>{{ios-support-list[iOS support list item] Installing Adblock Browser for iOS}}</li>
  <li>{{ios-support-list1[iOS support list item] Adding a filter list}}</li>
  <li>{{ios-support-list4[iOS support list item] Removing a filter list}}</li>
  <li>{{ios-support-list3[iOS support list item] Configuring Acceptable Ads}}</li>
  <li>{{ios-support-list5[iOS support list item] Changing the default search engine}}</li>
</ul>

Temporary Note

  • this is being currently used without documentation

Change History (1)

comment:1 Changed 2 years ago by saroyanm

  • Cc juliandoucette lisabielik Shikitita added
  • Description modified (diff)

We also need to find place where this needs to be documented, current suggestions:

Note: See TracTickets for help on using tickets.