Expertiza_Wiki - User contributions [en]

CSC/ECE 517 Fall 2018/E1866 Expertiza Internationalization

2018-12-15T02:55:27Z

Jtgill: /* Future Work */

== Introduction ==

===Team Members===

Jonathan Gill (jtgill@ncsu.edu)

Hasham Mukhtar (hmukhta@ncsu.edu)

Abhilasha Saini (asaini4@ncsu.edu)

Reddy Aravind Karnam Ganesh (rkarnam@ncsu.edu)

=== Mentor ===

Zhewei Hu (zhu6@ncsu.edu)

===Relevant Files===

config/locales/

* en.yml

* hi_IN.yml

config/

* routes.rb
* application.rb

app/controllers/
* applcation_controller.rb

Student View Files:

* app/views/
** shared/
*** _navigation.html.erb
** sign_up_sheet/
*** _suggested_topic.html.erb
*** _table_header.html.erb
*** list.html.erb
** student_task/
*** list.html.erb
*** view.html.erb
*** _publishing_rights.html.erb
** student_teams/
*** edit.html.erb
*** view.html.erb
** submitted_content/
*** _hyperlink.html.erb
*** _main.html.erb
*** _self_review.html.erb
*** _submitted_files.html.erb
*** _title.html.erb
*** edit.html.erb
** grades/
*** view_my_scores.html.erb
*** view_team.html.erb
** student_review/
*** list.html.erb
*** _responses.html.erb
*** _set_dynamic_review.html.erb
** participants/
*** change_handle.html.erb

== Project Description ==

Currently Expertiza only supports the English language. Many students are from other countries. So, we aimed to allow them to view their pages in another language. This is done by internationalizing static strings in Expertiza for Student Assignment related pages to another language (ex: Hindi or Chinese). Students had the ability to change the language through a dropdown located in navigation bar at the top of the page. We did not affect any strings that are dynamically shown. We focused on adding the Hindi language as a lot of students are Indian.

== Project Design ==

===Technical Design===

====Allowing Student to change language for Assignment Pages====

* We added a dropdown in the navigation bar for a student to use
* They are able to choose from English or Hindi
* [[File: Internationalization Navigation dropdown 2.JPG]]
* When the language is clicked on it changed all the static strings in the Student Views related to Assignments to the newly selected language.
* Students could also manually change the language in the URL themselves by. The language is put before the page name. Example: www.example.com/en/book -> www.example.com/hi_IN/book

====Adding Multi-Language Support====

