Annotation of loncom/html/adm/help/ext_examples.library, revision 1.3

1.1       www         1: <library>
1.3     ! raeburn     2: <startouttext />
1.1       www         3: Some things to do with &amp;EXT()<br />
                      4: <table border="1">
1.3     ! raeburn     5: <tr><th>Incantation</th><th>Result</th><th>Explanation</th></tr>
1.1       www         6: <tr><td>request.filename</td><td>&EXT('request.filename')</td>
                      7:     <td>full internal path of the current resource</td></tr>
                      8: <tr><td>request.uri</td><td>&EXT('request.uri')</td>
1.3     ! raeburn     9:     <td>URI of the currently viewed resource</td></tr>
1.1       www        10: <tr><td>request.state</td><td>&EXT('request.state')</td>
1.3     ! raeburn    11:     <td>state of the resource, either: construct or published</td></tr>
1.1       www        12: <tr><td>user.name</td><td>&EXT('user.name')</td>
                     13:     <td>username of user</td></tr>
                     14: <tr><td>user.domain</td><td>&EXT('user.domain')</td>
                     15:     <td>Domain the user is in</td></tr>
                     16: <tr><td>user.course.sec</td><td>&EXT('user.course.sec')</td>
                     17:     <td>Users's Course Section</td></tr>
                     18: <tr><td>environment.firstname</td><td>&EXT('environment.firstname')</td>
1.3     ! raeburn    19:     <td>User's first name</td></tr>
1.1       www        20: <tr><td>environment.middlename</td><td>&EXT('environment.middlename')</td>
                     21:     <td>User's middle name</td></tr>
                     22: <tr><td>environment.lastname</td><td>&EXT('environment.lastname')</td>
1.3     ! raeburn    23:     <td>User's last name</td></tr>
1.1       www        24: <tr><td>environment.generation</td><td>&EXT('environment.generation')</td>
                     25:     <td>Jr., Sr., III, etc.</td></tr>
                     26: <tr><td>environment.screenname</td><td>&EXT('environment.screenname')</td>
1.3     ! raeburn    27:     <td>User's screen name (name that appears in discussion postings)</td></tr>
1.1       www        28: <tr><td>environment.nickname</td><td>&EXT('environment.nickname')</td>
1.3     ! raeburn    29:     <td>User's nickname. (Name the user prefers to be called in person)</td></tr>
1.1       www        30: <tr><td>environment.id</td><td>&EXT('environment.id')</td>
1.3     ! raeburn    31:     <td>User's student/employee ID number</td></tr>
1.1       www        32: <tr><td>request.browser.version</td><td>&EXT('request.browser.version')</td>
1.3     ! raeburn    33:     <td>Version of the user's browser</td></tr>
1.1       www        34: <tr><td>request.browser.type</td><td>&EXT('request.browser.type')</td>
                     35:     <td>What type of browser is the user using</td></tr>
                     36: <tr><td>course.description</td><td>&EXT('course.decription')</td>
1.3     ! raeburn    37:     <td>Descriptive name for a course</td></tr>
1.1       www        38: <tr><td>course.num</td><td>&EXT('course.num')</td>
                     39:     <td>Internal Course Identifier</td></tr>
                     40: <tr><td>course.url</td><td>&EXT('course.url')</td>
                     41:     <td>Current course toplevel map.</td></tr>
                     42: <tr><td>query.*</td><td></td>
1.3     ! raeburn    43:     <td>query.* allows access to ny passed-in form parameters</td></tr>
1.1       www        44: <tr><td>query.grade_target</td><td>&EXT('query.grade_target')</td>
                     45:     <td>Ignore this. It isn't generally useful.</td></tr>
                     46: </table>
                     47: Other things:
                     48: <table border="1">
1.3     ! raeburn    49: <tr><th>Incantation</th><th>Result</th><th>Explanation</th></tr>
1.1       www        50: <tr><td>&#36;external::target</td>
                     51:     <td><display>$external::target</display></td>
                     52:     <td>Whether we are printing (tex) or viewing on screen (web)</td></tr>
                     53: <tr><td>&#36;external::part</td>
                     54:     <td><display>$external::part</display></td>
                     55:     <td>current Part id </td></tr>
                     56: <tr><td>&#36;external::gradestatus</td>
                     57:     <td><display>$external::gradestatus</display></td>
                     58:     <td>The solved status of the current part.</td></tr>
                     59: <tr><td>&#36;external::datestatus</td>
                     60:     <td><tex>\verb+</tex><display>$external::datestatus</display><tex>+</tex></td>
1.2       albertel   61:     <td>The current status of the problem 
                     62: 	<table>
                     63: 	<tr><td>CLOSED</td>
1.3     ! raeburn    64: 	    <td>either before opendate or between duedate and answerdate</td></tr>
1.2       albertel   65: 	<tr><td>CAN_ANSWER</td></tr>
                     66: 	<tr><td>CANNOT_ANSWER</td>
1.3     ! raeburn    67: 	    <td>still open but either exhausted tries, has the problem correct, or has been excused</td></tr>
1.2       albertel   68: 	<tr><td>SHOW_ANSWER </td>
                     69: 	    <td>after answerdate</td></tr>
                     70: 	</table>
                     71: 	and some rare states that if they occur the problem isn't shown (you can safely ignore these):
                     72: 	<table>
                     73: 	<tr><td>NOT_YET_VIEWED</td>
1.3     ! raeburn    74: 	    <td>limited view period being used and student hasn't "checked out" the problem yet</td></tr>
1.2       albertel   75: 	<tr><td>INVALID_ACCESS</td>
1.3     ! raeburn    76: 	    <td>IP restrictions in effect, and user's IP address is not allowed access</td></tr>
1.2       albertel   77: 	<tr><td>UNAVAILABLE</td>
1.3     ! raeburn    78: 	    <td>network problems are occurring</td></tr>
1.2       albertel   79: 	</table>
                     80: 
1.1       www        81: <tr><td>&#36;external::randomseed</td>
                     82:     <td><display>$external::randomseed</display></td>
                     83:     <td>The randomseed currently in use.</td></tr>
                     84: <tr><td></td><td></td>
                     85:     <td></td></tr>
                     86: </table>
                     87: <endouttext />
                     88: </library>

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