Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

move the essay help text to a general helpLink #1124

Merged
merged 1 commit into from
Sep 17, 2024
Merged

move the essay help text to a general helpLink #1124

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 12 additions & 0 deletions htdocs/helpFiles/Entering-Essays.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
<h2 style="text-align: center">Entering Essays</h2>

<p>
In an essay answer text box, you can type a long answer. After after you hit submit, it will be saved so that your
instructor can read it and assign a score at a later time.
</p>
<p>If your instructor makes any comments on your answer, those comments will appear on the exercise page.</p>
<p>
You can use the MathQuill equation editor to make your math content look pretty. Once you have constructed a math
expression, click the Insert button. In the answer text box, your math content will look like code, but the Preview
button will show you what your isntructor will see.
</p>
7 changes: 5 additions & 2 deletions macros/core/PGbasicmacros.pl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2280,13 +2280,15 @@ =head2 Formatting macros
# form(from the webpage) inside another (the defining form for the problem
A wide variety of google widgets, youtube videos, and other online resources can be imbedded using this macro. In HTML mode it creates an iframe, in TeX mode it prints the url.

helpLink($type) allows site specific help. specified in global.conf or course.conf
helpLink($type)
Allows site specific help.
The parameter localHelpURL must be defined in the environment
and is set by default to webwork2/htdocs/helpFiles
and is set by default to pg/htdocs/helpFiles
Standard helpFile types
'angle'
'decimal'
'equation'
'essay'
'exponent'
'formula'
'fraction'
Expand Down Expand Up @@ -2549,6 +2551,7 @@ sub helpLink {
'angle' => [ 'Entering-Angles.html', 'help (angles)' ],
'decimal' => [ 'Entering-Decimals.html', 'help (decimals)' ],
'equation' => [ 'Entering-Equations.html', 'help (equations)' ],
'essay' => [ 'Entering-Essays.html', 'help (essays)' ],
'exponent' => [ 'Entering-Exponents.html', 'help (exponents)' ],
'formula' => [ 'Entering-Formulas.html', 'help (formulas)' ],
'fraction' => [ 'Entering-Fractions.html', 'help (fractions)' ],
Expand Down
19 changes: 1 addition & 18 deletions macros/core/PGessaymacros.pl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -150,23 +150,6 @@ sub NAMED_ESSAY_BOX {
);
}

sub essay_help {
return MODES(
TeX => '',
HTML => tag(
'p',
maketext(
'This is an essay answer text box. You can type your answer in here and, after you hit submit, '
. 'it will be saved so that your instructor can grade it at a later date. If your instructor '
. 'makes any comments on your answer those comments will appear on this page after the question '
. 'has been graded. You can use LaTeX to make your math equations look pretty. '
. 'LaTeX expressions should be enclosed using the parenthesis notation and not dollar signs.'
)
),
PTX => '',
);
}

sub essay_box {
my ($row, $col) = @_;
$row ||= 8;
Expand Down Expand Up @@ -195,7 +178,7 @@ sub explanation_box {
($options{message} // 'Explain.')
. $PAR
. essay_box($options{row} // $options{height} // 8, $options{col} // $options{width} // 75)
. (($options{help} // 1) ? essay_help() : '');
. (($options{help} // 1) ? $BR . helpLink('essay') : '');
}
}

Expand Down