* For this project, we added support for one language, Hindi.
* We used Google Translate to convert the strings to Hindi.
* We used the [https://guides.rubyonrails.org/i18n.html#how-i18n-in-ruby-on-rails-works Rails Internationalization (I18n) API] to help us add multi language support.
* There are two <code>yml</code> files in the <code>config/locales</code> directory representing the different languages that can be used in Expertiza.
** One for English, which will be the default language used, and another for Hindi.
*** <code>en.yml</code>
*** <code>hi_IN.yml</code>
** These <code>yaml</code> files contained the translated strings for their respective language.
* We editied the <code>routes.rb, application.rb, application_controller.rb</code> files and all the view files related to Student Assignments (which you can see at the top of the wiki) so that it can read from the <code>yml</code> files to show other languages.
------------------------------
* <code>application.rb</code>
** We've added the following two lines in the Recaptcha module of this file:
<code>
config.i18n.available_locales = [:en,:hi_IN]
</code>
* This tells the application all the available locale <code>.yml</code> files that are supported. If you wanted to add more language support, you can just add it to the list shown here.
<code>
config.i18n.default_locale = :en
</code>
* The sets the default language for the application. Which in this case is English.
----------------------------
* <code>application_controller.rb</code>
** We added the following to this file to get translations to work:
<code>
before_action :set_locale
</code>
* This will call the set_locale method
<code>
def set_locale
I18n.locale = params[:locale] || I18n.default_locale
end
</code>
* This sets the locale (language to use) for the application. The locale is taken from the URL query params list. If none is given, then it defaults to our default locale file (which is English). The application will always default to English and it won't pull from params until another language is chosen from the dropdown and sets :locale to something else.
<code>
def default_url_options(options={})
{locale: I18n.locale}.merge options
end
</code>
* This makes the URL always have a locale, which is set in the set_locale method, in it. This way the user doesn't have to manually enter a locale in the URL to translate the page. However, it adds the locale to the end of the URL like this: www.example.com/book/?locale=en. This is not something we want as it doesn't look good. This is fixed with routes.rb
-----------------------------
* <code> routes.rb </code>
** We wrapped the file in <code> routes.rb </code> with a <code>scope:</code> so that the locale can be added before the page name in the URL. Something like this: www.example.com/en/book
** [[File:Internationalization Route rb 2.JPG]]
*** the code at the top prevents a Routing Error when you go to a page and don't specify the locale (www.example.com/book) and it allows the default locale to be used. It knows the available locales from line <code>/#{I18n.available_locales.join("|")} </code>. <code> available_locales </code> was set in the <code>application.rb</code> file
----------------------------
* <code>.yml</code> Files
** <code>.yml</code> files know to look at the <code>view</code> folder when looking for keys to show
** Because of that, <code>.yml</code> files are structured in a hierarchy as shown below:
<code>
locale_name:
folder_name:
html_page_name:
key_name_for_string:
</code>
* Below is a sample for how we formatted our two locale files
<code>
en:
student_task:
list:
assignments: "Assignments"
</code>
<code>
hi_IN:
student_task:
list:
assignments: "असाइनमेंट"
</code>
* <code>student_task</code> is the folder under views: <code>views/student_task</code>
* list is the name of the html page: <code>view/student_task/list.html.erb</code>
* assignments is the key that replaces the word "Assignments" in the code (see next section).
* If more keys are added, they would need to be added in this format

*
----------------------------
* Student Views were translated as shown below:
** Regular Static Strings
*** Take any static, hard coded strings, like this one: <nowiki><h1> Assignments </h1></nowiki>, and replace "Assignment", with <code><%=t ".key_name" %></code>
*** The new code would look like this <nowiki><h1><%=t ".key_name" %></h1> </nowiki>
*** <code> key_name </code> comes from the key in the <code>.yml</code> files. The locale variable (en or hi_IN) would determine which one it pulls from.
*** This is how you would change the strings for an html page.
** Static strings for buttons, dropdowns, etc.
*** You can also translate static string field values that you would find in buttons, dropdowns, etc. When you change these types of strings, you need slightly different code to translate it.
*** Example: <code><%= submit_tag 'Save' %> </code>. You would replace 'Save' with <code>t('.key_name')</code>.
*** It would now look like this <code> <%= submit_tag t('.key_name') %></code>
** Other Info
*** Because the <code>.yml</code> know what view folders to look in when choosing the keys, when you type . for the key_namefor the translation code (shown above), it will show the list of keys available for the html page you are in, at least in RubyMine.
*** Reference keys in other html files (Look at below code for example)
**** You can reference keys under from another html file within the same sub view folder.
***** For example, you can reference the key <code>select_assignment</code> from the <code>view/student_task/view.html.erb</code> in <code>view/student_task/list.html.erb</code> by doing <code><%=t ".view.select_assignment" %></code> for a static string in <code>view/student_task/list.html.erb</code>
**** You can reference keys from another html file in a different sub view folder
***** For example, you can reference the key <code>sign_up</code> from <code>view/publishing/view.html.erb</code> in <code>view/student_task/list.html.erb</code> from by doing <code><%=t ".publishing.view.sign_up" %></code> for a static string in <code>view/student_task/list.html.erb</code>
**** By referencing keys not in the html file you are working on, you can reduce duplicate key names.

<code>
en:
student_task
list:
assignment: "Assignment"
view:
select_assignment: "Select Assignment"
publishing
view:
sign_up: "Sign Up"
</code>

===Example Output===

====Original Page====
[[File:Internationalization ssignment main page.JPG]]

====Translated Page====

[[File:Internationalization assignment main translated page.JPG]]

===Test Plan===

====Student Credentials====
username: student1016 or student[4000-8000]

password: password

====Before Testing====

* When going between pages, use the Back button link located on the bottom of pages, not on the browser
* When going to the main Assignment page, use the Back button link to get there to test out the scenarios below, not the link in the navigation bar.

====Scenario 1====

1. Log in to Expertiza as a student.

2. Go to language dropdown in the navigation bar and choose Hindi.

3. Check if language is changed in the URL from en to hi_IN

4. Check to see if the English strings on the page are translated to Hindi

5. While still logged in as a Student, check if the other Assignment related pages are also translated.

====Scenario 2====

1. Log in to Expertiza as a student.

2. Go to language dropdown in the navigation bar and choose Hindi.

3. Check if language is changed in the URL from en to hi_IN

4. Check to see if the English strings on the page are translated to Hindi

5. While still logged in as a Student, check if the other Assignment related pages are also translated.

6. Go back to the main Assignment page and choose English from the dropdown.

7. See if the language was changed in the URL to en.

8. See if the strings are translated back to English for all Assignment related pages.

====Scenario 3====

1. Log in to Expertiza as a student.

2. Go to URL and change the language from en to hi_IN.

3. Check to see if the English strings on the page are translated to Hindi.

4. While still logged in as a Student, check if the other Assignment related pages are also translated.

====Scenario 4====

1. Log in to Expertiza as a student.

2. Go to URL and change the language from en to hi_IN.

3. Check to see if the English strings on the page are translated to Hindi.

4. While still logged in as a Student, check if the other Assignment related pages are also translated.

5. Now change the language back from hi_IN to en in the URL.

6. See if the Hindi strings are translated back to English for all Assignment related pages.

==Future Work==

Due to time, there were some things we weren't able to fix or work on.
* Problems:
** When a student goes back to the main Assignment page, views/student_task/list, by clicking the link in the navigation bar, the language locale doesn't appear in the URL. This means that if you did change the language from the dropdown or manually, it will go back to the default locale language. See the URL below:
*** [[File:Internationalization assignment link langauge error.JPG]]
** If you try to use the language dropdown in a page other than the main Assignment page, it will give an error like the one shown below:
*** [[File:Internationalization langauge dropdown error.JPG]]
** But if you manually change the language in the URL, it works fine and persists as you navigate through the pages.
* Feature:
** We also have translated keys for many course pages, but did not implement the actual translation code in the view files for them. You should be able to look at the keys to find out which view files they are.
** Adding translation for Chinese.
*Additional Considerations(After our discussion during presentation):
**A future team needs to add support for dynamic text. Our project was only concerned with Expertiza's static text. The dynamic text needs to change too for a completely seamless end user experience.
**When generating translations, one must consider the differences in sentence structure between languages. In many cases throughout Expertiza we see the following pattern: <static_text><dynamic_text><static_text>. This is a difficult case to handle. What looks like a natural break in sentence structure in one language may not look natural in another. Dr. Gehringer mentioned the possibility of having that location of the dynamic text also be able to change between locales. This needs to be investigated by a future team. That may require a different API, or generating an entirely separate view for each locale(not ideal).
**When dealing with dynamic text two approaches need to be investigated(in addition to researching API suppport):
***Query the model in its default locale and attempt to match the string with a translation after retrieval(ideal). This would be the preferred approach. We don't want to have to alter our model to alter our translations. Barring API support, this might present complicated view code, but would be preferable to created dependency between the model and the translation.
***Store separate text fields in the model for each locale(not ideal). This is something we want to avoid. We should not be altering the model to add functionality to our views.
**The student16 login used to test Expertiza needs more work. Some student views are inaccessible due to a lack of inbuilt data. This makes testing more difficult to accomplish.

== Links/References ==

===Project Links===

* Pull Request: https://github.com/expertiza/expertiza/pull/1286
* Github: https://github.com/mukhtar23/expertiza
* Video: https://youtu.be/TA9PkcK61QM

===Support Material===
* [https://guides.rubyonrails.org/i18n.html#how-i18n-in-ruby-on-rails-works https://guides.rubyonrails.org/i18n.html#how-i18n-in-ruby-on-rails-works]
* [https://guides.rubyonrails.org/i18n.html#setting-the-locale-from-url-params https://guides.rubyonrails.org/i18n.html#setting-the-locale-from-url-params]
* [https://guides.rubyonrails.org/i18n.html#abstracting-localized-code https://guides.rubyonrails.org/i18n.html#abstracting-localized-code]
* [https://guides.rubyonrails.org/i18n.html#providing-translations-for-internationalized-strings https://guides.rubyonrails.org/i18n.html#providing-translations-for-internationalized-strings]
* [https://guides.rubyonrails.org/i18n.html#passing-variables-to-translations https://guides.rubyonrails.org/i18n.html#passing-variables-to-translations]

* [https://www.youtube.com/watch?v=HLb0hEgrXTc https://www.youtube.com/watch?v=HLb0hEgrXTc]
* [https://phraseapp.com/blog/posts/rails-i18n-guide/ https://phraseapp.com/blog/posts/rails-i18n-guide/]

CSC/ECE 517 Fall 2018/E1866 Expertiza Internationalization

2018-12-15T02:53:51Z

Jtgill: /* Future Work */

== Introduction ==

===Team Members===

Jonathan Gill (jtgill@ncsu.edu)

Hasham Mukhtar (hmukhta@ncsu.edu)

Abhilasha Saini (asaini4@ncsu.edu)

Reddy Aravind Karnam Ganesh (rkarnam@ncsu.edu)

=== Mentor ===

Zhewei Hu (zhu6@ncsu.edu)

===Relevant Files===

config/locales/

* en.yml

* hi_IN.yml

config/

* routes.rb
* application.rb

app/controllers/
* applcation_controller.rb

Student View Files:

* app/views/
** shared/
*** _navigation.html.erb
** sign_up_sheet/
*** _suggested_topic.html.erb
*** _table_header.html.erb
*** list.html.erb
** student_task/
*** list.html.erb
*** view.html.erb
*** _publishing_rights.html.erb
** student_teams/
*** edit.html.erb
*** view.html.erb
** submitted_content/
*** _hyperlink.html.erb
*** _main.html.erb
*** _self_review.html.erb
*** _submitted_files.html.erb
*** _title.html.erb
*** edit.html.erb
** grades/
*** view_my_scores.html.erb
*** view_team.html.erb
** student_review/
*** list.html.erb
*** _responses.html.erb
*** _set_dynamic_review.html.erb
** participants/
*** change_handle.html.erb

== Project Description ==

Currently Expertiza only supports the English language. Many students are from other countries. So, we aimed to allow them to view their pages in another language. This is done by internationalizing static strings in Expertiza for Student Assignment related pages to another language (ex: Hindi or Chinese). Students had the ability to change the language through a dropdown located in navigation bar at the top of the page. We did not affect any strings that are dynamically shown. We focused on adding the Hindi language as a lot of students are Indian.

== Project Design ==

===Technical Design===

====Allowing Student to change language for Assignment Pages====

* We added a dropdown in the navigation bar for a student to use
* They are able to choose from English or Hindi
* [[File: Internationalization Navigation dropdown 2.JPG]]
* When the language is clicked on it changed all the static strings in the Student Views related to Assignments to the newly selected language.
* Students could also manually change the language in the URL themselves by. The language is put before the page name. Example: www.example.com/en/book -> www.example.com/hi_IN/book

====Adding Multi-Language Support====

* For this project, we added support for one language, Hindi.
* We used Google Translate to convert the strings to Hindi.
* We used the [https://guides.rubyonrails.org/i18n.html#how-i18n-in-ruby-on-rails-works Rails Internationalization (I18n) API] to help us add multi language support.
* There are two <code>yml</code> files in the <code>config/locales</code> directory representing the different languages that can be used in Expertiza.
** One for English, which will be the default language used, and another for Hindi.
*** <code>en.yml</code>
*** <code>hi_IN.yml</code>
** These <code>yaml</code> files contained the translated strings for their respective language.
* We editied the <code>routes.rb, application.rb, application_controller.rb</code> files and all the view files related to Student Assignments (which you can see at the top of the wiki) so that it can read from the <code>yml</code> files to show other languages.
------------------------------
* <code>application.rb</code>
** We've added the following two lines in the Recaptcha module of this file:
<code>
config.i18n.available_locales = [:en,:hi_IN]
</code>
* This tells the application all the available locale <code>.yml</code> files that are supported. If you wanted to add more language support, you can just add it to the list shown here.
<code>
config.i18n.default_locale = :en
</code>
* The sets the default language for the application. Which in this case is English.
----------------------------
* <code>application_controller.rb</code>
** We added the following to this file to get translations to work:
<code>
before_action :set_locale
</code>
* This will call the set_locale method
<code>
def set_locale
I18n.locale = params[:locale] || I18n.default_locale
end
</code>
* This sets the locale (language to use) for the application. The locale is taken from the URL query params list. If none is given, then it defaults to our default locale file (which is English). The application will always default to English and it won't pull from params until another language is chosen from the dropdown and sets :locale to something else.
<code>
def default_url_options(options={})
{locale: I18n.locale}.merge options
end
</code>
* This makes the URL always have a locale, which is set in the set_locale method, in it. This way the user doesn't have to manually enter a locale in the URL to translate the page. However, it adds the locale to the end of the URL like this: www.example.com/book/?locale=en. This is not something we want as it doesn't look good. This is fixed with routes.rb
-----------------------------
* <code> routes.rb </code>
** We wrapped the file in <code> routes.rb </code> with a <code>scope:</code> so that the locale can be added before the page name in the URL. Something like this: www.example.com/en/book
** [[File:Internationalization Route rb 2.JPG]]
*** the code at the top prevents a Routing Error when you go to a page and don't specify the locale (www.example.com/book) and it allows the default locale to be used. It knows the available locales from line <code>/#{I18n.available_locales.join("|")} </code>. <code> available_locales </code> was set in the <code>application.rb</code> file
----------------------------
* <code>.yml</code> Files
** <code>.yml</code> files know to look at the <code>view</code> folder when looking for keys to show
** Because of that, <code>.yml</code> files are structured in a hierarchy as shown below:
<code>
locale_name:
folder_name:
html_page_name:
key_name_for_string:
</code>
* Below is a sample for how we formatted our two locale files
<code>
en:
student_task:
list:
assignments: "Assignments"
</code>
<code>
hi_IN:
student_task:
list:
assignments: "असाइनमेंट"
</code>
* <code>student_task</code> is the folder under views: <code>views/student_task</code>
* list is the name of the html page: <code>view/student_task/list.html.erb</code>
* assignments is the key that replaces the word "Assignments" in the code (see next section).
* If more keys are added, they would need to be added in this format

*
----------------------------
* Student Views were translated as shown below:
** Regular Static Strings
*** Take any static, hard coded strings, like this one: <nowiki><h1> Assignments </h1></nowiki>, and replace "Assignment", with <code><%=t ".key_name" %></code>
*** The new code would look like this <nowiki><h1><%=t ".key_name" %></h1> </nowiki>
*** <code> key_name </code> comes from the key in the <code>.yml</code> files. The locale variable (en or hi_IN) would determine which one it pulls from.
*** This is how you would change the strings for an html page.
** Static strings for buttons, dropdowns, etc.
*** You can also translate static string field values that you would find in buttons, dropdowns, etc. When you change these types of strings, you need slightly different code to translate it.
*** Example: <code><%= submit_tag 'Save' %> </code>. You would replace 'Save' with <code>t('.key_name')</code>.
*** It would now look like this <code> <%= submit_tag t('.key_name') %></code>
** Other Info
*** Because the <code>.yml</code> know what view folders to look in when choosing the keys, when you type . for the key_namefor the translation code (shown above), it will show the list of keys available for the html page you are in, at least in RubyMine.
*** Reference keys in other html files (Look at below code for example)
**** You can reference keys under from another html file within the same sub view folder.
***** For example, you can reference the key <code>select_assignment</code> from the <code>view/student_task/view.html.erb</code> in <code>view/student_task/list.html.erb</code> by doing <code><%=t ".view.select_assignment" %></code> for a static string in <code>view/student_task/list.html.erb</code>
**** You can reference keys from another html file in a different sub view folder
***** For example, you can reference the key <code>sign_up</code> from <code>view/publishing/view.html.erb</code> in <code>view/student_task/list.html.erb</code> from by doing <code><%=t ".publishing.view.sign_up" %></code> for a static string in <code>view/student_task/list.html.erb</code>
**** By referencing keys not in the html file you are working on, you can reduce duplicate key names.

<code>
en:
student_task
list:
assignment: "Assignment"
view:
select_assignment: "Select Assignment"
publishing
view:
sign_up: "Sign Up"
</code>

===Example Output===

====Original Page====
[[File:Internationalization ssignment main page.JPG]]

====Translated Page====

[[File:Internationalization assignment main translated page.JPG]]

===Test Plan===

====Student Credentials====
username: student1016 or student[4000-8000]

password: password

====Before Testing====

* When going between pages, use the Back button link located on the bottom of pages, not on the browser
* When going to the main Assignment page, use the Back button link to get there to test out the scenarios below, not the link in the navigation bar.

====Scenario 1====

1. Log in to Expertiza as a student.

2. Go to language dropdown in the navigation bar and choose Hindi.

3. Check if language is changed in the URL from en to hi_IN

4. Check to see if the English strings on the page are translated to Hindi

5. While still logged in as a Student, check if the other Assignment related pages are also translated.

====Scenario 2====

1. Log in to Expertiza as a student.

2. Go to language dropdown in the navigation bar and choose Hindi.

3. Check if language is changed in the URL from en to hi_IN

4. Check to see if the English strings on the page are translated to Hindi

5. While still logged in as a Student, check if the other Assignment related pages are also translated.

6. Go back to the main Assignment page and choose English from the dropdown.

7. See if the language was changed in the URL to en.

8. See if the strings are translated back to English for all Assignment related pages.

====Scenario 3====

1. Log in to Expertiza as a student.

2. Go to URL and change the language from en to hi_IN.

3. Check to see if the English strings on the page are translated to Hindi.

4. While still logged in as a Student, check if the other Assignment related pages are also translated.

====Scenario 4====

1. Log in to Expertiza as a student.

2. Go to URL and change the language from en to hi_IN.

3. Check to see if the English strings on the page are translated to Hindi.

4. While still logged in as a Student, check if the other Assignment related pages are also translated.

5. Now change the language back from hi_IN to en in the URL.

6. See if the Hindi strings are translated back to English for all Assignment related pages.

==Future Work==

Due to time, there were some things we weren't able to fix or work on.
* Problems:
** When a student goes back to the main Assignment page, views/student_task/list, by clicking the link in the navigation bar, the language locale doesn't appear in the URL. This means that if you did change the language from the dropdown or manually, it will go back to the default locale language. See the URL below:
*** [[File:Internationalization assignment link langauge error.JPG]]
** If you try to use the language dropdown in a page other than the main Assignment page, it will give an error like the one shown below:
*** [[File:Internationalization langauge dropdown error.JPG]]
** But if you manually change the language in the URL, it works fine and persists as you navigate through the pages.
* Feature:
** We also have translated keys for many course pages, but did not implement the actual translation code in the view files for them. You should be able to look at the keys to find out which view files they are.
** Adding translation for Chinese.
*Additional Considerations(After our discussion during presentation):
**A future team needs to add support for dynamic text. Our project was only concerned with Expertiza's static text. The dynamic text needs to change too for a completely seamless end user experience.
**When generating translations, one must consider the differences in sentence structure between languages. In many cases throughout Expertiza we see the following pattern: <static_text><dynamic_text><static_text>. This is a difficult case to handle. What looks like a natural break in sentence structure in one language may not look natural in another. Dr. Gehringer mentioned the possibility of having that location of the dynamic text also be able to change between locales. This needs to be investigated by a future team. That may require a different API, or generating an entirely separate view for each locale(not ideal).
**When dealing with dynamic text two approaches need to be investigated(in addition to researching API suppport):
***Query the model in its default locale and attempt to match the string with a translation after retrieval(ideal). This would be the preferred approach. We don't want to have to alter our model to alter our translations. Barring API support, this might present complicated view code, but would be preferable to created dependency between the model and the translation.
***Store separate text fields in the model for each locale(not ideal). This is something we want to avoid. We should not be altering the model to add functionality to our views.
**The student16 login used to test Expertiza needs more work. Some pages needed to test our project were inaccessible due to a lack of inbuilt data.

== Links/References ==

===Project Links===

* Pull Request: https://github.com/expertiza/expertiza/pull/1286
* Github: https://github.com/mukhtar23/expertiza
* Video: https://youtu.be/TA9PkcK61QM

===Support Material===
* [https://guides.rubyonrails.org/i18n.html#how-i18n-in-ruby-on-rails-works https://guides.rubyonrails.org/i18n.html#how-i18n-in-ruby-on-rails-works]
* [https://guides.rubyonrails.org/i18n.html#setting-the-locale-from-url-params https://guides.rubyonrails.org/i18n.html#setting-the-locale-from-url-params]
* [https://guides.rubyonrails.org/i18n.html#abstracting-localized-code https://guides.rubyonrails.org/i18n.html#abstracting-localized-code]
* [https://guides.rubyonrails.org/i18n.html#providing-translations-for-internationalized-strings https://guides.rubyonrails.org/i18n.html#providing-translations-for-internationalized-strings]
* [https://guides.rubyonrails.org/i18n.html#passing-variables-to-translations https://guides.rubyonrails.org/i18n.html#passing-variables-to-translations]

* [https://www.youtube.com/watch?v=HLb0hEgrXTc https://www.youtube.com/watch?v=HLb0hEgrXTc]
* [https://phraseapp.com/blog/posts/rails-i18n-guide/ https://phraseapp.com/blog/posts/rails-i18n-guide/]

CSC/ECE 517 Fall 2018/E1866 Expertiza Internationalization

2018-12-15T02:51:51Z

Jtgill: /* Future Work */

== Introduction ==

===Team Members===

Jonathan Gill (jtgill@ncsu.edu)

Hasham Mukhtar (hmukhta@ncsu.edu)

Abhilasha Saini (asaini4@ncsu.edu)

Reddy Aravind Karnam Ganesh (rkarnam@ncsu.edu)

=== Mentor ===

Zhewei Hu (zhu6@ncsu.edu)

===Relevant Files===

config/locales/

* en.yml

* hi_IN.yml

config/

* routes.rb
* application.rb

app/controllers/
* applcation_controller.rb

Student View Files:

* app/views/
** shared/
*** _navigation.html.erb
** sign_up_sheet/
*** _suggested_topic.html.erb
*** _table_header.html.erb
*** list.html.erb
** student_task/
*** list.html.erb
*** view.html.erb
*** _publishing_rights.html.erb
** student_teams/
*** edit.html.erb
*** view.html.erb
** submitted_content/
*** _hyperlink.html.erb
*** _main.html.erb
*** _self_review.html.erb
*** _submitted_files.html.erb
*** _title.html.erb
*** edit.html.erb
** grades/
*** view_my_scores.html.erb
*** view_team.html.erb
** student_review/
*** list.html.erb
*** _responses.html.erb
*** _set_dynamic_review.html.erb
** participants/
*** change_handle.html.erb

== Project Description ==

Currently Expertiza only supports the English language. Many students are from other countries. So, we aimed to allow them to view their pages in another language. This is done by internationalizing static strings in Expertiza for Student Assignment related pages to another language (ex: Hindi or Chinese). Students had the ability to change the language through a dropdown located in navigation bar at the top of the page. We did not affect any strings that are dynamically shown. We focused on adding the Hindi language as a lot of students are Indian.

== Project Design ==

===Technical Design===

====Allowing Student to change language for Assignment Pages====

* We added a dropdown in the navigation bar for a student to use
* They are able to choose from English or Hindi
* [[File: Internationalization Navigation dropdown 2.JPG]]
* When the language is clicked on it changed all the static strings in the Student Views related to Assignments to the newly selected language.
* Students could also manually change the language in the URL themselves by. The language is put before the page name. Example: www.example.com/en/book -> www.example.com/hi_IN/book

====Adding Multi-Language Support====

* For this project, we added support for one language, Hindi.
* We used Google Translate to convert the strings to Hindi.
* We used the [https://guides.rubyonrails.org/i18n.html#how-i18n-in-ruby-on-rails-works Rails Internationalization (I18n) API] to help us add multi language support.
* There are two <code>yml</code> files in the <code>config/locales</code> directory representing the different languages that can be used in Expertiza.
** One for English, which will be the default language used, and another for Hindi.
*** <code>en.yml</code>
*** <code>hi_IN.yml</code>
** These <code>yaml</code> files contained the translated strings for their respective language.
* We editied the <code>routes.rb, application.rb, application_controller.rb</code> files and all the view files related to Student Assignments (which you can see at the top of the wiki) so that it can read from the <code>yml</code> files to show other languages.
------------------------------
* <code>application.rb</code>
** We've added the following two lines in the Recaptcha module of this file:
<code>
config.i18n.available_locales = [:en,:hi_IN]
</code>
* This tells the application all the available locale <code>.yml</code> files that are supported. If you wanted to add more language support, you can just add it to the list shown here.
<code>
config.i18n.default_locale = :en
</code>
* The sets the default language for the application. Which in this case is English.
----------------------------
* <code>application_controller.rb</code>
** We added the following to this file to get translations to work:
<code>
before_action :set_locale
</code>
* This will call the set_locale method
<code>
def set_locale
I18n.locale = params[:locale] || I18n.default_locale
end
</code>
* This sets the locale (language to use) for the application. The locale is taken from the URL query params list. If none is given, then it defaults to our default locale file (which is English). The application will always default to English and it won't pull from params until another language is chosen from the dropdown and sets :locale to something else.
<code>
def default_url_options(options={})
{locale: I18n.locale}.merge options
end
</code>
* This makes the URL always have a locale, which is set in the set_locale method, in it. This way the user doesn't have to manually enter a locale in the URL to translate the page. However, it adds the locale to the end of the URL like this: www.example.com/book/?locale=en. This is not something we want as it doesn't look good. This is fixed with routes.rb
-----------------------------
* <code> routes.rb </code>
** We wrapped the file in <code> routes.rb </code> with a <code>scope:</code> so that the locale can be added before the page name in the URL. Something like this: www.example.com/en/book
** [[File:Internationalization Route rb 2.JPG]]
*** the code at the top prevents a Routing Error when you go to a page and don't specify the locale (www.example.com/book) and it allows the default locale to be used. It knows the available locales from line <code>/#{I18n.available_locales.join("|")} </code>. <code> available_locales </code> was set in the <code>application.rb</code> file
----------------------------
* <code>.yml</code> Files
** <code>.yml</code> files know to look at the <code>view</code> folder when looking for keys to show
** Because of that, <code>.yml</code> files are structured in a hierarchy as shown below:
<code>
locale_name:
folder_name:
html_page_name:
key_name_for_string:
</code>
* Below is a sample for how we formatted our two locale files
<code>
en:
student_task:
list:
assignments: "Assignments"
</code>
<code>
hi_IN:
student_task:
list:
assignments: "असाइनमेंट"
</code>
* <code>student_task</code> is the folder under views: <code>views/student_task</code>
* list is the name of the html page: <code>view/student_task/list.html.erb</code>
* assignments is the key that replaces the word "Assignments" in the code (see next section).
* If more keys are added, they would need to be added in this format

*
----------------------------
* Student Views were translated as shown below:
** Regular Static Strings
*** Take any static, hard coded strings, like this one: <nowiki><h1> Assignments </h1></nowiki>, and replace "Assignment", with <code><%=t ".key_name" %></code>
*** The new code would look like this <nowiki><h1><%=t ".key_name" %></h1> </nowiki>
*** <code> key_name </code> comes from the key in the <code>.yml</code> files. The locale variable (en or hi_IN) would determine which one it pulls from.
*** This is how you would change the strings for an html page.
** Static strings for buttons, dropdowns, etc.
*** You can also translate static string field values that you would find in buttons, dropdowns, etc. When you change these types of strings, you need slightly different code to translate it.
*** Example: <code><%= submit_tag 'Save' %> </code>. You would replace 'Save' with <code>t('.key_name')</code>.
*** It would now look like this <code> <%= submit_tag t('.key_name') %></code>
** Other Info
*** Because the <code>.yml</code> know what view folders to look in when choosing the keys, when you type . for the key_namefor the translation code (shown above), it will show the list of keys available for the html page you are in, at least in RubyMine.
*** Reference keys in other html files (Look at below code for example)
**** You can reference keys under from another html file within the same sub view folder.
***** For example, you can reference the key <code>select_assignment</code> from the <code>view/student_task/view.html.erb</code> in <code>view/student_task/list.html.erb</code> by doing <code><%=t ".view.select_assignment" %></code> for a static string in <code>view/student_task/list.html.erb</code>
**** You can reference keys from another html file in a different sub view folder
***** For example, you can reference the key <code>sign_up</code> from <code>view/publishing/view.html.erb</code> in <code>view/student_task/list.html.erb</code> from by doing <code><%=t ".publishing.view.sign_up" %></code> for a static string in <code>view/student_task/list.html.erb</code>
**** By referencing keys not in the html file you are working on, you can reduce duplicate key names.

<code>
en:
student_task
list:
assignment: "Assignment"
view:
select_assignment: "Select Assignment"
publishing
view:
sign_up: "Sign Up"
</code>

===Example Output===

====Original Page====
[[File:Internationalization ssignment main page.JPG]]

====Translated Page====

[[File:Internationalization assignment main translated page.JPG]]

===Test Plan===

====Student Credentials====
username: student1016 or student[4000-8000]

password: password

====Before Testing====

* When going between pages, use the Back button link located on the bottom of pages, not on the browser
* When going to the main Assignment page, use the Back button link to get there to test out the scenarios below, not the link in the navigation bar.

====Scenario 1====

1. Log in to Expertiza as a student.

2. Go to language dropdown in the navigation bar and choose Hindi.

3. Check if language is changed in the URL from en to hi_IN

4. Check to see if the English strings on the page are translated to Hindi

5. While still logged in as a Student, check if the other Assignment related pages are also translated.

====Scenario 2====

1. Log in to Expertiza as a student.

2. Go to language dropdown in the navigation bar and choose Hindi.

3. Check if language is changed in the URL from en to hi_IN

4. Check to see if the English strings on the page are translated to Hindi

5. While still logged in as a Student, check if the other Assignment related pages are also translated.

6. Go back to the main Assignment page and choose English from the dropdown.

7. See if the language was changed in the URL to en.

8. See if the strings are translated back to English for all Assignment related pages.

====Scenario 3====

1. Log in to Expertiza as a student.

2. Go to URL and change the language from en to hi_IN.

3. Check to see if the English strings on the page are translated to Hindi.

4. While still logged in as a Student, check if the other Assignment related pages are also translated.

====Scenario 4====

1. Log in to Expertiza as a student.

2. Go to URL and change the language from en to hi_IN.

3. Check to see if the English strings on the page are translated to Hindi.

4. While still logged in as a Student, check if the other Assignment related pages are also translated.

5. Now change the language back from hi_IN to en in the URL.

6. See if the Hindi strings are translated back to English for all Assignment related pages.

==Future Work==

Due to time, there were some things we weren't able to fix or work on.
* Problems:
** When a student goes back to the main Assignment page, views/student_task/list, by clicking the link in the navigation bar, the language locale doesn't appear in the URL. This means that if you did change the language from the dropdown or manually, it will go back to the default locale language. See the URL below:
*** [[File:Internationalization assignment link langauge error.JPG]]
** If you try to use the language dropdown in a page other than the main Assignment page, it will give an error like the one shown below:
*** [[File:Internationalization langauge dropdown error.JPG]]
** But if you manually change the language in the URL, it works fine and persists as you navigate through the pages.
* Feature:
** We also have translated keys for many course pages, but did not implement the actual translation code in the view files for them. You should be able to look at the keys to find out which view files they are.
** Adding translation for Chinese.
*Additional Considerations(After our discussion during presentation):
**A future team needs to add support for dynamic text. Our project was only concerned with Expertiza's static text. The dynamic text needs to change too for a completely seamless end user experience.
**When generating translations, one must consider the differences in sentence structure between languages. In many cases throughout Expertiza we see the following pattern: <static_text><dynamic_text><static_text>. This is a difficult case to handle. What looks like a natural break in sentence structure in one language may not look natural in another. Dr. Gehringer mentioned the possibility of having that location of the dynamic text also be able to change between locales. This needs to be investigated by a future team. That may require a different API, or generating an entirely separate view for each locale(not ideal).
**When dealing with dynamic text two approaches need to be investigated(in addition to researching API suppport):
***Query the model in its default locale and attempt to match the string with a translation after retrieval(ideal). This would be the preferred approach. We don't want to have to alter our model to alter our translations. Barring API support, this might present complicated view code, but would be preferable to created dependency between the model and the translation.
***Store separate text fields in the model for each locale(not ideal). This is something we want to avoid. We should not be altering the model to add functionality to our views.

== Links/References ==

===Project Links===

* Pull Request: https://github.com/expertiza/expertiza/pull/1286
* Github: https://github.com/mukhtar23/expertiza
* Video: https://youtu.be/TA9PkcK61QM

===Support Material===
* [https://guides.rubyonrails.org/i18n.html#how-i18n-in-ruby-on-rails-works https://guides.rubyonrails.org/i18n.html#how-i18n-in-ruby-on-rails-works]
* [https://guides.rubyonrails.org/i18n.html#setting-the-locale-from-url-params https://guides.rubyonrails.org/i18n.html#setting-the-locale-from-url-params]
* [https://guides.rubyonrails.org/i18n.html#abstracting-localized-code https://guides.rubyonrails.org/i18n.html#abstracting-localized-code]
* [https://guides.rubyonrails.org/i18n.html#providing-translations-for-internationalized-strings https://guides.rubyonrails.org/i18n.html#providing-translations-for-internationalized-strings]
* [https://guides.rubyonrails.org/i18n.html#passing-variables-to-translations https://guides.rubyonrails.org/i18n.html#passing-variables-to-translations]

* [https://www.youtube.com/watch?v=HLb0hEgrXTc https://www.youtube.com/watch?v=HLb0hEgrXTc]
* [https://phraseapp.com/blog/posts/rails-i18n-guide/ https://phraseapp.com/blog/posts/rails-i18n-guide/]

CSC/ECE 517 Fall 2018/E1866 Expertiza Internationalization

2018-12-15T02:49:47Z

Jtgill: /* Future Work */

== Introduction ==

===Team Members===

Jonathan Gill (jtgill@ncsu.edu)

Hasham Mukhtar (hmukhta@ncsu.edu)

Abhilasha Saini (asaini4@ncsu.edu)

Reddy Aravind Karnam Ganesh (rkarnam@ncsu.edu)

=== Mentor ===

Zhewei Hu (zhu6@ncsu.edu)

===Relevant Files===

config/locales/

* en.yml

* hi_IN.yml

config/

* routes.rb
* application.rb

app/controllers/
* applcation_controller.rb

Student View Files:

* app/views/
** shared/
*** _navigation.html.erb
** sign_up_sheet/
*** _suggested_topic.html.erb
*** _table_header.html.erb
*** list.html.erb
** student_task/
*** list.html.erb
*** view.html.erb
*** _publishing_rights.html.erb
** student_teams/
*** edit.html.erb
*** view.html.erb
** submitted_content/
*** _hyperlink.html.erb
*** _main.html.erb
*** _self_review.html.erb
*** _submitted_files.html.erb
*** _title.html.erb
*** edit.html.erb
** grades/
*** view_my_scores.html.erb
*** view_team.html.erb
** student_review/
*** list.html.erb
*** _responses.html.erb
*** _set_dynamic_review.html.erb
** participants/
*** change_handle.html.erb

== Project Description ==

Currently Expertiza only supports the English language. Many students are from other countries. So, we aimed to allow them to view their pages in another language. This is done by internationalizing static strings in Expertiza for Student Assignment related pages to another language (ex: Hindi or Chinese). Students had the ability to change the language through a dropdown located in navigation bar at the top of the page. We did not affect any strings that are dynamically shown. We focused on adding the Hindi language as a lot of students are Indian.

== Project Design ==

===Technical Design===

====Allowing Student to change language for Assignment Pages====

* We added a dropdown in the navigation bar for a student to use
* They are able to choose from English or Hindi
* [[File: Internationalization Navigation dropdown 2.JPG]]
* When the language is clicked on it changed all the static strings in the Student Views related to Assignments to the newly selected language.
* Students could also manually change the language in the URL themselves by. The language is put before the page name. Example: www.example.com/en/book -> www.example.com/hi_IN/book

====Adding Multi-Language Support====

* For this project, we added support for one language, Hindi.
* We used Google Translate to convert the strings to Hindi.
* We used the [https://guides.rubyonrails.org/i18n.html#how-i18n-in-ruby-on-rails-works Rails Internationalization (I18n) API] to help us add multi language support.
* There are two <code>yml</code> files in the <code>config/locales</code> directory representing the different languages that can be used in Expertiza.
** One for English, which will be the default language used, and another for Hindi.
*** <code>en.yml</code>
*** <code>hi_IN.yml</code>
** These <code>yaml</code> files contained the translated strings for their respective language.
* We editied the <code>routes.rb, application.rb, application_controller.rb</code> files and all the view files related to Student Assignments (which you can see at the top of the wiki) so that it can read from the <code>yml</code> files to show other languages.
------------------------------
* <code>application.rb</code>
** We've added the following two lines in the Recaptcha module of this file:
<code>
config.i18n.available_locales = [:en,:hi_IN]
</code>
* This tells the application all the available locale <code>.yml</code> files that are supported. If you wanted to add more language support, you can just add it to the list shown here.
<code>
config.i18n.default_locale = :en
</code>
* The sets the default language for the application. Which in this case is English.
----------------------------
* <code>application_controller.rb</code>
** We added the following to this file to get translations to work:
<code>
before_action :set_locale
</code>
* This will call the set_locale method
<code>
def set_locale
I18n.locale = params[:locale] || I18n.default_locale
end
</code>
* This sets the locale (language to use) for the application. The locale is taken from the URL query params list. If none is given, then it defaults to our default locale file (which is English). The application will always default to English and it won't pull from params until another language is chosen from the dropdown and sets :locale to something else.
<code>
def default_url_options(options={})
{locale: I18n.locale}.merge options
end
</code>
* This makes the URL always have a locale, which is set in the set_locale method, in it. This way the user doesn't have to manually enter a locale in the URL to translate the page. However, it adds the locale to the end of the URL like this: www.example.com/book/?locale=en. This is not something we want as it doesn't look good. This is fixed with routes.rb
-----------------------------
* <code> routes.rb </code>
** We wrapped the file in <code> routes.rb </code> with a <code>scope:</code> so that the locale can be added before the page name in the URL. Something like this: www.example.com/en/book
** [[File:Internationalization Route rb 2.JPG]]
*** the code at the top prevents a Routing Error when you go to a page and don't specify the locale (www.example.com/book) and it allows the default locale to be used. It knows the available locales from line <code>/#{I18n.available_locales.join("|")} </code>. <code> available_locales </code> was set in the <code>application.rb</code> file
----------------------------
* <code>.yml</code> Files
** <code>.yml</code> files know to look at the <code>view</code> folder when looking for keys to show
** Because of that, <code>.yml</code> files are structured in a hierarchy as shown below:
<code>
locale_name:
folder_name:
html_page_name:
key_name_for_string:
</code>
* Below is a sample for how we formatted our two locale files
<code>
en:
student_task:
list:
assignments: "Assignments"
</code>
<code>
hi_IN:
student_task:
list:
assignments: "असाइनमेंट"
</code>
* <code>student_task</code> is the folder under views: <code>views/student_task</code>
* list is the name of the html page: <code>view/student_task/list.html.erb</code>
* assignments is the key that replaces the word "Assignments" in the code (see next section).
* If more keys are added, they would need to be added in this format

*
----------------------------
* Student Views were translated as shown below:
** Regular Static Strings
*** Take any static, hard coded strings, like this one: <nowiki><h1> Assignments </h1></nowiki>, and replace "Assignment", with <code><%=t ".key_name" %></code>
*** The new code would look like this <nowiki><h1><%=t ".key_name" %></h1> </nowiki>
*** <code> key_name </code> comes from the key in the <code>.yml</code> files. The locale variable (en or hi_IN) would determine which one it pulls from.
*** This is how you would change the strings for an html page.
** Static strings for buttons, dropdowns, etc.
*** You can also translate static string field values that you would find in buttons, dropdowns, etc. When you change these types of strings, you need slightly different code to translate it.
*** Example: <code><%= submit_tag 'Save' %> </code>. You would replace 'Save' with <code>t('.key_name')</code>.
*** It would now look like this <code> <%= submit_tag t('.key_name') %></code>
** Other Info
*** Because the <code>.yml</code> know what view folders to look in when choosing the keys, when you type . for the key_namefor the translation code (shown above), it will show the list of keys available for the html page you are in, at least in RubyMine.
*** Reference keys in other html files (Look at below code for example)
**** You can reference keys under from another html file within the same sub view folder.
***** For example, you can reference the key <code>select_assignment</code> from the <code>view/student_task/view.html.erb</code> in <code>view/student_task/list.html.erb</code> by doing <code><%=t ".view.select_assignment" %></code> for a static string in <code>view/student_task/list.html.erb</code>
**** You can reference keys from another html file in a different sub view folder
***** For example, you can reference the key <code>sign_up</code> from <code>view/publishing/view.html.erb</code> in <code>view/student_task/list.html.erb</code> from by doing <code><%=t ".publishing.view.sign_up" %></code> for a static string in <code>view/student_task/list.html.erb</code>
**** By referencing keys not in the html file you are working on, you can reduce duplicate key names.

<code>
en:
student_task
list:
assignment: "Assignment"
view:
select_assignment: "Select Assignment"
publishing
view:
sign_up: "Sign Up"
</code>

===Example Output===

====Original Page====
[[File:Internationalization ssignment main page.JPG]]

====Translated Page====

[[File:Internationalization assignment main translated page.JPG]]

===Test Plan===

====Student Credentials====
username: student1016 or student[4000-8000]

password: password

====Before Testing====

* When going between pages, use the Back button link located on the bottom of pages, not on the browser
* When going to the main Assignment page, use the Back button link to get there to test out the scenarios below, not the link in the navigation bar.

====Scenario 1====

1. Log in to Expertiza as a student.

2. Go to language dropdown in the navigation bar and choose Hindi.

3. Check if language is changed in the URL from en to hi_IN

4. Check to see if the English strings on the page are translated to Hindi

5. While still logged in as a Student, check if the other Assignment related pages are also translated.

====Scenario 2====

1. Log in to Expertiza as a student.

2. Go to language dropdown in the navigation bar and choose Hindi.

3. Check if language is changed in the URL from en to hi_IN

4. Check to see if the English strings on the page are translated to Hindi

5. While still logged in as a Student, check if the other Assignment related pages are also translated.

6. Go back to the main Assignment page and choose English from the dropdown.

7. See if the language was changed in the URL to en.

8. See if the strings are translated back to English for all Assignment related pages.

====Scenario 3====

1. Log in to Expertiza as a student.

2. Go to URL and change the language from en to hi_IN.

3. Check to see if the English strings on the page are translated to Hindi.

4. While still logged in as a Student, check if the other Assignment related pages are also translated.

====Scenario 4====

1. Log in to Expertiza as a student.

2. Go to URL and change the language from en to hi_IN.

3. Check to see if the English strings on the page are translated to Hindi.

4. While still logged in as a Student, check if the other Assignment related pages are also translated.

5. Now change the language back from hi_IN to en in the URL.

6. See if the Hindi strings are translated back to English for all Assignment related pages.

==Future Work==

Due to time, there were some things we weren't able to fix or work on.
* Problems:
** When a student goes back to the main Assignment page, views/student_task/list, by clicking the link in the navigation bar, the language locale doesn't appear in the URL. This means that if you did change the language from the dropdown or manually, it will go back to the default locale language. See the URL below:
*** [[File:Internationalization assignment link langauge error.JPG]]
** If you try to use the language dropdown in a page other than the main Assignment page, it will give an error like the one shown below:
*** [[File:Internationalization langauge dropdown error.JPG]]
** But if you manually change the language in the URL, it works fine and persists as you navigate through the pages.
* Feature:
** We also have translated keys for many course pages, but did not implement the actual translation code in the view files for them. You should be able to look at the keys to find out which view files they are.
** Adding translation for Chinese.
*Additional Considerations(After our discussion during presentation):
**A future team needs to add support for dynamic text. Our project was only concerned with Expertiza's static text. The dynamic text needs to change too for a completely seamless end user experience.
**When generating translations, one must consider the differences in sentence structure between languages. In many cases throughout Expertiza we see the following pattern: <static_text><dynamic_text><static_text>. This is a difficult case to handle. What looks like a natural break in sentence structure in one language may not look natural in another. Dr. Gehringer mentioned the possibility of having that location of the dynamic text also be able to change between locales. This needs to be investigated by a future team. That may require a different API, or generate an entirely separate view for each locale(not ideal).
**When dealing with dynamic text two approaches need to be investigated(in addition to researching API suppport):
***Query the model in its default locale and attempt to match the string with a translation after retrieval(ideal). This would be the preferred approach. We don't want to have to alter our model to alter our translations. Barring API support, this might present complicated view code, but would be preferable to created dependency between the model and the translation.
***Store separate text fields in the model for each locale(not ideal). This is something we want to avoid. We should not be altering the model to add functionality to our views.

== Links/References ==

===Project Links===

* Pull Request: https://github.com/expertiza/expertiza/pull/1286
* Github: https://github.com/mukhtar23/expertiza
* Video: https://youtu.be/TA9PkcK61QM

===Support Material===
* [https://guides.rubyonrails.org/i18n.html#how-i18n-in-ruby-on-rails-works https://guides.rubyonrails.org/i18n.html#how-i18n-in-ruby-on-rails-works]
* [https://guides.rubyonrails.org/i18n.html#setting-the-locale-from-url-params https://guides.rubyonrails.org/i18n.html#setting-the-locale-from-url-params]
* [https://guides.rubyonrails.org/i18n.html#abstracting-localized-code https://guides.rubyonrails.org/i18n.html#abstracting-localized-code]
* [https://guides.rubyonrails.org/i18n.html#providing-translations-for-internationalized-strings https://guides.rubyonrails.org/i18n.html#providing-translations-for-internationalized-strings]
* [https://guides.rubyonrails.org/i18n.html#passing-variables-to-translations https://guides.rubyonrails.org/i18n.html#passing-variables-to-translations]

* [https://www.youtube.com/watch?v=HLb0hEgrXTc https://www.youtube.com/watch?v=HLb0hEgrXTc]
* [https://phraseapp.com/blog/posts/rails-i18n-guide/ https://phraseapp.com/blog/posts/rails-i18n-guide/]

CSC/ECE 517 Fall 2018/E1866 Expertiza Internationalization

2018-12-15T02:49:14Z

Jtgill: /* Future Work */

== Introduction ==

===Team Members===

Jonathan Gill (jtgill@ncsu.edu)

Hasham Mukhtar (hmukhta@ncsu.edu)

Abhilasha Saini (asaini4@ncsu.edu)

Reddy Aravind Karnam Ganesh (rkarnam@ncsu.edu)

=== Mentor ===

Zhewei Hu (zhu6@ncsu.edu)

===Relevant Files===

config/locales/

* en.yml

* hi_IN.yml

config/

* routes.rb
* application.rb

app/controllers/
* applcation_controller.rb

Student View Files:

* app/views/
** shared/
*** _navigation.html.erb
** sign_up_sheet/
*** _suggested_topic.html.erb
*** _table_header.html.erb
*** list.html.erb
** student_task/
*** list.html.erb
*** view.html.erb
*** _publishing_rights.html.erb
** student_teams/
*** edit.html.erb
*** view.html.erb
** submitted_content/
*** _hyperlink.html.erb
*** _main.html.erb
*** _self_review.html.erb
*** _submitted_files.html.erb
*** _title.html.erb
*** edit.html.erb
** grades/
*** view_my_scores.html.erb
*** view_team.html.erb
** student_review/
*** list.html.erb
*** _responses.html.erb
*** _set_dynamic_review.html.erb
** participants/
*** change_handle.html.erb

== Project Description ==

Currently Expertiza only supports the English language. Many students are from other countries. So, we aimed to allow them to view their pages in another language. This is done by internationalizing static strings in Expertiza for Student Assignment related pages to another language (ex: Hindi or Chinese). Students had the ability to change the language through a dropdown located in navigation bar at the top of the page. We did not affect any strings that are dynamically shown. We focused on adding the Hindi language as a lot of students are Indian.

== Project Design ==

===Technical Design===

====Allowing Student to change language for Assignment Pages====

* We added a dropdown in the navigation bar for a student to use
* They are able to choose from English or Hindi
* [[File: Internationalization Navigation dropdown 2.JPG]]
* When the language is clicked on it changed all the static strings in the Student Views related to Assignments to the newly selected language.
* Students could also manually change the language in the URL themselves by. The language is put before the page name. Example: www.example.com/en/book -> www.example.com/hi_IN/book

====Adding Multi-Language Support====

* For this project, we added support for one language, Hindi.
* We used Google Translate to convert the strings to Hindi.
* We used the [https://guides.rubyonrails.org/i18n.html#how-i18n-in-ruby-on-rails-works Rails Internationalization (I18n) API] to help us add multi language support.
* There are two <code>yml</code> files in the <code>config/locales</code> directory representing the different languages that can be used in Expertiza.
** One for English, which will be the default language used, and another for Hindi.
*** <code>en.yml</code>
*** <code>hi_IN.yml</code>
** These <code>yaml</code> files contained the translated strings for their respective language.
* We editied the <code>routes.rb, application.rb, application_controller.rb</code> files and all the view files related to Student Assignments (which you can see at the top of the wiki) so that it can read from the <code>yml</code> files to show other languages.
------------------------------
* <code>application.rb</code>
** We've added the following two lines in the Recaptcha module of this file:
<code>
config.i18n.available_locales = [:en,:hi_IN]
</code>
* This tells the application all the available locale <code>.yml</code> files that are supported. If you wanted to add more language support, you can just add it to the list shown here.
<code>
config.i18n.default_locale = :en
</code>
* The sets the default language for the application. Which in this case is English.
----------------------------
* <code>application_controller.rb</code>
** We added the following to this file to get translations to work:
<code>
before_action :set_locale
</code>
* This will call the set_locale method
<code>
def set_locale
I18n.locale = params[:locale] || I18n.default_locale
end
</code>
* This sets the locale (language to use) for the application. The locale is taken from the URL query params list. If none is given, then it defaults to our default locale file (which is English). The application will always default to English and it won't pull from params until another language is chosen from the dropdown and sets :locale to something else.
<code>
def default_url_options(options={})
{locale: I18n.locale}.merge options
end
</code>
* This makes the URL always have a locale, which is set in the set_locale method, in it. This way the user doesn't have to manually enter a locale in the URL to translate the page. However, it adds the locale to the end of the URL like this: www.example.com/book/?locale=en. This is not something we want as it doesn't look good. This is fixed with routes.rb
-----------------------------
* <code> routes.rb </code>
** We wrapped the file in <code> routes.rb </code> with a <code>scope:</code> so that the locale can be added before the page name in the URL. Something like this: www.example.com/en/book
** [[File:Internationalization Route rb 2.JPG]]
*** the code at the top prevents a Routing Error when you go to a page and don't specify the locale (www.example.com/book) and it allows the default locale to be used. It knows the available locales from line <code>/#{I18n.available_locales.join("|")} </code>. <code> available_locales </code> was set in the <code>application.rb</code> file
----------------------------
* <code>.yml</code> Files
** <code>.yml</code> files know to look at the <code>view</code> folder when looking for keys to show
** Because of that, <code>.yml</code> files are structured in a hierarchy as shown below:
<code>
locale_name:
folder_name:
html_page_name:
key_name_for_string:
</code>
* Below is a sample for how we formatted our two locale files
<code>
en:
student_task:
list:
assignments: "Assignments"
</code>
<code>
hi_IN:
student_task:
list:
assignments: "असाइनमेंट"
</code>
* <code>student_task</code> is the folder under views: <code>views/student_task</code>
* list is the name of the html page: <code>view/student_task/list.html.erb</code>
* assignments is the key that replaces the word "Assignments" in the code (see next section).
* If more keys are added, they would need to be added in this format

*
----------------------------
* Student Views were translated as shown below:
** Regular Static Strings
*** Take any static, hard coded strings, like this one: <nowiki><h1> Assignments </h1></nowiki>, and replace "Assignment", with <code><%=t ".key_name" %></code>
*** The new code would look like this <nowiki><h1><%=t ".key_name" %></h1> </nowiki>
*** <code> key_name </code> comes from the key in the <code>.yml</code> files. The locale variable (en or hi_IN) would determine which one it pulls from.
*** This is how you would change the strings for an html page.
** Static strings for buttons, dropdowns, etc.
*** You can also translate static string field values that you would find in buttons, dropdowns, etc. When you change these types of strings, you need slightly different code to translate it.
*** Example: <code><%= submit_tag 'Save' %> </code>. You would replace 'Save' with <code>t('.key_name')</code>.
*** It would now look like this <code> <%= submit_tag t('.key_name') %></code>
** Other Info
*** Because the <code>.yml</code> know what view folders to look in when choosing the keys, when you type . for the key_namefor the translation code (shown above), it will show the list of keys available for the html page you are in, at least in RubyMine.
*** Reference keys in other html files (Look at below code for example)
**** You can reference keys under from another html file within the same sub view folder.
***** For example, you can reference the key <code>select_assignment</code> from the <code>view/student_task/view.html.erb</code> in <code>view/student_task/list.html.erb</code> by doing <code><%=t ".view.select_assignment" %></code> for a static string in <code>view/student_task/list.html.erb</code>
**** You can reference keys from another html file in a different sub view folder
***** For example, you can reference the key <code>sign_up</code> from <code>view/publishing/view.html.erb</code> in <code>view/student_task/list.html.erb</code> from by doing <code><%=t ".publishing.view.sign_up" %></code> for a static string in <code>view/student_task/list.html.erb</code>
**** By referencing keys not in the html file you are working on, you can reduce duplicate key names.

<code>
en:
student_task
list:
assignment: "Assignment"
view:
select_assignment: "Select Assignment"
publishing
view:
sign_up: "Sign Up"
</code>

===Example Output===

====Original Page====
[[File:Internationalization ssignment main page.JPG]]

====Translated Page====

[[File:Internationalization assignment main translated page.JPG]]

===Test Plan===

====Student Credentials====
username: student1016 or student[4000-8000]

password: password

====Before Testing====

* When going between pages, use the Back button link located on the bottom of pages, not on the browser
* When going to the main Assignment page, use the Back button link to get there to test out the scenarios below, not the link in the navigation bar.

====Scenario 1====

1. Log in to Expertiza as a student.

2. Go to language dropdown in the navigation bar and choose Hindi.

3. Check if language is changed in the URL from en to hi_IN

4. Check to see if the English strings on the page are translated to Hindi

5. While still logged in as a Student, check if the other Assignment related pages are also translated.

====Scenario 2====

1. Log in to Expertiza as a student.

2. Go to language dropdown in the navigation bar and choose Hindi.

3. Check if language is changed in the URL from en to hi_IN

4. Check to see if the English strings on the page are translated to Hindi

5. While still logged in as a Student, check if the other Assignment related pages are also translated.

6. Go back to the main Assignment page and choose English from the dropdown.

7. See if the language was changed in the URL to en.

8. See if the strings are translated back to English for all Assignment related pages.

====Scenario 3====

1. Log in to Expertiza as a student.

2. Go to URL and change the language from en to hi_IN.

3. Check to see if the English strings on the page are translated to Hindi.

4. While still logged in as a Student, check if the other Assignment related pages are also translated.

====Scenario 4====

1. Log in to Expertiza as a student.

2. Go to URL and change the language from en to hi_IN.

3. Check to see if the English strings on the page are translated to Hindi.

4. While still logged in as a Student, check if the other Assignment related pages are also translated.

5. Now change the language back from hi_IN to en in the URL.

6. See if the Hindi strings are translated back to English for all Assignment related pages.

==Future Work==

Due to time, there were some things we weren't able to fix or work on.
* Problems:
** When a student goes back to the main Assignment page, views/student_task/list, by clicking the link in the navigation bar, the language locale doesn't appear in the URL. This means that if you did change the language from the dropdown or manually, it will go back to the default locale language. See the URL below:
*** [[File:Internationalization assignment link langauge error.JPG]]
** If you try to use the language dropdown in a page other than the main Assignment page, it will give an error like the one shown below:
*** [[File:Internationalization langauge dropdown error.JPG]]
** But if you manually change the language in the URL, it works fine and persists as you navigate through the pages.
* Feature:
** We also have translated keys for many course pages, but did not implement the actual translation code in the view files for them. You should be able to look at the keys to find out which view files they are.
** Adding translation for Chinese.
*Additional Considerations(After our discussion during presentation):
**A future team needs to add support for dynamic text. Our project was only concerned with Expertiza's static text. The dynamic text needs to change too for a completely seamless end user experience.
**When generating translations, one must consider the differences in sentence structure between languages. In many cases throughout Expertiza we see the following pattern: <static_text><dynamic_text><static_text>. This is a difficult case to handle. What looks like a natural break in sentence structure in one language may not look natural in another. Dr. Gehringer mentioned the possibility of having that location of the dynamic text also be able to change between locales. This needs to be investigated by a future team. That may require a different API, or generate an entirely separate view for each locale(not ideal).

**When dealing with dynamic text two approaches need to be investigated(in addition to researching API suppport):
***Query the model in its default locale and attempt to match the string with a translation after retrieval(ideal). This would be the preferred approach. We don't want to have to alter our model to alter our translations. Barring API support, this might present complicated view code, but would be preferable to created dependency between the model and the translation.
***Store separate text fields in the model for each locale(not ideal). This is something we want to avoid. We should not be altering the model to add functionality to our views.

== Links/References ==

===Project Links===

* Pull Request: https://github.com/expertiza/expertiza/pull/1286
* Github: https://github.com/mukhtar23/expertiza
* Video: https://youtu.be/TA9PkcK61QM

===Support Material===
* [https://guides.rubyonrails.org/i18n.html#how-i18n-in-ruby-on-rails-works https://guides.rubyonrails.org/i18n.html#how-i18n-in-ruby-on-rails-works]
* [https://guides.rubyonrails.org/i18n.html#setting-the-locale-from-url-params https://guides.rubyonrails.org/i18n.html#setting-the-locale-from-url-params]
* [https://guides.rubyonrails.org/i18n.html#abstracting-localized-code https://guides.rubyonrails.org/i18n.html#abstracting-localized-code]
* [https://guides.rubyonrails.org/i18n.html#providing-translations-for-internationalized-strings https://guides.rubyonrails.org/i18n.html#providing-translations-for-internationalized-strings]
* [https://guides.rubyonrails.org/i18n.html#passing-variables-to-translations https://guides.rubyonrails.org/i18n.html#passing-variables-to-translations]

* [https://www.youtube.com/watch?v=HLb0hEgrXTc https://www.youtube.com/watch?v=HLb0hEgrXTc]
* [https://phraseapp.com/blog/posts/rails-i18n-guide/ https://phraseapp.com/blog/posts/rails-i18n-guide/]

CSC/ECE 517 Fall 2018/E1866 Expertiza Internationalization

2018-12-06T20:33:52Z

Jtgill: /* Project Links */

== Introduction ==

===Team Members===

Jonathan Gill (jtgill@ncsu.edu)

Hasham Mukhtar (hmukhta@ncsu.edu)

Abhilasha Saini (asaini4@ncsu.edu)

Reddy Aravind Karnam Ganesh (rkarnam@ncsu.edu)

=== Mentor ===

Zhewei Hu (zhu6@ncsu.edu)

===Relevant Files===

config/locales/

* en.yml

* hi_IN.yml

config/

* routes.rb
* application.rb

app/controllers/
* applcation_controller.rb

Student View Files:

* app/views/
** shared/
*** _navigation.html.erb
** sign_up_sheet/
*** _suggested_topic.html.erb
*** _table_header.html.erb
*** list.html.erb
** student_task/
*** list.html.erb
*** view.html.erb
*** _publishing_rights.html.erb
** student_teams/
*** edit.html.erb
*** view.html.erb
** submitted_content/
*** _hyperlink.html.erb
*** _main.html.erb
*** _self_review.html.erb
*** _submitted_files.html.erb
*** _title.html.erb
*** edit.html.erb
** grades/
*** view_my_scores.html.erb
*** view_team.html.erb
** student_review/
*** list.html.erb
*** _responses.html.erb
*** _set_dynamic_review.html.erb
** participants/
*** change_handle.html.erb

== Project Description ==

Currently Expertiza only supports the English language. Many students are from other countries. So, we aimed to allow them to view their pages in another language. This is done by internationalizing static strings in Expertiza for Student Assignment related pages to another language (ex: Hindi or Chinese). Students had the ability to change the language through a dropdown located in navigation bar at the top of the page. We did not affect any strings that are dynamically shown. We focused on adding the Hindi language as a lot of students are Indian.

== Project Design ==

===Technical Design===

====Allowing Student to change language for Assignment Pages====

* We added a dropdown in the navigation bar for a student to use
* They are able to choose from English or Hindi
* [[File: Internationalization Navigation dropdown 2.JPG]]
* When the language is clicked on it changed all the static strings in the Student Views related to Assignments to the newly selected language.
* Students could also manually change the language in the URL themselves by. The language is put before the page name. Example: www.example.com/en/book -> www.example.com/hi_IN/book

====Adding Multi-Language Support====

* For this project, we added support for one language, Hindi.
* We used Google Translate to convert the strings to Hindi.
* We used the [https://guides.rubyonrails.org/i18n.html#how-i18n-in-ruby-on-rails-works Rails Internationalization (I18n) API] to help us add multi language support.
* There are two <code>yml</code> files in the <code>config/locales</code> directory representing the different languages that can be used in Expertiza.
** One for English, which will be the default language used, and another for Hindi.
*** <code>en.yml</code>
*** <code>hi_IN.yml</code>
** These <code>yaml</code> files contained the translated strings for their respective language.
* We editied the <code>routes.rb, application.rb, application_controller.rb</code> files and all the view files related to Student Assignments (which you can see at the top of the wiki) so that it can read from the <code>yml</code> files to show other languages.
------------------------------
* <code>application.rb</code>
** We've added the following two lines in the Recaptcha module of this file:
<code>
config.i18n.available_locales = [:en,:hi_IN]
</code>
* This tells the application all the available locale <code>.yml</code> files that are supported. If you wanted to add more language support, you can just add it to the list shown here.
<code>
config.i18n.default_locale = :en
</code>
* The sets the default language for the application. Which in this case is English.
----------------------------
* <code>application_controller.rb</code>
** We added the following to this file to get translations to work:
<code>
before_action :set_locale
</code>
* This will call the set_locale method
<code>
def set_locale
I18n.locale = params[:locale] || I18n.default_locale
end
</code>
* This sets the locale (language to use) for the application. The locale is taken from the URL query params list. If none is given, then it defaults to our default locale file (which is English). The application will always default to English and it won't pull from params until another language is chosen from the dropdown and sets :locale to something else.
<code>
def default_url_options(options={})
{locale: I18n.locale}.merge options
end
</code>
* This makes the URL always have a locale, which is set in the set_locale method, in it. This way the user doesn't have to manually enter a locale in the URL to translate the page. However, it adds the locale to the end of the URL like this: www.example.com/book/?locale=en. This is not something we want as it doesn't look good. This is fixed with routes.rb
-----------------------------
* <code> routes.rb </code>
** We wrapped the file in <code> routes.rb </code> with a <code>scope:</code> so that the locale can be added before the page name in the URL. Something like this: www.example.com/en/book
** [[File:Internationalization Route rb 2.JPG]]
*** the code at the top prevents a Routing Error when you go to a page and don't specify the locale (www.example.com/book) and it allows the default locale to be used. It knows the available locales from line <code>/#{I18n.available_locales.join("|")} </code>. <code> available_locales </code> was set in the <code>application.rb</code> file
----------------------------
* <code>.yml</code> Files
** <code>.yml</code> files know to look at the <code>view</code> folder when looking for keys to show
** Because of that, <code>.yml</code> files are structured in a hierarchy as shown below:
<code>
locale_name:
folder_name:
html_page_name:
key_name_for_string:
</code>
* Below is a sample for how we formatted our two locale files
<code>
en:
student_task:
list:
assignments: "Assignments"
</code>
<code>
hi_IN:
student_task:
list:
assignments: "असाइनमेंट"
</code>
* student_task is the folder under views: views/student_task
* list is the name of the html page: view/student_task/list.html.erb
* assignments is the key that replaces the word "Assignments" in the code (see next section).
* If more keys are added, they would need to be added in this format

----------------------------
* Student Views were translated as shown below:
** Regular Static Strings
*** Take any static, hard coded strings, like this one: <nowiki><h1> Assignments </h1></nowiki>, and replace "Assignment", with <code><%=t ".keyName" %></code>
*** The new code would look like this <nowiki><h1><%=t ".key_name" %></h1> </nowiki>
*** <code> key_name </code> comes from the key in the <code>.yml</code> files. The locale variable (en or hi_IN) would determine which one it pulls from.
*** This is how you would change the strings for an html page.
** Static strings for buttons, dropdowns, etc.
*** You can also translate static string field values that you would find in buttons, dropdowns, etc. When you change these types of strings, you need slightly different code to translate it.
*** Example: <code><%= submit_tag 'Save' %> </code>. You would replace 'Save' with <code>t('.key_name')</code>.
*** It would now look like this <code> <%= submit_tag t('.key_name') %></code>

===Example Output===

====Original Page====
[[File:Internationalization ssignment main page.JPG]]

====Translated Page====

[[File:Internationalization assignment main translated page.JPG]]

===Test Plan===

====Student Credentials====
username: student1016 or student[4000-8000]

password: password

====Before Testing====

* When going between pages, use the Back button link located on the bottom of pages, not on the browser
* When going to the main Assignment page, use the Back button link to get there to test out the scenarios below, not the link in the navigation bar.

====Scenario 1====

1. Log in to Expertiza as a student.

2. Go to language dropdown in the navigation bar and choose Hindi.

3. Check if language is changed in the URL from en to hi_IN

4. Check to see if the English strings on the page are translated to Hindi

5. While still logged in as a Student, check if the other Assignment related pages are also translated.

====Scenario 2====

1. Log in to Expertiza as a student.

2. Go to language dropdown in the navigation bar and choose Hindi.

3. Check if language is changed in the URL from en to hi_IN

4. Check to see if the English strings on the page are translated to Hindi

5. While still logged in as a Student, check if the other Assignment related pages are also translated.

6. Go back to the main Assignment page and choose English from the dropdown.

7. See if the language was changed in the URL to en.

8. See if the strings are translated back to English for all Assignment related pages.

====Scenario 3====

1. Log in to Expertiza as a student.

2. Go to URL and change the language from en to hi_IN.

3. Check to see if the English strings on the page are translated to Hindi.

4. While still logged in as a Student, check if the other Assignment related pages are also translated.

====Scenario 4====

1. Log in to Expertiza as a student.

2. Go to URL and change the language from en to hi_IN.

3. Check to see if the English strings on the page are translated to Hindi.

4. While still logged in as a Student, check if the other Assignment related pages are also translated.

5. Now change the language back from hi_IN to en in the URL.

6. See if the Hindi strings are translated back to English for all Assignment related pages.

==Future Work==

Due to time, there were some things we weren't able to fix or work on.
* Problems:
** When a student goes back to the main Assignment page, views/student_task/list, by clicking the link in the navigation bar, the language locale doesn't appear in the URL. This means that if you did change the language from the dropdown or manually, it will go back to the default locale language. See the URL below:
*** [[File:Internationalization assignment link langauge error.JPG]]
** If you try to use the language dropdown in a page other than the main Assignment page, it will give an error like the one shown below:
*** [[File:Internationalization langauge dropdown error.JPG]]
** But if you manually change the language in the URL, it works fine and persists as you navigate through the pages.
* Feature:
** Having a translation only show up for the user who changes it and not in the entire system.
** We also have translated keys for many course pages, but did not implement the actual translation code in the view files for them. You should be able to look at the keys to find out which view files they are.
** Adding translation for Chinese.

== Links/References ==

===Project Links===

* Pull Request: https://github.com/expertiza/expertiza/pull/1286
* Github: https://github.com/mukhtar23/expertiza
* Video: https://youtu.be/TA9PkcK61QM

===Support Material===
* [https://guides.rubyonrails.org/i18n.html#how-i18n-in-ruby-on-rails-works https://guides.rubyonrails.org/i18n.html#how-i18n-in-ruby-on-rails-works]
* [https://guides.rubyonrails.org/i18n.html#setting-the-locale-from-url-params https://guides.rubyonrails.org/i18n.html#setting-the-locale-from-url-params]
* [https://guides.rubyonrails.org/i18n.html#abstracting-localized-code https://guides.rubyonrails.org/i18n.html#abstracting-localized-code]
* [https://guides.rubyonrails.org/i18n.html#providing-translations-for-internationalized-strings https://guides.rubyonrails.org/i18n.html#providing-translations-for-internationalized-strings]
* [https://guides.rubyonrails.org/i18n.html#passing-variables-to-translations https://guides.rubyonrails.org/i18n.html#passing-variables-to-translations]

* [https://www.youtube.com/watch?v=HLb0hEgrXTc https://www.youtube.com/watch?v=HLb0hEgrXTc]
* [https://phraseapp.com/blog/posts/rails-i18n-guide/ https://phraseapp.com/blog/posts/rails-i18n-guide/]

CSC/ECE 517 Fall 2018/E1866 Expertiza Internationalization

2018-11-13T01:34:23Z

Jtgill:

== Introduction ==

===Team Members===

Jonathan Gill (jtgill@ncsu.edu)

Hasham Mukhtar (hmukhta@ncsu.edu)

Abhilasha Saini (asaini4@ncsu.edu)

Reddy Aravind Karnam Ganesh (rkarnam@ncsu.edu)

===Relevant Files===

config/locales

routes.rb

all view files

== Project Description ==

Currently Expertiza only supports creating courses in the English language. Many Expertiza users are from other countries. We aim to allow instructors to create courses in other languages. This will be done by internationalizing static strings in Expertiza to another language (ex: Hindi or Chinese). Instructors will have the ability to change the language for a course in the Edit Course page through a dropdown. We will not be affecting any strings that are dynamically shown and are not changing any English strings in the actual code.

== Project Design ==

===Technical Design===

====Allowing instructor to change language for a course====

* We will add a <code>language</code> column to the <code>Courses</code> Table.
* Then we will add a dropdown of languages to the Edit Course page for an instructor to use.
* When an instructor updates the Edit Course page with a chosen language picked, it will translate all the static strings in the Expertiza application to that new language.

====Adding Multi-Language Support====

* For this project, we will be adding support for one language right now, Hindi.
* We will be using the [https://guides.rubyonrails.org/i18n.html#how-i18n-in-ruby-on-rails-works Rails Internationalization (I18n) API] to help us add multi language support.
* There will be two <code>yaml</code> files in the <code>config/locales</code> directory representing the different languages that can be used in Expertiza.
** One for English, which will be the default language used, and another for Hindi.
*** <code>en.yml</code>
*** <code>hi_IN.yml</code>
** These <code>yaml</code> files contain the translated strings for their respective language.
* We will be editing the <code>routes.rb</code> file and all the view files so that it can read from the <code>yaml</code> files to show other languages.

===Example Output===

====Original Page====
[[File:Edit Course default.PNG]]

====Language Dropdown====

[[File:Edit Course mock en.PNG]]

====Translated Page====

[[File:Edit Course mock hi IN.PNG]]

== Links/References ==

===Project Links===

* Pull Request:
* Github: https://github.com/mukhtar23/expertiza
* Video:

===Support Material===
* [https://guides.rubyonrails.org/i18n.html#how-i18n-in-ruby-on-rails-works https://guides.rubyonrails.org/i18n.html#how-i18n-in-ruby-on-rails-works]
* [https://guides.rubyonrails.org/i18n.html#setting-the-locale-from-url-params https://guides.rubyonrails.org/i18n.html#setting-the-locale-from-url-params]
* [https://guides.rubyonrails.org/i18n.html#abstracting-localized-code https://guides.rubyonrails.org/i18n.html#abstracting-localized-code]
* [https://guides.rubyonrails.org/i18n.html#providing-translations-for-internationalized-strings https://guides.rubyonrails.org/i18n.html#providing-translations-for-internationalized-strings]
* [https://guides.rubyonrails.org/i18n.html#passing-variables-to-translations https://guides.rubyonrails.org/i18n.html#passing-variables-to-translations]

CSC/ECE 517 Fall 2018/E1866 Expertiza Internationalization

2018-11-13T01:33:57Z

Jtgill:

== Introduction ==

===Team Members===

Jonathan Gill (jtgill@ncsu.edu)

Hasham Mukhtar (hmukhta@ncsu.edu)

Abhilasha Saini (asaini4@ncsu.edu)

Reddy Aravind Karnam Ganesh (rkarnam@ncsu.edu)

===Relevant Files===

config/locales

routes.rb

all view files

== Project Description ==

Currently Expertiza only supports creating courses in the English language. Many Expertiza users are from other countries. We aim to allow instructors to create courses in other languages. This will be done by internationalizing static strings in Expertiza to another language (ex: Hindi or Chinese). Instructors will have the ability to change the language for a course in the Edit Course page through a dropdown. We will not be affecting any strings that are dynamically shown and are not changing any English strings in the actual code.

== Project Design ==

===Technical Design===

====Allowing instructor to change language for a course====

* We will add a <code>language</code> column to the <code>Courses</code> Table.
* Then we will add a dropdown of languages to the Edit Course page for an instructor to use.
* When an instructor updates the Edit Course page with a chosen language picked, it will translate all the static strings in the Expertiza application to that new language.

====Adding Multi-Language Support====

* For this project, we will be adding support for one language right now, Hindi.
* We will be using the [https://guides.rubyonrails.org/i18n.html#how-i18n-in-ruby-on-rails-works Rails Internationalization (I18n) API] to help us add multi language support.
* There will be two <code>yaml</code> files in the <code>config/locales</code> directory representing the different languages that can be used in Expertiza.
** One for English, which will be the default language used, and another for Hindi.
*** <code>en.yml</code>
*** <code>hi_IN.yml</code>
** These <code>yaml</code> files contain the translated strings for their respective language.
* We will be editing the <code>routes.rb</code> file and all the view files so that it can read from the <code>yaml</code> files to show other languages.

===Example Output===

====Original Page====
[[File:Edit Course default.PNG]

====Language Dropdown====

[[File:Edit Course mock en.PNG]]

====Translated Page====

[[File:Edit Course mock hi IN.PNG]]

== Links/References ==

===Project Links===

* Pull Request:
* Github: https://github.com/mukhtar23/expertiza
* Video:

===Support Material===
* [https://guides.rubyonrails.org/i18n.html#how-i18n-in-ruby-on-rails-works https://guides.rubyonrails.org/i18n.html#how-i18n-in-ruby-on-rails-works]
* [https://guides.rubyonrails.org/i18n.html#setting-the-locale-from-url-params https://guides.rubyonrails.org/i18n.html#setting-the-locale-from-url-params]
* [https://guides.rubyonrails.org/i18n.html#abstracting-localized-code https://guides.rubyonrails.org/i18n.html#abstracting-localized-code]
* [https://guides.rubyonrails.org/i18n.html#providing-translations-for-internationalized-strings https://guides.rubyonrails.org/i18n.html#providing-translations-for-internationalized-strings]
* [https://guides.rubyonrails.org/i18n.html#passing-variables-to-translations https://guides.rubyonrails.org/i18n.html#passing-variables-to-translations]

CSC/ECE 517 Fall 2018/E1866 Expertiza Internationalization

2018-11-12T22:03:36Z

Jtgill:

== Introduction ==

===Team Members===

Jonathan Gill (jtgill@ncsu.edu)

Hasham Mukhtar (hmukhta@ncsu.edu)

Abhilasha Saini (asaini4@ncsu.edu)

Reddy Aravind Karnam Ganesh (rkarnam@ncsu.edu)

===Relevant Files===

config/locales

routes.rb

all view files

== Project Description ==

Currently Expertiza only supports creating courses in the English language. Many Expertiza users are from other countries. We aim to allow instructors to create courses in other languages. This will be done by internationalizing static strings in Expertiza to another language (ex: Hindi or Chinese). Instructors will have the ability to change the language for a course in the Edit Course page through a dropdown. We will not be affecting any strings that are dynamically shown and are not changing any English strings in the actual code.

== Project Design ==

===Technical Design===

====Allowing instructor to change language for a course====

* We will add a <code>language</code> column to the <code>Courses</code> Table.
* Then we will add a dropdown of languages to the Edit Course page for an instructor to use.
* When an instructor updates the Edit Course page with a chosen language picked, it will translate all the static strings in the Expertiza application to that new language.

====Adding Multi-Language Support====

* For this project, we will be adding support for one language right now, Hindi.
* We will be using the [https://guides.rubyonrails.org/i18n.html#how-i18n-in-ruby-on-rails-works Rails Internationalization (I18n) API] to help us add multi language support.
* There will be two <code>yaml</code> files in the <code>config/locales</code> directory representing the different languages that can be used in Expertiza.
** One for English, which will be the default language used, and another for Hindi.
*** <code>en.yml</code>
*** <code>hi_IN.yml</code>
** These <code>yaml</code> files contain the translated strings for their respective language.
* We will be editing the <code>routes.rb</code> file and all the view files so that it can read from the <code>yaml</code> files to show other languages.

===Example Output===

====Original Page====
[[File:Edit Course default.PNG|left|frame|100px]]

====Language Dropdown====

[[File:Edit Course mock en.PNG]]

====Translated Page====

[[File:Edit Course mock hi IN.PNG]]

== Links/References ==

===Project Links===

* Pull Request:
* Github: https://github.com/mukhtar23/expertiza
* Video:

===Support Material===
* [https://guides.rubyonrails.org/i18n.html#how-i18n-in-ruby-on-rails-works https://guides.rubyonrails.org/i18n.html#how-i18n-in-ruby-on-rails-works]
* [https://guides.rubyonrails.org/i18n.html#setting-the-locale-from-url-params https://guides.rubyonrails.org/i18n.html#setting-the-locale-from-url-params]
* [https://guides.rubyonrails.org/i18n.html#abstracting-localized-code https://guides.rubyonrails.org/i18n.html#abstracting-localized-code]
* [https://guides.rubyonrails.org/i18n.html#providing-translations-for-internationalized-strings https://guides.rubyonrails.org/i18n.html#providing-translations-for-internationalized-strings]
* [https://guides.rubyonrails.org/i18n.html#passing-variables-to-translations https://guides.rubyonrails.org/i18n.html#passing-variables-to-translations]

CSC/ECE 517 Fall 2018/E1866 Expertiza Internationalization

2018-11-12T22:02:44Z

Jtgill:

== Introduction ==

===Team Members===

Jonathan Gill (jtgill@ncsu.edu)

Hasham Mukhtar (hmukhta@ncsu.edu)

Abhilasha Saini (asaini4@ncsu.edu)

Reddy Aravind Karnam Ganesh (rkarnam@ncsu.edu)

===Relevant Files===

config/locales

routes.rb

all view files

== Project Description ==

Currently Expertiza only supports creating courses in the English language. Many Expertiza users are from other countries. We aim to allow instructors to create courses in other languages. This will be done by internationalizing static strings in Expertiza to another language (ex: Hindi or Chinese). Instructors will have the ability to change the language for a course in the Edit Course page through a dropdown. We will not be affecting any strings that are dynamically shown and are not changing any English strings in the actual code.

== Project Design ==

===Technical Design===

====Allowing instructor to change language for a course====

* We will add a <code>language</code> column to the <code>Courses</code> Table.
* Then we will add a dropdown of languages to the Edit Course page for an instructor to use.
* When an instructor updates the Edit Course page with a chosen language picked, it will translate all the static strings in the Expertiza application to that new language.

====Adding Multi-Language Support====

* For this project, we will be adding support for one language right now, Hindi.
* We will be using the [https://guides.rubyonrails.org/i18n.html#how-i18n-in-ruby-on-rails-works Rails Internationalization (I18n) API] to help us add multi language support.
* There will be two <code>yaml</code> files in the <code>config/locales</code> directory representing the different languages that can be used in Expertiza.
** One for English, which will be the default language used, and another for Hindi.
*** <code>en.yml</code>
*** <code>hi_IN.yml</code>
** These <code>yaml</code> files contain the translated strings for their respective language.
* We will be editing the <code>routes.rb</code> file and all the view files so that it can read from the <code>yaml</code> files to show other languages.

===Example Output===

====Original Page====
[[File:Edit Course default.PNG|center|frame|100px]]

====Language Dropdown====

[[File:Edit Course mock en.PNG]]

====Translated Page====

[[File:Edit Course mock hi IN.PNG]]

== Links/References ==

===Project Links===

* Pull Request:
* Github: https://github.com/mukhtar23/expertiza
* Video:

===Support Material===
* [https://guides.rubyonrails.org/i18n.html#how-i18n-in-ruby-on-rails-works https://guides.rubyonrails.org/i18n.html#how-i18n-in-ruby-on-rails-works]
* [https://guides.rubyonrails.org/i18n.html#setting-the-locale-from-url-params https://guides.rubyonrails.org/i18n.html#setting-the-locale-from-url-params]
* [https://guides.rubyonrails.org/i18n.html#abstracting-localized-code https://guides.rubyonrails.org/i18n.html#abstracting-localized-code]
* [https://guides.rubyonrails.org/i18n.html#providing-translations-for-internationalized-strings https://guides.rubyonrails.org/i18n.html#providing-translations-for-internationalized-strings]
* [https://guides.rubyonrails.org/i18n.html#passing-variables-to-translations https://guides.rubyonrails.org/i18n.html#passing-variables-to-translations]

CSC/ECE 517 Fall 2018/E1866 Expertiza Internationalization

2018-11-12T22:01:32Z

Jtgill:

== Introduction ==

===Team Members===

Jonathan Gill (jtgill@ncsu.edu)

Hasham Mukhtar (hmukhta@ncsu.edu)

Abhilasha Saini (asaini4@ncsu.edu)

Reddy Aravind Karnam Ganesh (rkarnam@ncsu.edu)

===Relevant Files===

config/locales

routes.rb

all view files

== Project Description ==

Currently Expertiza only supports creating courses in the English language. Many Expertiza users are from other countries. We aim to allow instructors to create courses in other languages. This will be done by internationalizing static strings in Expertiza to another language (ex: Hindi or Chinese). Instructors will have the ability to change the language for a course in the Edit Course page through a dropdown. We will not be affecting any strings that are dynamically shown and are not changing any English strings in the actual code.

== Project Design ==

===Technical Design===

====Allowing instructor to change language for a course====

* We will add a <code>language</code> column to the <code>Courses</code> Table.
* Then we will add a dropdown of languages to the Edit Course page for an instructor to use.
* When an instructor updates the Edit Course page with a chosen language picked, it will translate all the static strings in the Expertiza application to that new language.

====Adding Multi-Language Support====

* For this project, we will be adding support for one language right now, Hindi.
* We will be using the [https://guides.rubyonrails.org/i18n.html#how-i18n-in-ruby-on-rails-works Rails Internationalization (I18n) API] to help us add multi language support.
* There will be two <code>yaml</code> files in the <code>config/locales</code> directory representing the different languages that can be used in Expertiza.
** One for English, which will be the default language used, and another for Hindi.
*** <code>en.yml</code>
*** <code>hi_IN.yml</code>
** These <code>yaml</code> files contain the translated strings for their respective language.
* We will be editing the <code>routes.rb</code> file and all the view files so that it can read from the <code>yaml</code> files to show other languages.

===Example Output===

====Original Page====
[[File:Edit Course default.PNG|center|frame|300px]]

====Language Dropdown====

[[File:Edit Course mock en.PNG]]

====Translated Page====

[[File:Edit Course mock hi IN.PNG]]

== Links/References ==

===Project Links===

* Pull Request:
* Github: https://github.com/mukhtar23/expertiza
* Video:

===Support Material===
* [https://guides.rubyonrails.org/i18n.html#how-i18n-in-ruby-on-rails-works https://guides.rubyonrails.org/i18n.html#how-i18n-in-ruby-on-rails-works]
* [https://guides.rubyonrails.org/i18n.html#setting-the-locale-from-url-params https://guides.rubyonrails.org/i18n.html#setting-the-locale-from-url-params]
* [https://guides.rubyonrails.org/i18n.html#abstracting-localized-code https://guides.rubyonrails.org/i18n.html#abstracting-localized-code]
* [https://guides.rubyonrails.org/i18n.html#providing-translations-for-internationalized-strings https://guides.rubyonrails.org/i18n.html#providing-translations-for-internationalized-strings]
* [https://guides.rubyonrails.org/i18n.html#passing-variables-to-translations https://guides.rubyonrails.org/i18n.html#passing-variables-to-translations]

CSC/ECE 517 Fall 2018/E1866 Expertiza Internationalization

2018-11-12T21:59:34Z

Jtgill:

== Introduction ==

===Team Members===

Jonathan Gill (jtgill@ncsu.edu)

Hasham Mukhtar (hmukhta@ncsu.edu)

Abhilasha Saini (asaini4@ncsu.edu)

Reddy Aravind Karnam Ganesh (rkarnam@ncsu.edu)

===Relevant Files===

config/locales

routes.rb

all view files

== Project Description ==

Currently Expertiza only supports creating courses in the English language. Many Expertiza users are from other countries. We aim to allow instructors to create courses in other languages. This will be done by internationalizing static strings in Expertiza to another language (ex: Hindi or Chinese). Instructors will have the ability to change the language for a course in the Edit Course page through a dropdown. We will not be affecting any strings that are dynamically shown and are not changing any English strings in the actual code.

== Project Design ==

===Technical Design===

====Allowing instructor to change language for a course====

* We will add a <code>language</code> column to the <code>Courses</code> Table.
* Then we will add a dropdown of languages to the Edit Course page for an instructor to use.
* When an instructor updates the Edit Course page with a chosen language picked, it will translate all the static strings in the Expertiza application to that new language.

====Adding Multi-Language Support====

* For this project, we will be adding support for one language right now, Hindi.
* We will be using the [https://guides.rubyonrails.org/i18n.html#how-i18n-in-ruby-on-rails-works Rails Internationalization (I18n) API] to help us add multi language support.
* There will be two <code>yaml</code> files in the <code>config/locales</code> directory representing the different languages that can be used in Expertiza.
** One for English, which will be the default language used, and another for Hindi.
*** <code>en.yml</code>
*** <code>hi_IN.yml</code>
** These <code>yaml</code> files contain the translated strings for their respective language.
* We will be editing the <code>routes.rb</code> file and all the view files so that it can read from the <code>yaml</code> files to show other languages.

===Example Output===

====Original Page====
[[File:Edit Course default.PNG]]

====Language Dropdown====

[[File:Edit Course mock en.PNG]]

====Translated Page====

[[File:Edit Course mock hi IN.PNG]]

== Links/References ==

===Project Links===

* Pull Request:
* Github: https://github.com/mukhtar23/expertiza
* Video:

===Support Material===
* [https://guides.rubyonrails.org/i18n.html#how-i18n-in-ruby-on-rails-works https://guides.rubyonrails.org/i18n.html#how-i18n-in-ruby-on-rails-works]
* [https://guides.rubyonrails.org/i18n.html#setting-the-locale-from-url-params https://guides.rubyonrails.org/i18n.html#setting-the-locale-from-url-params]
* [https://guides.rubyonrails.org/i18n.html#abstracting-localized-code https://guides.rubyonrails.org/i18n.html#abstracting-localized-code]
* [https://guides.rubyonrails.org/i18n.html#providing-translations-for-internationalized-strings https://guides.rubyonrails.org/i18n.html#providing-translations-for-internationalized-strings]
* [https://guides.rubyonrails.org/i18n.html#passing-variables-to-translations https://guides.rubyonrails.org/i18n.html#passing-variables-to-translations]

CSC/ECE 517 Fall 2018/E1866 Expertiza Internationalization

2018-11-12T21:59:12Z

Jtgill:

== Introduction ==

===Team Members===

Jonathan Gill (jtgill@ncsu.edu)

Hasham Mukhtar (hmukhta@ncsu.edu)

Abhilasha Saini (asaini4@ncsu.edu)

Reddy Aravind Karnam Ganesh (rkarnam@ncsu.edu)

===Relevant Files===

config/locales

routes.rb

all view files

== Project Description ==

Currently Expertiza only supports creating courses in the English language. Many Expertiza users are from other countries. We aim to allow instructors to create courses in other languages. This will be done by internationalizing static strings in Expertiza to another language (ex: Hindi or Chinese). Instructors will have the ability to change the language for a course in the Edit Course page through a dropdown. We will not be affecting any strings that are dynamically shown and are not changing any English strings in the actual code.

== Project Design ==

===Technical Design===

====Allowing instructor to change language for a course====

* We will add a <code>language</code> column to the <code>Courses</code> Table.
* Then we will add a dropdown of languages to the Edit Course page for an instructor to use.
* When an instructor updates the Edit Course page with a chosen language picked, it will translate all the static strings in the Expertiza application to that new language.

====Adding Multi-Language Support====

* For this project, we will be adding support for one language right now, Hindi.
* We will be using the [https://guides.rubyonrails.org/i18n.html#how-i18n-in-ruby-on-rails-works Rails Internationalization (I18n) API] to help us add multi language support.
* There will be two <code>yaml</code> files in the <code>config/locales</code> directory representing the different languages that can be used in Expertiza.
** One for English, which will be the default language used, and another for Hindi.
*** <code>en.yml</code>
*** <code>hi_IN.yml</code>
** These <code>yaml</code> files contain the translated strings for their respective language.
* We will be editing the <code>routes.rb</code> file and all the view files so that it can read from the <code>yaml</code> files to show other languages.

===Example Output===

====Original Page====
[[File:Edit Course default.PNG|300px]]

====Language Dropdown====

[[File:Edit Course mock en.PNG]]

====Translated Page====

[[File:Edit Course mock hi IN.PNG]]

== Links/References ==

===Project Links===

* Pull Request:
* Github: https://github.com/mukhtar23/expertiza
* Video:

===Support Material===
* [https://guides.rubyonrails.org/i18n.html#how-i18n-in-ruby-on-rails-works https://guides.rubyonrails.org/i18n.html#how-i18n-in-ruby-on-rails-works]
* [https://guides.rubyonrails.org/i18n.html#setting-the-locale-from-url-params https://guides.rubyonrails.org/i18n.html#setting-the-locale-from-url-params]
* [https://guides.rubyonrails.org/i18n.html#abstracting-localized-code https://guides.rubyonrails.org/i18n.html#abstracting-localized-code]
* [https://guides.rubyonrails.org/i18n.html#providing-translations-for-internationalized-strings https://guides.rubyonrails.org/i18n.html#providing-translations-for-internationalized-strings]
* [https://guides.rubyonrails.org/i18n.html#passing-variables-to-translations https://guides.rubyonrails.org/i18n.html#passing-variables-to-translations]

CSC/ECE 517 Fall 2018/E1866 Expertiza Internationalization

2018-11-12T21:58:27Z

Jtgill:

== Introduction ==

===Team Members===

Jonathan Gill (jtgill@ncsu.edu)

Hasham Mukhtar (hmukhta@ncsu.edu)

Abhilasha Saini (asaini4@ncsu.edu)

Reddy Aravind Karnam Ganesh (rkarnam@ncsu.edu)

===Relevant Files===

config/locales

routes.rb

all view files

== Project Description ==

Currently Expertiza only supports creating courses in the English language. Many Expertiza users are from other countries. We aim to allow instructors to create courses in other languages. This will be done by internationalizing static strings in Expertiza to another language (ex: Hindi or Chinese). Instructors will have the ability to change the language for a course in the Edit Course page through a dropdown. We will not be affecting any strings that are dynamically shown and are not changing any English strings in the actual code.

== Project Design ==

===Technical Design===

====Allowing instructor to change language for a course====

* We will add a <code>language</code> column to the <code>Courses</code> Table.
* Then we will add a dropdown of languages to the Edit Course page for an instructor to use.
* When an instructor updates the Edit Course page with a chosen language picked, it will translate all the static strings in the Expertiza application to that new language.

====Adding Multi-Language Support====

* For this project, we will be adding support for one language right now, Hindi.
* We will be using the [https://guides.rubyonrails.org/i18n.html#how-i18n-in-ruby-on-rails-works Rails Internationalization (I18n) API] to help us add multi language support.
* There will be two <code>yaml</code> files in the <code>config/locales</code> directory representing the different languages that can be used in Expertiza.
** One for English, which will be the default language used, and another for Hindi.
*** <code>en.yml</code>
*** <code>hi_IN.yml</code>
** These <code>yaml</code> files contain the translated strings for their respective language.
* We will be editing the <code>routes.rb</code> file and all the view files so that it can read from the <code>yaml</code> files to show other languages.

===Example Output===

====Original Page====
[[File:Edit Course default.PNG|300px|frame]]

====Language Dropdown====

[[File:Edit Course mock en.PNG]]

====Translated Page====

[[File:Edit Course mock hi IN.PNG]]

== Links/References ==

===Project Links===

* Pull Request:
* Github: https://github.com/mukhtar23/expertiza
* Video:

===Support Material===
* [https://guides.rubyonrails.org/i18n.html#how-i18n-in-ruby-on-rails-works https://guides.rubyonrails.org/i18n.html#how-i18n-in-ruby-on-rails-works]
* [https://guides.rubyonrails.org/i18n.html#setting-the-locale-from-url-params https://guides.rubyonrails.org/i18n.html#setting-the-locale-from-url-params]
* [https://guides.rubyonrails.org/i18n.html#abstracting-localized-code https://guides.rubyonrails.org/i18n.html#abstracting-localized-code]
* [https://guides.rubyonrails.org/i18n.html#providing-translations-for-internationalized-strings https://guides.rubyonrails.org/i18n.html#providing-translations-for-internationalized-strings]
* [https://guides.rubyonrails.org/i18n.html#passing-variables-to-translations https://guides.rubyonrails.org/i18n.html#passing-variables-to-translations]

CSC/ECE 517 Fall 2018/E1866 Expertiza Internationalization

2018-11-12T21:56:21Z

Jtgill:

== Introduction ==

===Team Members===

Jonathan Gill (jtgill@ncsu.edu)

Hasham Mukhtar (hmukhta@ncsu.edu)

Abhilasha Saini (asaini4@ncsu.edu)

Reddy Aravind Karnam Ganesh (rkarnam@ncsu.edu)

===Relevant Files===

config/locales

routes.rb

all view files

== Project Description ==

Currently Expertiza only supports creating courses in the English language. Many Expertiza users are from other countries. We aim to allow instructors to create courses in other languages. This will be done by internationalizing static strings in Expertiza to another language (ex: Hindi or Chinese). Instructors will have the ability to change the language for a course in the Edit Course page through a dropdown. We will not be affecting any strings that are dynamically shown and are not changing any English strings in the actual code.

== Project Design ==

===Technical Design===

====Allowing instructor to change language for a course====

* We will add a <code>language</code> column to the <code>Courses</code> Table.
* Then we will add a dropdown of languages to the Edit Course page for an instructor to use.
* When an instructor updates the Edit Course page with a chosen language picked, it will translate all the static strings in the Expertiza application to that new language.

====Adding Multi-Language Support====

* For this project, we will be adding support for one language right now, Hindi.
* We will be using the [https://guides.rubyonrails.org/i18n.html#how-i18n-in-ruby-on-rails-works Rails Internationalization (I18n) API] to help us add multi language support.
* There will be two <code>yaml</code> files in the <code>config/locales</code> directory representing the different languages that can be used in Expertiza.
** One for English, which will be the default language used, and another for Hindi.
*** <code>en.yml</code>
*** <code>hi_IN.yml</code>
** These <code>yaml</code> files contain the translated strings for their respective language.
* We will be editing the <code>routes.rb</code> file and all the view files so that it can read from the <code>yaml</code> files to show other languages.

===Example Output===

====Original Page====
[[File:Edit Course default.PNG|300px|frame|center]]

====Language Dropdown====

[[File:Edit Course mock en.PNG]]

====Translated Page====

[[File:Edit Course mock hi IN.PNG]]

== Links/References ==

===Project Links===

* Pull Request:
* Github: https://github.com/mukhtar23/expertiza
* Video:

===Support Material===
* [https://guides.rubyonrails.org/i18n.html#how-i18n-in-ruby-on-rails-works https://guides.rubyonrails.org/i18n.html#how-i18n-in-ruby-on-rails-works]
* [https://guides.rubyonrails.org/i18n.html#setting-the-locale-from-url-params https://guides.rubyonrails.org/i18n.html#setting-the-locale-from-url-params]
* [https://guides.rubyonrails.org/i18n.html#abstracting-localized-code https://guides.rubyonrails.org/i18n.html#abstracting-localized-code]
* [https://guides.rubyonrails.org/i18n.html#providing-translations-for-internationalized-strings https://guides.rubyonrails.org/i18n.html#providing-translations-for-internationalized-strings]
* [https://guides.rubyonrails.org/i18n.html#passing-variables-to-translations https://guides.rubyonrails.org/i18n.html#passing-variables-to-translations]

CSC/ECE 517 Fall 2018/E1866 Expertiza Internationalization

2018-11-12T21:55:53Z

Jtgill:

== Introduction ==

===Team Members===

Jonathan Gill (jtgill@ncsu.edu)

Hasham Mukhtar (hmukhta@ncsu.edu)

Abhilasha Saini (asaini4@ncsu.edu)

Reddy Aravind Karnam Ganesh (rkarnam@ncsu.edu)

===Relevant Files===

config/locales

routes.rb

all view files

== Project Description ==

Currently Expertiza only supports creating courses in the English language. Many Expertiza users are from other countries. We aim to allow instructors to create courses in other languages. This will be done by internationalizing static strings in Expertiza to another language (ex: Hindi or Chinese). Instructors will have the ability to change the language for a course in the Edit Course page through a dropdown. We will not be affecting any strings that are dynamically shown and are not changing any English strings in the actual code.

== Project Design ==

===Technical Design===

====Allowing instructor to change language for a course====

* We will add a <code>language</code> column to the <code>Courses</code> Table.
* Then we will add a dropdown of languages to the Edit Course page for an instructor to use.
* When an instructor updates the Edit Course page with a chosen language picked, it will translate all the static strings in the Expertiza application to that new language.

====Adding Multi-Language Support====

* For this project, we will be adding support for one language right now, Hindi.
* We will be using the [https://guides.rubyonrails.org/i18n.html#how-i18n-in-ruby-on-rails-works Rails Internationalization (I18n) API] to help us add multi language support.
* There will be two <code>yaml</code> files in the <code>config/locales</code> directory representing the different languages that can be used in Expertiza.
** One for English, which will be the default language used, and another for Hindi.
*** <code>en.yml</code>
*** <code>hi_IN.yml</code>
** These <code>yaml</code> files contain the translated strings for their respective language.
* We will be editing the <code>routes.rb</code> file and all the view files so that it can read from the <code>yaml</code> files to show other languages.

===Example Output===

====Original Page====
[[File:Edit Course default.PNG|500px|frame|center]]

====Language Dropdown====

[[File:Edit Course mock en.PNG]]

====Translated Page====

[[File:Edit Course mock hi IN.PNG]]

== Links/References ==

===Project Links===

* Pull Request:
* Github: https://github.com/mukhtar23/expertiza
* Video:

===Support Material===
* [https://guides.rubyonrails.org/i18n.html#how-i18n-in-ruby-on-rails-works https://guides.rubyonrails.org/i18n.html#how-i18n-in-ruby-on-rails-works]
* [https://guides.rubyonrails.org/i18n.html#setting-the-locale-from-url-params https://guides.rubyonrails.org/i18n.html#setting-the-locale-from-url-params]
* [https://guides.rubyonrails.org/i18n.html#abstracting-localized-code https://guides.rubyonrails.org/i18n.html#abstracting-localized-code]
* [https://guides.rubyonrails.org/i18n.html#providing-translations-for-internationalized-strings https://guides.rubyonrails.org/i18n.html#providing-translations-for-internationalized-strings]
* [https://guides.rubyonrails.org/i18n.html#passing-variables-to-translations https://guides.rubyonrails.org/i18n.html#passing-variables-to-translations]

CSC/ECE 517 Fall 2018/E1866 Expertiza Internationalization

2018-11-12T21:53:48Z

Jtgill:

== Introduction ==

===Team Members===

Jonathan Gill (jtgill@ncsu.edu)

Hasham Mukhtar (hmukhta@ncsu.edu)

Abhilasha Saini (asaini4@ncsu.edu)

Reddy Aravind Karnam Ganesh (rkarnam@ncsu.edu)

===Relevant Files===

config/locales

routes.rb

all view files

== Project Description ==

Currently Expertiza only supports creating courses in the English language. Many Expertiza users are from other countries. We aim to allow instructors to create courses in other languages. This will be done by internationalizing static strings in Expertiza to another language (ex: Hindi or Chinese). Instructors will have the ability to change the language for a course in the Edit Course page through a dropdown. We will not be affecting any strings that are dynamically shown and are not changing any English strings in the actual code.

== Project Design ==

===Technical Design===

====Allowing instructor to change language for a course====

* We will add a <code>language</code> column to the <code>Courses</code> Table.
* Then we will add a dropdown of languages to the Edit Course page for an instructor to use.
* When an instructor updates the Edit Course page with a chosen language picked, it will translate all the static strings in the Expertiza application to that new language.

====Adding Multi-Language Support====

* For this project, we will be adding support for one language right now, Hindi.
* We will be using the [https://guides.rubyonrails.org/i18n.html#how-i18n-in-ruby-on-rails-works Rails Internationalization (I18n) API] to help us add multi language support.
* There will be two <code>yaml</code> files in the <code>config/locales</code> directory representing the different languages that can be used in Expertiza.
** One for English, which will be the default language used, and another for Hindi.
*** <code>en.yml</code>
*** <code>hi_IN.yml</code>
** These <code>yaml</code> files contain the translated strings for their respective language.
* We will be editing the <code>routes.rb</code> file and all the view files so that it can read from the <code>yaml</code> files to show other languages.

===Example Output===

====Original Page====
[[File:Edit Course default.PNG|200px]]

====Language Dropdown====

[[File:Edit Course mock en.PNG]]

====Translated Page====

[[File:Edit Course mock hi IN.PNG]]

== Links/References ==

===Project Links===

* Pull Request:
* Github: https://github.com/mukhtar23/expertiza
* Video:

===Support Material===
* [https://guides.rubyonrails.org/i18n.html#how-i18n-in-ruby-on-rails-works https://guides.rubyonrails.org/i18n.html#how-i18n-in-ruby-on-rails-works]
* [https://guides.rubyonrails.org/i18n.html#setting-the-locale-from-url-params https://guides.rubyonrails.org/i18n.html#setting-the-locale-from-url-params]
* [https://guides.rubyonrails.org/i18n.html#abstracting-localized-code https://guides.rubyonrails.org/i18n.html#abstracting-localized-code]
* [https://guides.rubyonrails.org/i18n.html#providing-translations-for-internationalized-strings https://guides.rubyonrails.org/i18n.html#providing-translations-for-internationalized-strings]
* [https://guides.rubyonrails.org/i18n.html#passing-variables-to-translations https://guides.rubyonrails.org/i18n.html#passing-variables-to-translations]

CSC/ECE 517 Fall 2018/E1866 Expertiza Internationalization

2018-11-12T21:53:16Z

Jtgill:

== Introduction ==

===Team Members===

Jonathan Gill (jtgill@ncsu.edu)

Hasham Mukhtar (hmukhta@ncsu.edu)

Abhilasha Saini (asaini4@ncsu.edu)

Reddy Aravind Karnam Ganesh (rkarnam@ncsu.edu)

===Relevant Files===

config/locales

routes.rb

all view files

== Project Description ==

Currently Expertiza only supports creating courses in the English language. Many Expertiza users are from other countries. We aim to allow instructors to create courses in other languages. This will be done by internationalizing static strings in Expertiza to another language (ex: Hindi or Chinese). Instructors will have the ability to change the language for a course in the Edit Course page through a dropdown. We will not be affecting any strings that are dynamically shown and are not changing any English strings in the actual code.

== Project Design ==

===Technical Design===

====Allowing instructor to change language for a course====

* We will add a <code>language</code> column to the <code>Courses</code> Table.
* Then we will add a dropdown of languages to the Edit Course page for an instructor to use.
* When an instructor updates the Edit Course page with a chosen language picked, it will translate all the static strings in the Expertiza application to that new language.

====Adding Multi-Language Support====

* For this project, we will be adding support for one language right now, Hindi.
* We will be using the [https://guides.rubyonrails.org/i18n.html#how-i18n-in-ruby-on-rails-works Rails Internationalization (I18n) API] to help us add multi language support.
* There will be two <code>yaml</code> files in the <code>config/locales</code> directory representing the different languages that can be used in Expertiza.
** One for English, which will be the default language used, and another for Hindi.
*** <code>en.yml</code>
*** <code>hi_IN.yml</code>
** These <code>yaml</code> files contain the translated strings for their respective language.
* We will be editing the <code>routes.rb</code> file and all the view files so that it can read from the <code>yaml</code> files to show other languages.

===Example Output===

====Original Page====
[[File:Edit Course default.PNG|200px|left|alt text]]

====Language Dropdown====

[[File:Edit Course mock en.PNG]]

====Translated Page====

[[File:Edit Course mock hi IN.PNG]]

== Links/References ==

===Project Links===

* Pull Request:
* Github: https://github.com/mukhtar23/expertiza
* Video:

===Support Material===
* [https://guides.rubyonrails.org/i18n.html#how-i18n-in-ruby-on-rails-works https://guides.rubyonrails.org/i18n.html#how-i18n-in-ruby-on-rails-works]
* [https://guides.rubyonrails.org/i18n.html#setting-the-locale-from-url-params https://guides.rubyonrails.org/i18n.html#setting-the-locale-from-url-params]
* [https://guides.rubyonrails.org/i18n.html#abstracting-localized-code https://guides.rubyonrails.org/i18n.html#abstracting-localized-code]
* [https://guides.rubyonrails.org/i18n.html#providing-translations-for-internationalized-strings https://guides.rubyonrails.org/i18n.html#providing-translations-for-internationalized-strings]
* [https://guides.rubyonrails.org/i18n.html#passing-variables-to-translations https://guides.rubyonrails.org/i18n.html#passing-variables-to-translations]

CSC/ECE 517 Fall 2018/E1866 Expertiza Internationalization

2018-11-12T21:52:17Z

Jtgill:

== Introduction ==

===Team Members===

Jonathan Gill (jtgill@ncsu.edu)

Hasham Mukhtar (hmukhta@ncsu.edu)

Abhilasha Saini (asaini4@ncsu.edu)

Reddy Aravind Karnam Ganesh (rkarnam@ncsu.edu)

===Relevant Files===

config/locales

routes.rb

all view files

== Project Description ==

Currently Expertiza only supports creating courses in the English language. Many Expertiza users are from other countries. We aim to allow instructors to create courses in other languages. This will be done by internationalizing static strings in Expertiza to another language (ex: Hindi or Chinese). Instructors will have the ability to change the language for a course in the Edit Course page through a dropdown. We will not be affecting any strings that are dynamically shown and are not changing any English strings in the actual code.

== Project Design ==

===Technical Design===

====Allowing instructor to change language for a course====

* We will add a <code>language</code> column to the <code>Courses</code> Table.
* Then we will add a dropdown of languages to the Edit Course page for an instructor to use.
* When an instructor updates the Edit Course page with a chosen language picked, it will translate all the static strings in the Expertiza application to that new language.

====Adding Multi-Language Support====

* For this project, we will be adding support for one language right now, Hindi.
* We will be using the [https://guides.rubyonrails.org/i18n.html#how-i18n-in-ruby-on-rails-works Rails Internationalization (I18n) API] to help us add multi language support.
* There will be two <code>yaml</code> files in the <code>config/locales</code> directory representing the different languages that can be used in Expertiza.
** One for English, which will be the default language used, and another for Hindi.
*** <code>en.yml</code>
*** <code>hi_IN.yml</code>
** These <code>yaml</code> files contain the translated strings for their respective language.
* We will be editing the <code>routes.rb</code> file and all the view files so that it can read from the <code>yaml</code> files to show other languages.

===Example Output===

====Original Page====
[[File:Edit Course default.PNG|200px|thumb|left|alt text]]

====Language Dropdown====

[[File:Edit Course mock en.PNG]]

====Translated Page====

[[File:Edit Course mock hi IN.PNG]]

== Links/References ==

===Project Links===

* Pull Request:
* Github: [https://github.com/mukhtar23/expertiza]
* Video:

===Support Material===
* [https://guides.rubyonrails.org/i18n.html#how-i18n-in-ruby-on-rails-works https://guides.rubyonrails.org/i18n.html#how-i18n-in-ruby-on-rails-works]
* [https://guides.rubyonrails.org/i18n.html#setting-the-locale-from-url-params https://guides.rubyonrails.org/i18n.html#setting-the-locale-from-url-params]
* [https://guides.rubyonrails.org/i18n.html#abstracting-localized-code https://guides.rubyonrails.org/i18n.html#abstracting-localized-code]
* [https://guides.rubyonrails.org/i18n.html#providing-translations-for-internationalized-strings https://guides.rubyonrails.org/i18n.html#providing-translations-for-internationalized-strings]
* [https://guides.rubyonrails.org/i18n.html#passing-variables-to-translations https://guides.rubyonrails.org/i18n.html#passing-variables-to-translations]

CSC/ECE 517 Fall 2018/E1866 Expertiza Internationalization

2018-11-12T21:43:48Z

Jtgill:

== Introduction ==

===Team Members===

Jonathan Gill (jtgill@ncsu.edu)

Hasham Mukhtar (hmukhta@ncsu.edu)

Abhilasha Saini (asaini4@ncsu.edu)

Reddy Aravind Karnam Ganesh (rkarnam@ncsu.edu)

===Relevant Files===

config/locales

routes.rb

all view files

== Project Description ==

Currently Expertiza only supports creating courses in the English language. Many Expertiza users are from other countries. We aim to allow instructors to create courses in other languages. This will be done by internationalizing static strings in Expertiza to another language (ex: Hindi or Chinese). Instructors will have the ability to change the language for a course in the Edit Course page through a dropdown. We will not be affecting any strings that are dynamically shown and are not changing any English strings in the actual code.

== Project Design ==

===Technical Design===

====Allowing instructor to change language for a course====

* We will add a <code>language</code> column to the <code>Courses</code> Table.
* Then we will add a dropdown of languages to the Edit Course page for an instructor to use.
* When an instructor updates the Edit Course page with a chosen language picked, it will translate all the static strings in the Expertiza application to that new language.

====Adding Multi-Language Support====

* For this project, we will be adding support for one language right now, Hindi.
* We will be using the [https://guides.rubyonrails.org/i18n.html#how-i18n-in-ruby-on-rails-works Rails Internationalization (I18n) API] to help us add multi language support.
* There will be two <code>yaml</code> files in the <code>config/locales</code> directory representing the different languages that can be used in Expertiza.
** One for English, which will be the default language used, and another for Hindi.
*** <code>en.yml</code>
*** <code>hi_IN.yml</code>
** These <code>yaml</code> files contain the translated strings for their respective language.
* We will be editing the <code>routes.rb</code> file and all the view files so that it can read from the <code>yaml</code> files to show other languages.

===Original Output===

[[File:Edit Course default.PNG]]

===Example Output===

[[File:Edit Course mock en.PNG]]

[[File:Edit Course mock hi IN.PNG]]

== Links/References ==

===Project Links===

* Pull Request:
* Github:
* Video:

===Support Material===
* [https://guides.rubyonrails.org/i18n.html#how-i18n-in-ruby-on-rails-works https://guides.rubyonrails.org/i18n.html#how-i18n-in-ruby-on-rails-works]
* [https://guides.rubyonrails.org/i18n.html#setting-the-locale-from-url-params https://guides.rubyonrails.org/i18n.html#setting-the-locale-from-url-params]
* [https://guides.rubyonrails.org/i18n.html#abstracting-localized-code https://guides.rubyonrails.org/i18n.html#abstracting-localized-code]
* [https://guides.rubyonrails.org/i18n.html#providing-translations-for-internationalized-strings https://guides.rubyonrails.org/i18n.html#providing-translations-for-internationalized-strings]
* [https://guides.rubyonrails.org/i18n.html#passing-variables-to-translations https://guides.rubyonrails.org/i18n.html#passing-variables-to-translations]

File:Edit Course mock hi IN.PNG

2018-11-12T21:42:46Z

Jtgill: This is a mock-up of the Edit Course page when Hindi is selected.

This is a mock-up of the Edit Course page when Hindi is selected.

CSC/ECE 517 Fall 2018/E1866 Expertiza Internationalization

2018-11-12T21:40:48Z

Jtgill:

== Introduction ==

===Team Members===

Jonathan Gill (jtgill@ncsu.edu)

Hasham Mukhtar (hmukhta@ncsu.edu)

Abhilasha Saini (asaini4@ncsu.edu)

Reddy Aravind Karnam Ganesh (rkarnam@ncsu.edu)

===Relevant Files===

config/locales

routes.rb

all view files

== Project Description ==

Currently Expertiza only supports creating courses in the English language. Many Expertiza users are from other countries. We aim to allow instructors to create courses in other languages. This will be done by internationalizing static strings in Expertiza to another language (ex: Hindi or Chinese). Instructors will have the ability to change the language for a course in the Edit Course page through a dropdown. We will not be affecting any strings that are dynamically shown and are not changing any English strings in the actual code.

== Project Design ==

===Technical Design===

====Allowing instructor to change language for a course====

* We will add a <code>language</code> column to the <code>Courses</code> Table.
* Then we will add a dropdown of languages to the Edit Course page for an instructor to use.
* When an instructor updates the Edit Course page with a chosen language picked, it will translate all the static strings in the Expertiza application to that new language.

====Adding Multi-Language Support====

* For this project, we will be adding support for one language right now, Hindi.
* We will be using the [https://guides.rubyonrails.org/i18n.html#how-i18n-in-ruby-on-rails-works Rails Internationalization (I18n) API] to help us add multi language support.
* There will be two <code>yaml</code> files in the <code>config/locales</code> directory representing the different languages that can be used in Expertiza.
** One for English, which will be the default language used, and another for Hindi.
*** <code>en.yml</code>
*** <code>hi_IN.yml</code>
** These <code>yaml</code> files contain the translated strings for their respective language.
* We will be editing the <code>routes.rb</code> file and all the view files so that it can read from the <code>yaml</code> files to show other languages.

===Original Output===

[[File:Edit Course default.PNG]]

===Example Output===

[[File:Edit Course mock en.PNG]]

== Links/References ==

===Project Links===

* Pull Request:
* Github:
* Video:

===Support Material===
* [https://guides.rubyonrails.org/i18n.html#how-i18n-in-ruby-on-rails-works https://guides.rubyonrails.org/i18n.html#how-i18n-in-ruby-on-rails-works]
* [https://guides.rubyonrails.org/i18n.html#setting-the-locale-from-url-params https://guides.rubyonrails.org/i18n.html#setting-the-locale-from-url-params]
* [https://guides.rubyonrails.org/i18n.html#abstracting-localized-code https://guides.rubyonrails.org/i18n.html#abstracting-localized-code]
* [https://guides.rubyonrails.org/i18n.html#providing-translations-for-internationalized-strings https://guides.rubyonrails.org/i18n.html#providing-translations-for-internationalized-strings]
* [https://guides.rubyonrails.org/i18n.html#passing-variables-to-translations https://guides.rubyonrails.org/i18n.html#passing-variables-to-translations]

File:Edit Course mock en.PNG

2018-11-12T21:40:03Z

Jtgill: This is a mock-up of the new Edit Course page when English is selected.

This is a mock-up of the new Edit Course page when English is selected.

CSC/ECE 517 Fall 2018/E1866 Expertiza Internationalization

2018-11-12T21:36:12Z

Jtgill:

== Introduction ==

===Team Members===

Jonathan Gill (jtgill@ncsu.edu)

Hasham Mukhtar (hmukhta@ncsu.edu)

Abhilasha Saini (asaini4@ncsu.edu)

Reddy Aravind Karnam Ganesh (rkarnam@ncsu.edu)

===Relevant Files===

config/locales

routes.rb

all view files

== Project Description ==

Currently Expertiza only supports creating courses in the English language. Many Expertiza users are from other countries. We aim to allow instructors to create courses in other languages. This will be done by internationalizing static strings in Expertiza to another language (ex: Hindi or Chinese). Instructors will have the ability to change the language for a course in the Edit Course page through a dropdown. We will not be affecting any strings that are dynamically shown and are not changing any English strings in the actual code.

== Project Design ==

===Technical Design===

====Allowing instructor to change language for a course====

* We will add a <code>language</code> column to the <code>Courses</code> Table.
* Then we will add a dropdown of languages to the Edit Course page for an instructor to use.
* When an instructor updates the Edit Course page with a chosen language picked, it will translate all the static strings in the Expertiza application to that new language.

====Adding Multi-Language Support====

* For this project, we will be adding support for one language right now, Hindi.
* We will be using the [https://guides.rubyonrails.org/i18n.html#how-i18n-in-ruby-on-rails-works Rails Internationalization (I18n) API] to help us add multi language support.
* There will be two <code>yaml</code> files in the <code>config/locales</code> directory representing the different languages that can be used in Expertiza.
** One for English, which will be the default language used, and another for Hindi.
*** <code>en.yml</code>
*** <code>hi_IN.yml</code>
** These <code>yaml</code> files contain the translated strings for their respective language.
* We will be editing the <code>routes.rb</code> file and all the view files so that it can read from the <code>yaml</code> files to show other languages.

===Original Output===

[[File:Edit Course default.PNG]]

===Example Output===

== Links/References ==

===Project Links===

* Pull Request:
* Github:
* Video:

===Support Material===
* [https://guides.rubyonrails.org/i18n.html#how-i18n-in-ruby-on-rails-works https://guides.rubyonrails.org/i18n.html#how-i18n-in-ruby-on-rails-works]
* [https://guides.rubyonrails.org/i18n.html#setting-the-locale-from-url-params https://guides.rubyonrails.org/i18n.html#setting-the-locale-from-url-params]
* [https://guides.rubyonrails.org/i18n.html#abstracting-localized-code https://guides.rubyonrails.org/i18n.html#abstracting-localized-code]
* [https://guides.rubyonrails.org/i18n.html#providing-translations-for-internationalized-strings https://guides.rubyonrails.org/i18n.html#providing-translations-for-internationalized-strings]
* [https://guides.rubyonrails.org/i18n.html#passing-variables-to-translations https://guides.rubyonrails.org/i18n.html#passing-variables-to-translations]

File:Edit Course default.PNG

2018-11-12T21:33:58Z

Jtgill: The original Edit Course page

The original Edit Course page

CSC/ECE 517 Fall 2018/E1866 Expertiza Internationalization

2018-11-12T20:30:35Z

Jtgill:

== Introduction ==

'''Team Members'''

Jonathan Gill (jtgill@ncsu.edu)

Hasham Mukhtar (hmukhta@ncsu.edu)

Abhilasha Saini (asaini4@ncsu.edu)

Reddy Aravind Karnam Ganesh (rkarnam@ncsu.edu)

'''Relevant Files'''

config/locales

routes.rb

all view files

== Project Description ==

Currently Expertiza only supports creating courses in the English language. Many Expertiza users are from other countries. We aim to allow instructors to create courses in other languages.

== Project Design ==

== Links/References ==

* [https://guides.rubyonrails.org/i18n.html#how-i18n-in-ruby-on-rails-works https://guides.rubyonrails.org/i18n.html#how-i18n-in-ruby-on-rails-works]
* [https://guides.rubyonrails.org/i18n.html#setting-the-locale-from-url-params https://guides.rubyonrails.org/i18n.html#setting-the-locale-from-url-params]
* [https://guides.rubyonrails.org/i18n.html#abstracting-localized-code https://guides.rubyonrails.org/i18n.html#abstracting-localized-code]
* [https://guides.rubyonrails.org/i18n.html#providing-translations-for-internationalized-strings https://guides.rubyonrails.org/i18n.html#providing-translations-for-internationalized-strings]
* [https://guides.rubyonrails.org/i18n.html#providing-translations-for-internationalized-strings https://guides.rubyonrails.org/i18n.html#providing-translations-for-internationalized-strings]
* [https://guides.rubyonrails.org/i18n.html#passing-variables-to-translations https://guides.rubyonrails.org/i18n.html#passing-variables-to-translations]

CSC/ECE 517 Fall 2018/E1866 Expertiza Internationalization

2018-11-12T20:14:13Z

Jtgill:

CSC/ECE 517 Fall 2018

2018-11-11T22:13:06Z

Jtgill:

* [[CSC/ECE 517 Fall 2018- Project E1846. OSS Project Navy: Character Issues]]
* [[CSC/ECE 517 Fall 2018/OSS E1848 Write unit tests for assignment team.rb]]
* [http://wiki.expertiza.ncsu.edu/index.php/E1839_Review_Requirements_and_Thresholds CSC/ECE 517 Fall 2018 E1839 Review Requirements and Thresholds]
* [http://wiki.expertiza.ncsu.edu/index.php/E1848_Write_unit_tests_for_assignment_team CSC/ECE 517 Fall 2018 E1848 Write unit tests for assignment_team]
* [http://wiki.expertiza.ncsu.edu/index.php/E1835_Refactor_delayed_mailer_and_scheduled_task CSC/ECE 517 Fall 2018 E1835_Refactor_delayed_mailer_and_scheduled_task]
* [http://wiki.expertiza.ncsu.edu/index.php/E1829_OSS_project_Duke_Blue_Fix_import_glitches CSC/ECE 517 Fall 2018 E1829 OSS project Duke Blue: Fix import glitches]
* [http://wiki.expertiza.ncsu.edu/index.php/CSC/ECE_517_Fall_2018/E1853_Write_unit_tests_for_menu.rb CSC/ECE 517 Fall 2018 E1853 Write unit tests for menu.rb]
* [http://wiki.expertiza.ncsu.edu/index.php/E1853_write_unit_tests_for_menu CSC/ECE517 Fall 2018 E1853 Write Unit Tests For menu.rb]
* [http://wiki.expertiza.ncsu.edu/index.php/CSC/ECE_517_Fall_2018_-_Project_E1852_Write_unit_tests_for_participant.rb CSC/ECE 517 Fall 2018 E1852 Write unit tests for participant.rb]
* [http://wiki.expertiza.ncsu.edu/index.php/E1844_Issues_related_to_names CSC/ECE 517 Fall 2018 E1844 Issues related to names]
* [http://wiki.expertiza.ncsu.edu/index.php/User_talk:Rshakya CSC/ECE 517 Fall 2018/E1852 Unit Test for Participant Model]
* [http://wiki.expertiza.ncsu.edu/index.php/E1850_Write_unit_tests_for_review_response_map CSC/ECE 517 Fall 2018 Write unit tests for review-response_map.rb]
* [http://wiki.expertiza.ncsu.edu/index.php/CSC/ECE_517_Fall_2018/E1849_Write_Unit_Tests_for_vm_question_response.rb CSC/ECE 517 Fall 2018/E1849 Write Unit Tests for vm_question_response.rb]
* [http://wiki.expertiza.ncsu.edu/index.php/CSC/ECE_517_Fall_2018/E1866_Expertiza_Internationalization CSC/ECE 517 Fall 2018/E1866 Expertiza Internationalization]

CSC/ECE 517 Fall 2018/E1866 Expertiza Internationalization

2018-11-11T22:04:31Z

Jtgill:

CSC/ECE 517 Fall 2018/E1866 Expertiza Internationalization

2018-11-11T21:50:52Z

Jtgill: Created page with " == Introduction == == Project Description == == Project Design =="

== Introduction ==

== Project Description ==

== Project Design ==

CSC/ECE 517 Fall 2018/E1849 Write Unit Tests for vm question response.rb

2018-11-10T04:48:05Z

Jtgill: /* Links/Resources */

== Introduction ==

=== VMQuestionResponse in Brief ===
This class acquires reviews from a given questionnaire and assignment, and creates a heat map visualization of the review scores a reviewee received from other people (reviewers) for an assignment.

== Objective ==

There are currently no test cases for vm_question_response.rb. We seek to create unit tests to attain at least 90% coverage by line.

=== Team ===

Matt Leader (mfleader@ncsu.edu)

Jonathan Gill (jtgill@ncsu.edu)

=== Files Involved ===

app/models/vm_question_response.rb

spec/models/vm_question_response_spec.rb

== Testing Plan ==

=== Testing Strategy: Unit Test ===
Testing VMQuestionResponse hinges upon collaboration verification, so that we know VMQuestionResponse is getting the right messages from the right classes, so that it can appropriately create its data structures.

We first went through each method of the VMQuestionResponse class and determined whether the method was a command, or query and whether the method was incoming, outgoing, or sent-to-self. For each method we will write tests for valid and invalid inputs as well as edge cases.

Here is an outline of our implementation strategy:

To describe VMQuestionResponse

1) Test initialize

* in the context when VMQuestionResponse is initialized with a review questionnaire

* in the context when VMQuestionResponse is initialized with any other questionnaire type

2) Test add questions

* in the context when VMQuestionResponse is given a list of questions

3) Test add_reviews

* in the context when VMQuestionResponse is initialized with a review questionnaire

* in the context when VMQuestionResponse is initialized with a author feedback questionnaire

* in the context when VMQuestionResponse is initialized with a teammate review questionnaire

* in the context when VMQuestionResponse is initialized with a metareview questionnaire

4) Test display_team_members

5) Test add_team_members

6) Test listofteamparticipants

7) Test max_score_for_questionnaire

8) Test add_answer

9) Test get_number_of_comments_greater_than_10_words

== Testing Implementation ==

*''initialize'' : This tests that the VmQuestionResponse is initialized with the appropriate round number.
<pre>
</pre>

*''add_reviews'' : This tests that the add_review adds reviews and reviewers to the VmQuestionResponse from a given review
:- stub simulates the
<pre>
</pre>

*''display_team_members'' : This tests that the VmQuestionResponse can print out the appropriate team member names.
<pre>
</pre>

*''add_answers'' : This tests that the VmQuestionResponse adds all of the review scores from its reviews to VmQuestionResponseCells
in VmQuestionResponseRows.
<pre>
</pre>

*''get_number_of_comments_greater_than_10_words'' : This tests that VmQuestionResponse only finds comments that have at least 10 words.
<pre>
</pre>

== Results ==

We have now attained 97.25% coverage.

== Links/Resources ==

[https://github.com/mfleader42/expertiza/blob/master/spec/models/vm_question_response_spec.rb spec/models/vm_question_response_spec.rb]

[https://youtu.be/yDfhSqVOoOk Testing Video(YouTube)]

CSC/ECE 517 Fall 2018/E1849 Write Unit Tests for vm question response.rb

2018-11-10T04:47:54Z

Jtgill: /* Links/Resources */

== Introduction ==

=== VMQuestionResponse in Brief ===
This class acquires reviews from a given questionnaire and assignment, and creates a heat map visualization of the review scores a reviewee received from other people (reviewers) for an assignment.

== Objective ==

There are currently no test cases for vm_question_response.rb. We seek to create unit tests to attain at least 90% coverage by line.

=== Team ===

Matt Leader (mfleader@ncsu.edu)

Jonathan Gill (jtgill@ncsu.edu)

=== Files Involved ===

app/models/vm_question_response.rb

spec/models/vm_question_response_spec.rb

== Testing Plan ==

=== Testing Strategy: Unit Test ===
Testing VMQuestionResponse hinges upon collaboration verification, so that we know VMQuestionResponse is getting the right messages from the right classes, so that it can appropriately create its data structures.

We first went through each method of the VMQuestionResponse class and determined whether the method was a command, or query and whether the method was incoming, outgoing, or sent-to-self. For each method we will write tests for valid and invalid inputs as well as edge cases.

Here is an outline of our implementation strategy:

To describe VMQuestionResponse

1) Test initialize

* in the context when VMQuestionResponse is initialized with a review questionnaire

* in the context when VMQuestionResponse is initialized with any other questionnaire type

2) Test add questions

* in the context when VMQuestionResponse is given a list of questions

3) Test add_reviews

* in the context when VMQuestionResponse is initialized with a review questionnaire

* in the context when VMQuestionResponse is initialized with a author feedback questionnaire

* in the context when VMQuestionResponse is initialized with a teammate review questionnaire

* in the context when VMQuestionResponse is initialized with a metareview questionnaire

4) Test display_team_members

5) Test add_team_members

6) Test listofteamparticipants

7) Test max_score_for_questionnaire

8) Test add_answer

9) Test get_number_of_comments_greater_than_10_words

== Testing Implementation ==

*''initialize'' : This tests that the VmQuestionResponse is initialized with the appropriate round number.
<pre>
</pre>

*''add_reviews'' : This tests that the add_review adds reviews and reviewers to the VmQuestionResponse from a given review
:- stub simulates the
<pre>
</pre>

*''display_team_members'' : This tests that the VmQuestionResponse can print out the appropriate team member names.
<pre>
</pre>

*''add_answers'' : This tests that the VmQuestionResponse adds all of the review scores from its reviews to VmQuestionResponseCells
in VmQuestionResponseRows.
<pre>
</pre>

*''get_number_of_comments_greater_than_10_words'' : This tests that VmQuestionResponse only finds comments that have at least 10 words.
<pre>
</pre>

== Results ==

We have now attained 97.25% coverage.

== Links/Resources ==

[https://github.com/mfleader42/expertiza/blob/master/spec/models/vm_question_response_spec.rb spec/models/vm_question_response_spec.rb]
[https://youtu.be/yDfhSqVOoOk Testing Video(YouTube)]

CSC/ECE 517 Fall 2018/E1849 Write Unit Tests for vm question response.rb

2018-11-10T04:39:36Z

Jtgill: /* Results */

CSC/ECE 517 Fall 2018/E1849 Write Unit Tests for vm question response.rb

2018-11-05T23:54:27Z

Jtgill:

== Problem Statement ==

There are currently no test cases for vm_question_response.rb. We seek to create unit tests for this model with a coverage of at least 90%.

'''Team'''

Matt Leader (mfleader@ncsu.edu)

Jonathan Gill (jtgill@ncsu.edu)

'''Files Involved'''

app/models/vm_question_response.rb

spec/models/vm_question_response_spec.rb

== Testing Plan ==

We first went through each method of the VMQuestionResponse class and determined whether the method was a command, or query and whether the method was incoming, outgoing, or sent-to-self. For each method we will write tests for valid and invalid inputs as well as edge cases.

Here is an outline of our implementation strategy:

describe VMQuestionResponse do

context 'when initialized with a valid assignment questionnaire'

it 'adds reviews'

context 'when given a team'

it 'displays the members of the team'

context 'when given a list of valid questions'

it 'can calculate the max score for the questionnaire'

it 'has the round value of the given questionnaire'

context 'is initialized with an AuthorFeedbackQuestionnaire'

it 'adds reviews'

it 'adds answers'

it 'get the number of comments greater than 10 words'

context 'is initialized with a TeammateReviewQuestionnair'

it 'adds reviews'

context 'is initialized with a MetaReviewQuesionnaire'

it 'adds reviews'

== Testing Implementation ==

it 'adds reviews' do

allow(ReviewResponseMap).to receive_messages(:get_assessments_for => [review], :find => mapping)

allow(Participant).to receive_messages(:find => ppnt1)

vm_rsp.add_reviews(ppnt0, team, false)

expect(vm_rsp.list_of_reviews.size).to eq 1

expect(vm_rsp.list_of_reviewers.size).to eq 1

expect(vm_rsp.list_of_reviews).to eq [review]

end

This code tests that the add_reviews method works when VMQuestionResponse has been initialized with @questionnaire_type = "ReviewQuestionnaire"

context 'when given a team' do

it 'displays the members of the team' do

team = double('team')

ppnt2 = double('ppnt2')

allow(ppnt2).to receive_messages :fullname => 'R'

team_member_names = [ppnt0, ppnt1, ppnt2]

allow(team).to receive_messages(:participants => team_member_names)

out = 'Team members:'

vm_rsp.add_team_members(team)

team.participants.each do |participant|

out = out + " (" + participant.fullname + ") "

end

expect(vm_rsp.display_team_members).to eq out

end

end

This code tests that when VMQuestionResponse is initialized with a team the team members can be displayed

context 'when given a list of valid questions' do

let(:qs) { qs = Array.new(1) { question2 } }

it 'can calculate the max score for the questionnaire' do

vm_rsp.add_questions qs

expect(vm_rsp.max_score).to eq 5

expect(vm_rsp.list_of_rows.size).to eq 1

expect(vm_rsp.max_score_for_questionnaire()).to eq qs.size * rq.max_question_score

end

end

This code tests VMQuestionResponse knows the max score for the questionnaire.

it 'has the round value of the given questionnaire' do

expect(vm_rsp.round).to eq 1

end

This code checks that VMQuestionResponse knows the value of @round for the given questionnaire.

context 'is initialized with an AuthorFeedbackQuestionnaire' do

[mock setup omitted for brevity]

it 'adds reviews' do

# review = double('review1')

# review.stub(:map_id => 1, :response_id => 1)

# allow(review).to receive_messages(:map_id => 1)

# ppnt0 = double('ppnt0')

# allow(ppnt0).to receive_messages(:feedback => [review])

# ppnt1 = double('ppnt1')

# allow(ppnt1).to receive_messages(:fullname => 'Python')

# mapping = double

# allow(mapping).to receive_messages(:first => mapping, :reviewer_id => 2)

# allow(FeedbackResponseMap).to receive_messages(:where => mapping)

# allow(Participant).to receive_messages(:find => ppnt1)

# vm_rsp.add_questions qs

# vm_rsp.add_reviews(ppnt0, '', false)

# expect(vm_rsp.list_of_reviews.size).to eq 1

# expect(vm_rsp.list_of_reviewers.size).to eq 1

# expect(vm_rsp.list_of_reviews).to eq [ppnt1]

end

it 'adds answers' do

allow(FeedbackResponseMap).to receive_messages(:where => mapping)

allow(Participant).to receive_messages(:find => ppnt1)

allow(Answer).to receive_messages(:where => [ans])

allow(TagPromptDeployment).to receive_messages(:where => [tag_dep])

allow(Question).to receive_messages(:find => question2)

allow(TagPrompt).to receive_messages(:find => true)

allow(VmTagPromptAnswer).to receive_messages(:new => '')

allow(VmQuestionResponseScoreCell).to receive_messages(:new => '')

vm_rsp.add_questions qs

vm_rsp.add_reviews(ppnt0, '', false)

end

it 'gets the number of comments greater than 10 words' do

allow(FeedbackResponseMap).to receive_messages(:where => mapping)

allow(Participant).to receive_messages(:find => ppnt1)

allow(Answer).to receive_messages(:where => [ans])

allow(TagPromptDeployment).to receive_messages(:where => [tag_dep])

allow(Question).to receive_messages(:find => question2)

allow(TagPrompt).to receive_messages(:find => true)

allow(VmTagPromptAnswer).to receive_messages(:new => '')

allow(VmQuestionResponseScoreCell).to receive_messages(:new => '')

row = double('row')

allow(row).to receive_messages(:countofcomments => 7, :question_id => 2,

:question_max_score => 5, :score_row => [3])

allow(VmQuestionResponseRow).to receive_messages(:new => row)

vm_rsp.add_questions qs

vm_rsp.add_reviews(ppnt0, '', false)

expect(vm_rsp.list_of_rows.size).to eq 1

vm_rsp.get_number_of_comments_greater_than_10_words

expect(vm_rsp.list_of_rows[0].countofcomments).to eq 7

end

end

The above tests cover the scenario in which VMQuestionResponse is initialized with @questionnaire_type = "AuthorFeedbackQuestionnaire". We check that VMQuestionResponse can add revews, add answers, and retrieve the number of comments greater than 10 words in length. Here the test for add_reviews is commented out because it is still being developed.

context 'is initialized with an TeammateReviewQuestionnaire' do

let(:tmrq) { create(:questionnaire, name: "TeammateReviewQuestionnaire",

type: 'TeammateReviewQuestionnaire') }

let(:vm_rsp) { VmQuestionResponse.new( tmrq, assignment, 1 ) }

let(:question2) { create(:question, questionnaire: tmrq, weight: 2, id: 2, type: 'good') }

let(:qs) { qs = Array.new(1) { question2 } }

it 'adds reviews' do

allow(TeammateReviewResponseMap).to receive_messages(:where => mapping)

allow(Participant).to receive_messages(:find => ppnt1)

vm_rsp.add_questions qs

vm_rsp.add_reviews(ppnt0, '', false)

expect(vm_rsp.list_of_reviews.size).to eq 1

expect(vm_rsp.list_of_reviewers.size).to eq 1

expect(vm_rsp.list_of_reviews).to eq [review]

end

end

This code checks that we can add reviews when VMQuestionResponse is initialized with @questionnaire_type = "TeammateReviewQuestionnaire".

context 'is initialized with an MetareviewQuestionnaire' do

let(:mrq) { create(:questionnaire, name: "MetareviewQuestionnaire", type: 'MetareviewQuestionnaire') }

let(:question2) { create(:question, questionnaire: mrq, weight: 2, id: 2, type: 'good') }

let(:qs) { qs = Array.new(1) { question2 } }

let(:vm_rsp) { VmQuestionResponse.new( mrq, assignment, 1 ) }

it 'adds reviews' do

allow(MetareviewResponseMap).to receive_messages(:where => mapping)

allow(Participant).to receive_messages(:find => ppnt1)

vm_rsp.add_questions qs

vm_rsp.add_reviews(ppnt0, '', false)

expect(vm_rsp.list_of_reviews.size).to eq 1

expect(vm_rsp.list_of_reviewers.size).to eq 1

expect(vm_rsp.list_of_reviews).to eq [review]

end

end

This code checks that we can add reviews when VMQuestionResponse is initialized with @questionnaire_type = "MetaReviewQuestionnaire".

== Results ==

We have now attained 91% coverage.

== Links/Resources ==

[https://github.com/mfleader42/expertiza/blob/master/spec/models/vm_question_response_spec.rb spec/models/vm_question_response_spec.rb]

CSC/ECE 517 Fall 2018/E1849 Write Unit Tests for vm question response.rb

2018-11-05T23:31:00Z

Jtgill:

CSC/ECE 517 Fall 2018/E1849 Write Unit Tests for vm question response.rb

2018-11-05T20:31:24Z

Jtgill:

CSC/ECE 517 Fall 2018

2018-11-05T18:30:23Z

Jtgill:

CSC/ECE 517 Fall 2018

2018-11-05T18:29:50Z

Jtgill:

* [[CSC/ECE 517 Fall 2018- Project E1846. OSS Project Navy: Character Issues]]
* [[CSC/ECE 517 Fall 2018/OSS E1848 Write unit tests for assignment team.rb]]
* [http://wiki.expertiza.ncsu.edu/index.php/E1839_Review_Requirements_and_Thresholds CSC/ECE 517 Fall 2018 E1839 Review Requirements and Thresholds]
* [http://wiki.expertiza.ncsu.edu/index.php/E1848_Write_unit_tests_for_assignment_team CSC/ECE 517 Fall 2018 E1848 Write unit tests for assignment_team]
* [http://wiki.expertiza.ncsu.edu/index.php/E1835_Refactor_delayed_mailer_and_scheduled_task CSC/ECE 517 Fall 2018 E1835_Refactor_delayed_mailer_and_scheduled_task]
* [http://wiki.expertiza.ncsu.edu/index.php/E1829_OSS_project_Duke_Blue_Fix_import_glitches CSC/ECE 517 Fall 2018 E1829 OSS project Duke Blue: Fix import glitches]
* [http://wiki.expertiza.ncsu.edu/index.php/CSC/ECE_517_Fall_2018/E1853_Write_unit_tests_for_menu.rb CSC/ECE 517 Fall 2018 E1853 Write unit tests for menu.rb]
* [http://wiki.expertiza.ncsu.edu/index.php/E1853_write_unit_tests_for_menu CSC/ECE517 Fall 2018 E1853 Write Unit Tests For menu.rb]
* [http://wiki.expertiza.ncsu.edu/index.php/CSC/ECE_517_Fall_2018_-_Project_E1852_Write_unit_tests_for_participant.rb CSC/ECE 517 Fall 2018 E1852 Write unit tests for participant.rb]
* [http://wiki.expertiza.ncsu.edu/index.php/E1844_Issues_related_to_names CSC/ECE 517 Fall 2018 E1844 Issues related to names]
* [http://wiki.expertiza.ncsu.edu/index.php/User_talk:Rshakya CSC/ECE 517 Fall 2018/E1852 Unit Test for Participant Model]
* [http://wiki.expertiza.ncsu.edu/index.php/E1850_Write_unit_tests_for_review_response_map CSC/ECE 517 Fall 2018 Write unit tests for review-response_map.rb]
* [http://wiki.expertiza.ncsu.edu/index.php/CSC/ECE_517_Fall_2018/E1849_Write_Unit_Tests_for_vm_question_response.rb CSC/ECE_517_Fall_2018/E1849_Write_Unit_Tests_for_vm_question_response.rb]

CSC/ECE 517 Fall 2018

2018-11-05T18:25:18Z

Jtgill:

CSC/ECE 517 Fall 2018/E1849 Write Unit Tests for vm question response.rb

2018-11-05T18:21:32Z

Jtgill: Created page with "== Problem Statement == There are currently no test cases for vm_question_response.rb. We seek to create unit tests for this model with a coverage of at least 90%. '''Team''' ..."