Andal.LND/frontend-app-learning
6
0
Fork 0
Code Issues Pull Requests Actions 1 Packages Projects Releases Wiki Activity

feat: add descriptions for i18n messages (#815)

Browse Source 
It fixes: openedx/frontend-wg/issues/74
This commit is contained in:
Ghassan Maslamani
2022-02-28 16:10:57 +02:00
committed by GitHub
parent 8325851813
commit c25ec8f1ae
32 changed files with 220 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
src/courseware/course/celebration/WeeklyGoalCelebrationModal.jsx
View File

@@ -42,6 +42,7 @@ function WeeklyGoalCelebrationModal({
<FormattedMessage
id="learning.celebration.goalCongrats"
defaultMessage="Congratulations, you met your learning goal of {nTimes} a week."
description="Greeting for learners for their weekly goal, it as well indicate their gaol, i.e. (1,3 or 5 time(s) a week)"
values={{
nTimes: (<strong>{daysPerWeek} {daysPerWeek === 1 ? 'time' : 'times'}</strong>),
}}
@@ -59,6 +60,7 @@ function WeeklyGoalCelebrationModal({
<FormattedMessage
id="learning.celebration.setGoal"
defaultMessage="Setting a goal can help you {strongText} in your course."
description="It explain the advantages of setting goal"
values={{
strongText: (<strong>achieve higher performance</strong>),
}}

5
src/courseware/course/celebration/messages.js
View File

@@ -4,14 +4,17 @@ const messages = defineMessages({
completed: {
id: 'learning.celebration.completed',
defaultMessage: 'You just completed the first section of your course.',
description: 'Shown only once to leaner when they complete their first section',
},
congrats: {
id: 'learning.celebration.congrats',
defaultMessage: 'Congratulations!',
description: 'Greeting for learners when they complete their weekly goal or finish the first section',
},
earned: {
id: 'learning.celebration.earned',
defaultMessage: 'You earned it!',
description: 'Shown below congrats messaging when leaner complete a goal',
},
emailSubject: {
id: 'learning.celebration.emailSubject',
@@ -26,6 +29,7 @@ const messages = defineMessages({
goalMet: {
id: 'learning.celebration.goalMet',
defaultMessage: 'You met your goal!',
description: 'Headline for (weekly gaol celebration) section in courseware',
},
keepItUp: {
id: 'learning.celebration.keepItUp',
@@ -35,6 +39,7 @@ const messages = defineMessages({
share: {
id: 'learning.celebration.share',
defaultMessage: 'Take a moment to celebrate and share your progress.',
description: 'Text that precedes the (sharing icon) for goal accomplishment ',
},
socialMessage: {
id: 'learning.celebration.social',

25
src/courseware/course/content-tools/calculator/Calculator.jsx
View File

@@ -99,12 +99,14 @@ class Calculator extends Component {
tagName="h6"
id="calculator.instructions"
defaultMessage="For detailed information, see the {expressions_link}."
description="Text that precedes the link which redirects to help page calculator"
values={{
expressions_link: (
<a href={getConfig().SUPPORT_URL_CALCULATOR_MATH}>
<FormattedMessage
id="calculator.instructions.support.title"
defaultMessage="Help Center"
description="Anchor text for link which redirects to help page calculator"
/>
</a>
),
@@ -115,6 +117,7 @@ class Calculator extends Component {
<FormattedMessage
id="calculator.instructions.useful.tips"
defaultMessage="Useful tips:"
description="Headline for the (list of tips) about using the calculator"
/>
</strong>
</p>
@@ -123,18 +126,21 @@ class Calculator extends Component {
<FormattedMessage
id="calculator.hint1"
defaultMessage="Use parentheses () to make expressions clear. You can use parentheses inside other parentheses."
description="The text indicate that the calculator supports parentheses"
/>
</li>
<li className="hint-item" id="hint-spaces">
<FormattedMessage
id="calculator.hint2"
defaultMessage="Do not use spaces in expressions."
description="It indicate that using a space might cause un expected behavior"
/>
</li>
<li className="hint-item" id="hint-howto-constants">
<FormattedMessage
id="calculator.hint3"
defaultMessage="For constants, indicate multiplication explicitly (example: 5*c)."
description="It indicate the style of math notation"
/>
</li>
<li className="hint-item" id="hint-howto-maffixes">
@@ -147,6 +153,7 @@ class Calculator extends Component {
<FormattedMessage
id="calculator.hint5"
defaultMessage="For functions, type the name of the function, then the expression in parentheses."
description="It indicate how to use a math function, e.g. exp(4)."
/>
</li>
</ul>
@@ -157,18 +164,21 @@ class Calculator extends Component {
<FormattedMessage
id="calculator.instruction.table.to.use.heading"
defaultMessage="To Use"
description="Column header which indicate calculator functionality"
/>
</th>
<th scope="col">
<FormattedMessage
id="calculator.instruction.table.type.heading"
defaultMessage="Type"
description="Column header which indicate the supported type(s) of a the calculator functionality"
/>
</th>
<th scope="col">
<FormattedMessage
id="calculator.instruction.table.examples.heading"
defaultMessage="Examples"
description="Column header which list examples of calculator functionality"
/>
</th>
</tr>
@@ -179,6 +189,7 @@ class Calculator extends Component {
<FormattedMessage
id="calculator.instruction.table.to.use.numbers"
defaultMessage="Numbers"
description="A calculator functionality"
/>
</th>
<td>
@@ -187,18 +198,21 @@ class Calculator extends Component {
<FormattedMessage
id="calculator.instruction.table.to.use.numbers.type1"
defaultMessage="Integers"
description="Type of numbers that is supported the calculator"
/>
</li>
<li>
<FormattedMessage
id="calculator.instruction.table.to.use.numbers.type2"
defaultMessage="Fractions"
description="Type of numbers that is supported by the calculator"
/>
</li>
<li>
<FormattedMessage
id="calculator.instruction.table.to.use.numbers.type3"
defaultMessage="Decimals"
description="Type of numbers that is supported by the calculator"
/>
</li>
</ul>
@@ -216,6 +230,7 @@ class Calculator extends Component {
<FormattedMessage
id="calculator.instruction.table.to.use.operators"
defaultMessage="Operators"
description="A calculator functionality"
/>
</th>
<td dir="auto">
@@ -225,6 +240,7 @@ class Calculator extends Component {
<FormattedMessage
id="calculator.instruction.table.to.use.operators.type1"
defaultMessage="(add, subtract, multiply, divide)"
description="Type of opprators that are supported by the calculator"
/>
</li>
<li>
@@ -232,6 +248,7 @@ class Calculator extends Component {
<FormattedMessage
id="calculator.instruction.table.to.use.operators.type2"
defaultMessage="(raise to a power)"
description="It indicate that symbol (^) is being used to raise power, e.g. 2^2 = 4"
/>
</li>
<li>
@@ -239,6 +256,7 @@ class Calculator extends Component {
<FormattedMessage
id="calculator.instruction.table.to.use.operators.type3"
defaultMessage="(parallel resistors)"
description="It indicate that the sympol (||) is being used to calculate (parallel resistor), it is a concept in electrical/electronic engineering"
/>
</li>
</ul>
@@ -257,6 +275,7 @@ class Calculator extends Component {
<FormattedMessage
id="calculator.instruction.table.to.use.constants"
defaultMessage="Constants"
description="It indicate that the calculator support constants, e.g. the speed of light"
/>
</th>
<td dir="auto">e, pi</td>
@@ -291,6 +310,7 @@ class Calculator extends Component {
<FormattedMessage
id="calculator.instruction.table.to.use.basic.functions"
defaultMessage="Basic functions"
description="It indicate that calculator supports mathematical function"
/>
</th>
<td dir="auto">abs, exp, fact, factorial, ln, log2, log10, sqrt</td>
@@ -306,6 +326,7 @@ class Calculator extends Component {
<FormattedMessage
id="calculator.instruction.table.to.use.trig.functions"
defaultMessage="Trigonometric functions"
description="Type of mathematical function that is supported by the calculator"
/>
</th>
<td dir="auto">
@@ -327,12 +348,14 @@ class Calculator extends Component {
<FormattedMessage
id="calculator.instruction.table.to.use.scientific.notation"
defaultMessage="Scientific notation"
description="It indicate that calculator supports scientific notation"
/>
</th>
<td dir="auto">
<FormattedMessage
id="calculator.instruction.table.to.use.scientific.notation.type1"
defaultMessage="{exponentSyntax} and the exponent"
description="Type of scientific notation that is supported by the calculator"
values={{
exponentSyntax: '10^',
}}
@@ -345,6 +368,7 @@ class Calculator extends Component {
<FormattedMessage
id="calculator.instruction.table.to.use.scientific.notation.type2"
defaultMessage="{notationSyntax} notation"
description="It indicate that calculator supports (e) to be used in notation"
values={{
notationSyntax: 'e',
}}
@@ -354,6 +378,7 @@ class Calculator extends Component {
<FormattedMessage
id="calculator.instruction.table.to.use.scientific.notation.type3"
defaultMessage="{notationSyntax} and the exponent"
description="An example for using (e) in notation"
values={{
notationSyntax: '1e',
}}

1
src/courseware/course/course-exit/CatalogSuggestion.jsx
View File

@@ -40,6 +40,7 @@ function CatalogSuggestion({ intl, variant }) {
id="courseExit.catalogSearchSuggestion"
defaultMessage="Looking to learn more? {searchOurCatalogLink} to find more courses and programs to explore."
values={{ searchOurCatalogLink }}
description="Suggesting to learner to explore other course. Shown when they finish the course"
/>
</div>
</div>

5
src/courseware/course/course-exit/CourseCelebration.jsx
View File

@@ -93,6 +93,7 @@ function CourseCelebration({ intl }) {
You can download your certificate now and access it any time from your
{dashboardLink} and {profileLink}."
values={{ dashboardLink, profileLink }}
description="Recommending an action for learner when course certificate is available"
/>
</p>
);
@@ -132,6 +133,7 @@ function CourseCelebration({ intl }) {
defaultMessage="This course ended on {endDate} and final grades and certificates are scheduled to be
available after {certAvailableDate}."
values={{ endDate, certAvailableDate }}
description="This shown for leaner when they are eligible for certifcate but it't not available yet, it could because leaners just finished the course quickly!"
/>
</p>
<p>
@@ -181,6 +183,7 @@ function CourseCelebration({ intl }) {
defaultMessage="In order to generate a certificate, you must complete ID verification.
{idVerificationSupportLink} now."
values={{ idVerificationSupportLink }}
description="Its shown when learner are not verified thus it recommends going over the verification process"
/>
</p>
);
@@ -199,6 +202,7 @@ function CourseCelebration({ intl }) {
valuable credential to improve your job prospects and advance your career, or highlight your
certificate in school applications."
values={{ price: <FormattedPricing inline offer={offer} verifiedMode={verifiedMode} /> }}
description="Body text when the learner needs to upgrade to earn a certifcate and they have passed the course"
/>
<br />
{getConfig().SUPPORT_URL_VERIFIED_CERTIFICATE && (
@@ -226,6 +230,7 @@ function CourseCelebration({ intl }) {
code: (<b>{offer.code}</b>),
percent: offer.percentage,
}}
description="Shown if learner can use a discount code when they upgrade the course"
/>
</span>
);

1
src/courseware/course/course-exit/DashboardFootnote.jsx
View File

@@ -39,6 +39,7 @@ function DashboardFootnote({ intl, variant }) {
<FormattedMessage
id="courseCelebration.dashboardInfo" // for historical reasons
defaultMessage="You can access this course and its materials on your {dashboardLink}."
description="Text that precedes link to learner's dashboard"
values={{ dashboardLink }}
/>
)}

1
src/courseware/course/course-exit/ProgramCompletion.jsx
View File

@@ -50,6 +50,7 @@ function ProgramCompletion({
id="courseExit.programCompletion.dashboardMessage"
defaultMessage="To view your certificate status, check the Programs section of your {programLink}."
values={{ programLink }}
description="Text that precedes link to program page"
/>
</p>
{type === 'microbachelors' && (

1
src/courseware/course/course-exit/UpgradeFootnote.jsx
View File

@@ -50,6 +50,7 @@ function UpgradeFootnote({ deadline, href, intl }) {
expirationDate,
upgradeLink,
}}
description="Message body to tell learner until when the materiel will be available, and to suggest to upgrade"
/>
)}
/>

13
src/courseware/course/course-exit/messages.js
View File

@@ -34,6 +34,7 @@ const messages = defineMessages({
certificateHeaderUpgradable: {
id: 'courseCelebration.certificateHeader.upgradable',
defaultMessage: 'Upgrade to pursue a verified certificate',
description: 'Header when learner finished or pass the course but need to upgrade to get a certificate',
},
certificateImage: {
id: 'courseCelebration.certificateImage',
@@ -43,10 +44,12 @@ const messages = defineMessages({
completedCourseHeader: {
id: 'courseCelebration.completedCourseHeader',
defaultMessage: 'You have completed your course.',
description: 'Header text for course exit section',
},
congratulationsHeader: {
id: 'courseCelebration.congratulationsHeader',
defaultMessage: 'Congratulations!',
description: 'Greeting learner for finishing the course',
},
congratulationsImage: {
id: 'courseCelebration.congratulationsImage',
@@ -56,10 +59,12 @@ const messages = defineMessages({
courseInProgressDescription: {
id: 'courseExit.courseInProgressDescription',
defaultMessage: 'It looks like there is more content in this course that will be released in the future. Look out for email updates or check back on your course for when this content will be available.',
description: 'Shown to learner when they finish all available assignments, but not the whole course',
},
courseInProgressHeader: {
id: 'courseExit.courseInProgressHeader',
defaultMessage: 'More content is coming soon!',
description: 'Header when the status of the course not all of (contents or assignments) available yet',
},
dashboardLink: {
id: 'courseExit.dashboardLink',
@@ -74,6 +79,7 @@ const messages = defineMessages({
endOfCourseDescription: {
id: 'courseExit.endOfCourseDescription',
defaultMessage: 'Unfortunately, you are not currently eligible for a certificate. You need to receive a passing grade to be eligible for a certificate.',
description: 'Shown to learner when they did not pass the course',
},
endOfCourseHeader: {
id: 'courseExit.endOfCourseHeader',
@@ -108,10 +114,12 @@ const messages = defineMessages({
nextButtonComplete: {
id: 'learn.sequence.navigation.complete.button', // for historical reasons
defaultMessage: 'Complete the course',
description: 'This text is shown on the button which usually links to the next unit or assignment in course sequence, however when it is the last unit. The button will link to course exit page',
},
nextButtonEnd: {
id: 'courseExit.nextButton.endOfCourse',
defaultMessage: 'Next (end of course)',
description: 'This shown for the button which links to the next unit, when learner did not pass the course',
},
profileLink: {
id: 'courseExit.profileLink',
@@ -121,10 +129,12 @@ const messages = defineMessages({
programsLastCourseHeader: {
id: 'courseExit.programs.lastCourse',
defaultMessage: 'You have completed the last course in {title}!',
description: 'This shown to learner when the course they completed is the last one of a program, the program might be mircomaster, or microbachelors...etc',
},
requestCertificateBodyText: {
id: 'courseCelebration.requestCertificateBodyText',
defaultMessage: 'In order to access your certificate, request it below.',
description: 'Shown when learner need to request the certifcate',
},
requestCertificateButton: {
id: 'courseCelebration.requestCertificateButton',
@@ -139,6 +149,7 @@ const messages = defineMessages({
shareMessage: {
id: 'courseCelebration.shareMessage',
defaultMessage: 'Share your success on social media or email.',
description: 'Recommending an action when learner pass the course',
},
socialMessage: {
id: 'courseExit.social.shareCompletionMessage',
@@ -156,10 +167,12 @@ const messages = defineMessages({
verificationPending: {
id: 'courseCelebration.verificationPending',
defaultMessage: 'Your ID verification is pending and your certificate will be available once approved.',
description: 'Shown when the status of verification is pending',
},
verifiedCertificateSupportLink: {
id: 'courseExit.verifiedCertificateSupportLink',
defaultMessage: 'Learn more about verified certificates',
description: 'Anchor text for link that redirect to external help page about verified certificates',
},
verifyIdentityButton: {
id: 'courseCelebration.verifyIdentityButton',

3
src/courseware/course/sequence/hidden-after-due/messages.js
View File

@@ -4,14 +4,17 @@ const messages = defineMessages({
header: {
id: 'learn.hiddenAfterDue.header',
defaultMessage: 'The due date for this assignment has passed.',
description: 'Shown when content of a course is longer available because due date passed',
},
description: {
id: 'learn.hiddenAfterDue.description',
defaultMessage: 'Because the due date has passed, this assignment is no longer available.',
description: 'It explain why the content is not available',
},
gradeAvailable: {
id: 'learn.hiddenAfterDue.gradeAvailable',
defaultMessage: 'If you have completed this assignment, your grade is available on the {progressPage}.',
description: 'Text that precedes link that redirect to progress page',
},
progressPage: {
id: 'learn.hiddenAfterDue.progressPage',

1
src/courseware/course/sequence/honor-code/HonorCode.jsx
View File

@@ -48,6 +48,7 @@ function HonorCode({ intl, courseId }) {
siteName,
link: <a href={honorCodeUrl}>{intl.formatMessage(messages['learn.honorCode.name'])}</a>,
}}
description="This is shown to learner, when course author wants to learners to explicity agree on their (Term of use or conduct), hence it links honor code page. "
/>
</p>

1
src/courseware/social-share/messages.js
View File

@@ -9,6 +9,7 @@ const messages = defineMessages({
shareEmail: {
id: 'learning.social.shareEmail',
defaultMessage: 'Share your progress via email.',
description: 'Text email share button',
},
shareService: {
id: 'learning.social.shareService',