doc/homework/newtag.html - view

File: [LON-CAPA] / doc / homework / newtag.html
Revision 1.1: download - view: text, annotated - select for diffs
Thu Jun 6 08:43:24 2002 UTC (21 years, 11 months ago) by albertel
Branches: MAIN
CVS tags: version_2_9_X, version_2_9_99_0, version_2_9_1, version_2_9_0, version_2_8_X, version_2_8_99_1, version_2_8_99_0, version_2_8_2, version_2_8_1, version_2_8_0, version_2_7_X, version_2_7_99_1, version_2_7_99_0, version_2_7_1, version_2_7_0, version_2_6_X, version_2_6_99_1, version_2_6_99_0, version_2_6_3, version_2_6_2, version_2_6_1, version_2_6_0, version_2_5_X, version_2_5_99_1, version_2_5_99_0, version_2_5_2, version_2_5_1, version_2_5_0, version_2_4_X, version_2_4_99_0, version_2_4_2, version_2_4_1, version_2_4_0, version_2_3_X, version_2_3_99_0, version_2_3_2, version_2_3_1, version_2_3_0, version_2_2_X, version_2_2_99_1, version_2_2_99_0, version_2_2_2, version_2_2_1, version_2_2_0, version_2_1_X, version_2_1_99_3, version_2_1_99_2, version_2_1_99_1, version_2_1_99_0, version_2_1_3, version_2_1_2, version_2_1_1, version_2_1_0, version_2_12_X, version_2_11_X, 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_RC2, version_2_11_0_RC1, version_2_11_0, version_2_10_X, version_2_10_1, version_2_10_0_RC2, version_2_10_0_RC1, version_2_10_0, version_2_0_X, version_2_0_99_1, version_2_0_2, version_2_0_1, version_2_0_0, version_1_99_3, version_1_99_2, version_1_99_1_tmcc, version_1_99_1, version_1_99_0_tmcc, version_1_99_0, version_1_3_X, version_1_3_3, version_1_3_2, version_1_3_1, version_1_3_0, version_1_2_X, version_1_2_99_1, version_1_2_99_0, version_1_2_1, version_1_2_0, version_1_1_X, version_1_1_99_5, version_1_1_99_4, version_1_1_99_3, version_1_1_99_2, version_1_1_99_1, version_1_1_99_0, version_1_1_3, version_1_1_2, version_1_1_1, version_1_1_0, version_1_0_99_3, version_1_0_99_2, version_1_0_99_1, version_1_0_99, version_1_0_3, version_1_0_2, version_1_0_1, version_1_0_0, version_0_99_5, version_0_99_4, version_0_99_3, version_0_99_2, version_0_99_1, version_0_99_0, version_0_6_2, version_0_6, version_0_5_1, version_0_5, version_0_4, stable_2002_july, loncapaMITrelate_1, language_hyphenation_merge, language_hyphenation, conference_2003, bz6209-base, bz6209, STABLE, HEAD, GCI_3, GCI_2, GCI_1, BZ4492-merge, BZ4492-feature_horizontal_radioresponse, BZ4492-feature_Support_horizontal_radioresponse, BZ4492-Support_horizontal_radioresponse

- most of a document outlining what needs to be done to add a basic tag

-still missing
       - useful helper function descriptions
       - edit mode
            - insertlist.tab
       - analyze mode

