Changes between Version 33 and Version 34 of PageTemplates/Workplan/Action
- Timestamp:
- 2017-05-17T19:43:19+02:00 (7 years ago)
Legend:
- Unmodified
- Added
- Removed
- Modified
-
PageTemplates/Workplan/Action
v33 v34 1 1 = '''''{{action, Title, text, "{WG or INSTITUTE}-{NUM}_{PIS}" Subject}}''''' 2 2 3 The PI is responsible to closely follow the progress of the action, and especially to contact NEMO project manager if the delay on preview (or review) are longer than the 2 weeks expected. [[BR]]3 The PI is responsible to closely follow the progress of the action, and especially to contact NEMO project manager if the delay on preview (or review) are longer than the 2 weeks expected. 4 4 5 5 == Help 6 6 7 7 The action has to be detailed briefly in the 'Summary' sub-page (ordinary wiki page) for later inclusion in other pages. Out of this, the rest of the page can be edited on-line inside the form fields considering the following color code given hereafter. 8 {{{#!html 9 <b>Record your modifications for the section you have edited by clicking on the corresponding button at the end of the section with <input type="submit" value="Save ... "/> button. Just above, the timestamp of the record will be updated. 10 </b> 11 }}} 8 12 9 {{{#!div class="important" 10 Record your modifications for the section you have edited by clicking on the corresponding button at the end of the section with 'Save ...' button. Just above, the log record will be updated. 11 13 12 The informations inside the form fields and this wiki page itself are stored in 2 separate databases. As a consequence, there is absolutely no risk to make any modification in the page itself as long as you don't rename the page or modify the source code of `{{{#!TracForm ... }}}` processors. 13 14 Edit the 'Summary' section as with an ordinary wiki page. 15 * ''Italic formatting'' shows the default values or help. 16 * `Pre-formatted formatting` shows syntax for specific TracLinks (development ticket and branch). 14 17 }}} 15 18 … … 26 29 }}} 27 30 {{{#!td style="background:lightgrey" 28 {{{#!td width="100px" style="background:lightgrey; border:none" 29 1. [#summary Summary] 30 }}} 31 {{{#!td width="100px" style="border:none" 32 2. [#abstract Abstract] 33 }}} 34 {{{#!td width="100px" style="border:none" 35 4. [#tests Tests] 36 }}} 31 1.[#summary Summary]\\ 32 2.[#abstract Abstract]\\ 33 4.[#tests Tests] 37 34 }}} 38 35 |- … … 41 38 }}} 42 39 {{{#!td style="background:lightblue" 43 3. 40 3.[#preview Preview] 44 41 }}} 45 42 |- … … 48 45 }}} 49 46 {{{#!td style="background:lightgreen" 50 5. 47 5.[#review Review] 51 48 }}} 52 49 }}} 53 50 54 == Summary [=#summary] 55 56 {{{#!div class="important" 57 Edit this 'Summary' section like an common wiki page. 58 * ''Italic formatting'' shows the default values or help. 59 * `Preformatted formatting` shows syntax for specific TracLinks (development ticket and branch). 60 }}} 51 == Summary #summary 61 52 62 53 || '''Action''' || {{action, Title, text, "{WG or INSTITUTE}-{NUM}_{PIS}" Subject}} || … … 77 68 || '''Status''' || ''!Pending/In progress/Postponed/Ready'' || 78 69 70 {{{#!comment 71 DON'T REMOVE THIS VOID HEADING OR IT WILL BREAK THE INCLUDE FEATURE BETWEEN WIKI PAGES 72 }}} 73 == == 74 {{{#!comment 75 DON'T REMOVE THIS VOID HEADING OR IT WILL BREAK THE INCLUDE FEATURE BETWEEN WIKI PAGES 76 }}} 77 79 78 {{{#!Fold title=Abstract tag=h2 80 79 [=#abstract] … … 82 81 This section should be completed before starting to develop the code, in order to find agreement on the method beforehand. 83 82 84 {{{ 85 #!TracForm 83 {{{#!TracForm 86 84 #!subcontext abstract 87 85 #!submit_label 'Save Abstract' 88 86 #!keep_history yes 89 === Description === 90 [tf.textarea:description -id=piform -class=taform 'Describe the goal of development, and the methodology.\n\nAdd reference documents or publications if relevant.' 0 20] 91 === Implementation === 92 [tf.textarea:implementation -id=piform -class=taform 'Describe flow chart of the changes in the code.\n\nList the .F90 files and modules to be changed.\n\nDetailed list of new variables (including namelists) to be defined.\nGive for each the chosen name (following coding rules) and definition.' 0 20] 93 === Reference manual and web pages updates === 94 [tf.textarea:manual -id=piform -class=taform 'Using part 1 and 2, define the summary of changes to be done in the NEMO reference manual (tex files), and in the content of web pages.' 0 20] 87 88 === Description 89 90 [tf.textarea:description -id=piform -class=taform 'Describe the goal of development, and the methodology.\n\nAdd reference documents or publications if relevant.' 0 20] 91 92 === Implementation 93 94 [tf.textarea:implementation -id=piform -class=taform 'Describe flow chart of the changes in the code.\n\nList the .F90 files and modules to be changed.\n\nDetailed list of new variables (including namelists) to be defined.\nGive for each the chosen name (following coding rules) and definition.' 0 20] 95 96 === Reference manual and web pages updates 97 98 [tf.textarea:manual -id=piform -class=taform 'Using part 1 and 2, define the summary of changes to be done in the NEMO reference manual (tex files), and in the content of web pages.' 0 20] 95 99 96 100 '''''Updated on [tf.form_updated_on:] by [tf.form_updater:]''''' 101 97 102 }}} 98 103 … … 106 111 Since the preview step must be completed before the PI starts the coding, the previewer(s) answers are expected to be completed within the two weeks after the PI has sent his request.[[BR]]For each question, an iterative process should take place between PI and previewer(s) in order to reach a "YES" answer for each of the following questions. 107 112 108 {{{ 109 #!TracForm 113 {{{#!TracForm 110 114 #!subcontext preview_ 111 115 #!submit_label 'Save Preview' 116 112 117 || Questions || Answer || Comment || 113 118 || Does the previewer agree with the proposed methodology? || [tf.select:2.1 -id=preform '' Yes No NR] || [tf.textarea:2.1c -id=preform 'Add a comment?' 50 10] || … … 118 123 119 124 '''''Updated on [tf.form_updated_on:] by [tf.form_updater:]''''' 125 120 126 }}} 121 127 … … 129 135 Once the development is done, the PI should complete this section below and ask the reviewers to start their review in the lower section. 130 136 131 {{{ 132 #!TracForm 137 {{{#!TracForm 133 138 #!subcontext tests 134 139 #!submit_label 'Save Tests' 140 135 141 || Questions || Answer || Comment || 136 142 || Can this change be shown to produce expected impact? (if option activated)? || [tf.select:3.1 -id=piform '' Yes No NR] || [tf.textarea:3.1c -id=piform 'Add a comment?' 50 10] || … … 147 153 148 154 '''''Updated on [tf.form_updated_on:] by [tf.form_updater:]''''' 155 149 156 }}} 150 157 … … 156 163 A successful review is needed to schedule the merge of this development into the future NEMO release during next Merge Party (usually in November). 157 164 158 {{{ 159 #!TracForm 165 {{{#!TracForm 160 166 #!subcontext review 161 167 #!submit_label 'Save Review' 162 === Code changes and documentation === 168 169 === Code changes and documentation 170 163 171 || Question || Answer || Comment || 164 172 || Is the proposed methodology now implemented? || [tf.select:3.11 -id=revform '' Yes No NR] || [tf.textarea:3.11c -id=revform 'Add a comment?' 50 10] || … … 171 179 || Is there a need for some documentation on the web pages (in addition to in-line and reference manual)?[[BR]]If yes, please describe and ask PI. A yes answer must include all documentation available. || [tf.select:3.18 -id=revform '' Yes No NR] || [tf.textarea:3.18c -id=revform 'Add a comment?' 50 10] || 172 180 || ... ... ... || [tf.select:3.XX -id=revform '' Yes No NR] || [tf.textarea:3.XXc -id=revform 'Add a comment?' 50 10] || 173 '''__Review Summary__'''[[BR]] 174 Is the review fully successful?[tf.select:status -id=revform '' Yes No][[BR]] 181 182 ==== Review Summary 183 184 Is the review fully successful? [tf.select:status -id=revform '' Yes No] 185 175 186 [tf.textarea:comment -id=revform 'If not, please indicate what is still missing.' 50 10] 176 187 177 188 '''''Updated on [tf.form_updated_on:] by [tf.form_updater:]''''' 189 178 190 }}} 179 191