File:  [LON-CAPA] / loncom / html / adm / help / ext_examples.library
Revision 1.3: download - view: text, annotated - select for diffs
Wed Feb 26 15:41:38 2014 UTC (10 years, 10 months ago) by raeburn
Branches: MAIN
CVS tags: version_2_12_X, version_2_11_X, version_2_11_5_msu, version_2_11_5, version_2_11_4_uiuc, version_2_11_4_msu, version_2_11_4, version_2_11_3_uiuc, version_2_11_3_msu, version_2_11_3, version_2_11_2_uiuc, version_2_11_2_msu, version_2_11_2_educog, version_2_11_2, version_2_11_1, version_2_11_0_RC3, version_2_11_0, HEAD
- Fix spelling, improve wording, ensure consistent case usage and punctuation.
- Fix typo in tag name, and add missing tags.

<library>
<startouttext />
Some things to do with &amp;EXT()<br />
<table border="1">
<tr><th>Incantation</th><th>Result</th><th>Explanation</th></tr>
<tr><td>request.filename</td><td>&EXT('request.filename')</td>
    <td>full internal path of the current resource</td></tr>
<tr><td>request.uri</td><td>&EXT('request.uri')</td>
    <td>URI of the currently viewed resource</td></tr>
<tr><td>request.state</td><td>&EXT('request.state')</td>
    <td>state of the resource, either: construct or published</td></tr>
<tr><td>user.name</td><td>&EXT('user.name')</td>
    <td>username of user</td></tr>
<tr><td>user.domain</td><td>&EXT('user.domain')</td>
    <td>Domain the user is in</td></tr>
<tr><td>user.course.sec</td><td>&EXT('user.course.sec')</td>
    <td>Users's Course Section</td></tr>
<tr><td>environment.firstname</td><td>&EXT('environment.firstname')</td>
    <td>User's first name</td></tr>
<tr><td>environment.middlename</td><td>&EXT('environment.middlename')</td>
    <td>User's middle name</td></tr>
<tr><td>environment.lastname</td><td>&EXT('environment.lastname')</td>
    <td>User's last name</td></tr>
<tr><td>environment.generation</td><td>&EXT('environment.generation')</td>
    <td>Jr., Sr., III, etc.</td></tr>
<tr><td>environment.screenname</td><td>&EXT('environment.screenname')</td>
    <td>User's screen name (name that appears in discussion postings)</td></tr>
<tr><td>environment.nickname</td><td>&EXT('environment.nickname')</td>
    <td>User's nickname. (Name the user prefers to be called in person)</td></tr>
<tr><td>environment.id</td><td>&EXT('environment.id')</td>
    <td>User's student/employee ID number</td></tr>
<tr><td>request.browser.version</td><td>&EXT('request.browser.version')</td>
    <td>Version of the user's browser</td></tr>
<tr><td>request.browser.type</td><td>&EXT('request.browser.type')</td>
    <td>What type of browser is the user using</td></tr>
<tr><td>course.description</td><td>&EXT('course.decription')</td>
    <td>Descriptive name for a course</td></tr>
<tr><td>course.num</td><td>&EXT('course.num')</td>
    <td>Internal Course Identifier</td></tr>
<tr><td>course.url</td><td>&EXT('course.url')</td>
    <td>Current course toplevel map.</td></tr>
<tr><td>query.*</td><td></td>
    <td>query.* allows access to ny passed-in form parameters</td></tr>
<tr><td>query.grade_target</td><td>&EXT('query.grade_target')</td>
    <td>Ignore this. It isn't generally useful.</td></tr>
</table>
Other things:
<table border="1">
<tr><th>Incantation</th><th>Result</th><th>Explanation</th></tr>
<tr><td>&#36;external::target</td>
    <td><display>$external::target</display></td>
    <td>Whether we are printing (tex) or viewing on screen (web)</td></tr>
<tr><td>&#36;external::part</td>
    <td><display>$external::part</display></td>
    <td>current Part id </td></tr>
<tr><td>&#36;external::gradestatus</td>
    <td><display>$external::gradestatus</display></td>
    <td>The solved status of the current part.</td></tr>
<tr><td>&#36;external::datestatus</td>
    <td><tex>\verb+</tex><display>$external::datestatus</display><tex>+</tex></td>
    <td>The current status of the problem 
	<table>
	<tr><td>CLOSED</td>
	    <td>either before opendate or between duedate and answerdate</td></tr>
	<tr><td>CAN_ANSWER</td></tr>
	<tr><td>CANNOT_ANSWER</td>
	    <td>still open but either exhausted tries, has the problem correct, or has been excused</td></tr>
	<tr><td>SHOW_ANSWER </td>
	    <td>after answerdate</td></tr>
	</table>
	and some rare states that if they occur the problem isn't shown (you can safely ignore these):
	<table>
	<tr><td>NOT_YET_VIEWED</td>
	    <td>limited view period being used and student hasn't "checked out" the problem yet</td></tr>
	<tr><td>INVALID_ACCESS</td>
	    <td>IP restrictions in effect, and user's IP address is not allowed access</td></tr>
	<tr><td>UNAVAILABLE</td>
	    <td>network problems are occurring</td></tr>
	</table>

<tr><td>&#36;external::randomseed</td>
    <td><display>$external::randomseed</display></td>
    <td>The randomseed currently in use.</td></tr>
<tr><td></td><td></td>
    <td></td></tr>
</table>
<endouttext />
</library>

FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>