1: <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> 2: <html> 3: <head> 4: <title>Making a New Tag Handler</title> 5: </head> 6: 7: <body> 8: <h1>Making a New Tag Handler</h1> 9: 10: <h2>Required Actions</h2> 11: <ul> 12: <li> 13: you will need to call &Apache::lonxml::register() 14: to register the tag name and the namespace it is in, most of 15: the time this is in the BEGIN block of the handler 16: </li> 17: <li> 18: you will need to create both &start_newtag() and 19: &end_newtag() functions. 20: </li> 21: <li> 22: these function will need to do one of: 23: <ol> 24: <li> 25: return a non-null string 26: </li> 27: <li> 28: return a null string (and expect that for some targets a 29: default output may be generated for it) 30: </li> 31: <li> 32: return a list containing a null string for the first 33: element and the string 'no' for the second element., this 34: will make sure that the result is a null string and any 35: default action normally taken will be skipped 36: </li> 37: </ol> 38: <li> 39: These functions will have six arguments passed to them 40: <ol> 41: <li> 42: $target a scalar cotaing the string of the target 43: that is being parsed for. The current possibilities 44: include web, tex, grade, answer, modified, edit, meta, 45: analyze. Although more may be added in the future, you 46: must guarentee that you return a blank string for any 47: target you don't specifically handle. 48: </li> 49: <li> 50: $token a HTML::LCParser token object,You probably 51: want to avoid using the parameter information inside of 52: this, you most likely want to use $paramstack and 53: &Apache::lonxml::get_param() 54: </li> 55: <li> 56: $tagstack a stack pointer of the names of the tags 57: that are currently open, don't modify 58: </li> 59: <li> 60: $paramstack a stack pointer of the parameters 61: passed to the currently open tags, don't modify, and you 62: probably should use this only as a parameter to 63: &Apache::lonxml::get_param 64: </li> 65: <li> 66: $parser a stack pointer of the current stack of 67: HTML::LCParser objects. You probably only want to use the 68: top one. Also your functions may manipulate this object 69: and grab more tokens from it but be carefule about 70: unbalancing it, also avoid calling the ->get_text() 71: routine unless you really not what you are doing 72: (&Apache::lonxml::get_all_text() is probably 73: what you want to use. 74: </li> 75: <li> 76: $safeeval a pointer to the safe space interpreter, 77: You probably don't what to do anything with this directly, 78: &Apache::run::run and other functions need this 79: argument and will use it correctly. 80: </li> 81: <li> 82: $style a Hash reference, it contains mappings 83: between tags and style file definitions. Few functions 84: will need to use this. 85: </li> 86: </ol> 87: </li> 88: <li> 89: if it is a new response tag it needs to 90: <ul> 91: <li> 92: call &Apache::response::start_response() in the 93: start_newtag function and 94: &Apache::response::end_response() at the end of 95: the end_newtag function 96: </li> 97: <li> 98: set the required data for a responseid from the 99: datastorage document 100: </li> 101: <li> 102: use the functions 103: &Apache::response::check_for_previous() and 104: &Apache::response::handle_previous() to check 105: if a student's reponse has been submitted before. 106: </li> 107: <li> 108: call &Apache::response::setup_params() if it is 109: expecting external parameters to be set for it. 110: </li> 111: </ul> 112: </li> 113: </ul> 114: <h2>Things to not do</h2> 115: <ul> 116: <li> 117: there is no direct access to the Apache Request object. It is 118: very unlikely that you need it, any data you want is 119: either in %ENV, a global variable listed below or in the xml 120: documentation, or should be gotten through an Apache::lonnet 121: function 122: </li> 123: <li> 124: print, either return it in the result, or use the 125: debug/warning/error facility of Apache::lonxml 126: </li> 127: <li> 128: use the get_text() procedure of the $parser 129: HTML::LCParser object 130: </li> 131: <li> 132: access the paramater attributes of the $token HTML::LCParser 133: object 134: </li> 135: </ul> 136: <h2>Interesting Globals</h2> 137: <ul> 138: <li> lonhomework globals 139: <ul> 140: <li> 141: %Apache::lonhomework::history the data from a restore 142: call for the current symb 143: </li> 144: <li> 145: %Apache::lonhomework::results the hash that will be 146: cstored at the end of the current execution 147: </li> 148: <li> 149: $Apache::lonhomework::browse the result of an allowed 150: request for the bre priviledge on the current file 151: </li> 152: <li> 153: $Apache::lonhomework::viewgrades the result of an 154: allowed request on the vgr priviledge for the current course 155: </li> 156: <li> 157: $Apache::lonhomework::type the current type of the 158: resource, either '', exam, homework, quiz, form, or survey 159: </li> 160: <li> 161: %Apache::lonhomework::analyze in analyze mode all data 162: to be returned is sotred in here. 163: </li> 164: </ul> 165: </li> 166: <li> 167: inputtag globals 168: <ul> 169: <li> 170: @Apache::inputtags::input list of current input ids 171: </li> 172: <li> 173: @Apache::inputtags::inputlist list of all input ids 174: seen in this problem 175: </li> 176: <li> 177: @Apache::inputtags::response list of all current 178: response ids 179: </li> 180: <li> 181: @Apache::inputtags::responselist list of all 182: response ids seen in this problem 183: </li> 184: <li> 185: @Apache::inputtags::previous list of whether or not 186: a specific response was previously used 187: </li> 188: <li> 189: $Apache::inputtags::part id of current part, 0 190: means that no part is current (inside <problem> 191: only) 192: </li> 193: <li> 194: @Apache::inputtags::status list of problem date 195: statuses, the first element is for <problem> if 196: there is a second element it is for the current 197: <part> possible values are CLOSED, CAN_ANSWER, 198: SHOW_ANSWER, UNCHECKEDOUT 199: </li> 200: <li> 201: %Apache::inputtags::params hash of defined params 202: for the current response 203: </li> 204: <li> 205: @Apache::inputtags::import list of all ids, from 206: <import>s, these get join()ed and prepended to the 207: ids in the @Apache::inputtags::response and 208: @Apache::inputtags::responselist variables 209: </li> 210: </ul> 211: </li> 212: </ul> 213: <h2>Interesting Function</h2> 214: 215: 216: <hr> 217: <address><a href="mailto:albertel@msu.edu"></a></address> 218:  219:  220: Last modified: Thu Jun 6 04:46:00 EDT 2002 221:  222: </body> 223: </html>