Wiki source code of Macro Parameters Improvements (10.x)
Last modified by Vincent Massol on 2024/11/19 16:14
Show last authors
| author | version | line-number | content |
|---|---|---|---|
| 1 | {{toc start="2"/}} | ||
| 2 | |||
| 3 | (% class="row" %) | ||
| 4 | ((( | ||
| 5 | (% class="col-xs-12 col-sm-4" %) | ||
| 6 | ((( | ||
| 7 | == General == | ||
| 8 | |||
| 9 | {{usecase}} | ||
| 10 | Use [[auto-complete>>Proposal.AutocompleteOnReference]] for "List of strings" type parameter that expect Pages, Wikis, Users | ||
| 11 | {{/usecase}} | ||
| 12 | |||
| 13 | {{usecase}} | ||
| 14 | Use checkboxes for any "Boolean" type parameter | ||
| 15 | {{/usecase}} | ||
| 16 | |||
| 17 | {{usecase}} | ||
| 18 | Use select if there are multiple allowed values | ||
| 19 | {{/usecase}} | ||
| 20 | |||
| 21 | {{usecase}} | ||
| 22 | Provide the default value as placeholder for any "String or numerical value" type parameter | ||
| 23 | {{/usecase}} | ||
| 24 | |||
| 25 | {{usecase}} | ||
| 26 | Display the available macro parameters options in more usable controls, allowing faster usage | ||
| 27 | {{/usecase}} | ||
| 28 | |||
| 29 | {{usecase}} | ||
| 30 | Good Defaults: Provide demo content examples that work and can be experimented | ||
| 31 | {{/usecase}} | ||
| 32 | ))) | ||
| 33 | |||
| 34 | (% class="col-xs-12 col-sm-4" %) | ||
| 35 | ((( | ||
| 36 | |||
| 37 | ))) | ||
| 38 | |||
| 39 | (% class="col-xs-12 col-sm-4" %) | ||
| 40 | ((( | ||
| 41 | |||
| 42 | ))) | ||
| 43 | ))) | ||
| 44 | |||
| 45 | === Macros Count === | ||
| 46 | |||
| 47 | (% class="row" %) | ||
| 48 | ((( | ||
| 49 | (% class="col-xs-12 col-sm-4" %) | ||
| 50 | ((( | ||
| 51 | {{usecase}} | ||
| 52 | Know how many available macros there are | ||
| 53 | {{/usecase}} | ||
| 54 | |||
| 55 | * There are 51 macros available in 10 categories (##All## + ##Other## + 8) | ||
| 56 | ))) | ||
| 57 | |||
| 58 | (% class="col-xs-12 col-sm-4" %) | ||
| 59 | ((( | ||
| 60 | Before | ||
| 61 | [[image:attach:macros.png]] | ||
| 62 | ))) | ||
| 63 | |||
| 64 | (% class="col-xs-12 col-sm-4" %) | ||
| 65 | ((( | ||
| 66 | After | ||
| 67 | [[image:attach:macros_count_after.png]] | ||
| 68 | [[image:attach:macros_count_after_expanded.png]] | ||
| 69 | ))) | ||
| 70 | ))) | ||
| 71 | |||
| 72 | === Back to Gallery === | ||
| 73 | |||
| 74 | (% class="row" %) | ||
| 75 | ((( | ||
| 76 | (% class="col-xs-12 col-sm-4" %) | ||
| 77 | ((( | ||
| 78 | {{usecase}} | ||
| 79 | Have a button that takes the user back to the gallery | ||
| 80 | {{/usecase}} | ||
| 81 | |||
| 82 | * The button exists, but because of position / naming, users don't use it and they redo the steps from the start | ||
| 83 | ))) | ||
| 84 | |||
| 85 | (% class="col-xs-12 col-sm-4" %) | ||
| 86 | ((( | ||
| 87 | Before | ||
| 88 | [[image:attach:macros_back.png]] | ||
| 89 | ))) | ||
| 90 | |||
| 91 | (% class="col-xs-12 col-sm-4" %) | ||
| 92 | ((( | ||
| 93 | After | ||
| 94 | [[image:attach:macros_back_after.png]] | ||
| 95 | ))) | ||
| 96 | ))) | ||
| 97 | |||
| 98 | === Macros Documentation === | ||
| 99 | |||
| 100 | (% class="row" %) | ||
| 101 | ((( | ||
| 102 | (% class="col-xs-12 col-sm-4" %) | ||
| 103 | ((( | ||
| 104 | {{usecase}} | ||
| 105 | Know how many available macros there are | ||
| 106 | {{/usecase}} | ||
| 107 | |||
| 108 | {{jira url="https://jira.xwiki.org" style="list"}} | ||
| 109 | XWIKI-4448 | ||
| 110 | {{/jira}} | ||
| 111 | ))) | ||
| 112 | |||
| 113 | (% class="col-xs-12 col-sm-4" %) | ||
| 114 | ((( | ||
| 115 | Before | ||
| 116 | [[image:attach:macros_doc.png]] | ||
| 117 | ))) | ||
| 118 | |||
| 119 | (% class="col-xs-12 col-sm-4" %) | ||
| 120 | ((( | ||
| 121 | After | ||
| 122 | [[image:attach:macros_doc_after.png]] | ||
| 123 | ))) | ||
| 124 | ))) | ||
| 125 | |||
| 126 | === Deprecated Macros === | ||
| 127 | |||
| 128 | {{usecase}} | ||
| 129 | Remove these macros | ||
| 130 | {{/usecase}} | ||
| 131 | |||
| 132 | * Space Index Macro | ||
| 133 | * Spaces Macro | ||
| 134 | * Workspaces Legacy | ||
| 135 | |||
| 136 | === Move Macros === | ||
| 137 | |||
| 138 | * Move from ##Content## to ##Development## category | ||
| 139 | ** Display, Include Macros | ||
| 140 | ** Translation Macro | ||
| 141 | |||
| 142 | * Move from ##Content## to ##Notifications## category | ||
| 143 | ** Activity Macro | ||
| 144 | ** Watch List Macro | ||
| 145 | ** RSS Macro ? | ||
| 146 | |||
| 147 | * Move from ##Social## to ##Notifications## category | ||
| 148 | ** Message Sender - being the only one listed | ||
| 149 | |||
| 150 | == Macros == | ||
| 151 | |||
| 152 | (% class="row" %) | ||
| 153 | ((( | ||
| 154 | (% class="col-xs-12 col-sm-4" %) | ||
| 155 | ((( | ||
| 156 | === Macro: Activity === | ||
| 157 | |||
| 158 | * [[URL>>doc:extensions:Extension.Activity Macro]] | ||
| 159 | * Placeholders | ||
| 160 | * Wiki/Page/Authors/(Tags) references autocomplete | ||
| 161 | ))) | ||
| 162 | |||
| 163 | (% class="col-xs-12 col-sm-4" %) | ||
| 164 | ((( | ||
| 165 | [[image:attach:activity_before.png]] | ||
| 166 | ))) | ||
| 167 | |||
| 168 | (% class="col-xs-12 col-sm-4" %) | ||
| 169 | ((( | ||
| 170 | [[image:attach:activity_after.png]] | ||
| 171 | ))) | ||
| 172 | ))) | ||
| 173 | |||
| 174 | (% class="row" %) | ||
| 175 | ((( | ||
| 176 | (% class="col-xs-12 col-sm-4" %) | ||
| 177 | ((( | ||
| 178 | === Macro: Chart === | ||
| 179 | |||
| 180 | * [[URL>>doc:extensions:Extension.Chart Macro]] | ||
| 181 | * Good Defaults that have a demo example that can be tested | ||
| 182 | * Placeholders | ||
| 183 | * Select control instead of input for ##type## and ##source## params | ||
| 184 | ))) | ||
| 185 | |||
| 186 | (% class="col-xs-12 col-sm-4" %) | ||
| 187 | ((( | ||
| 188 | [[image:attach:chart_before.png]] | ||
| 189 | ))) | ||
| 190 | |||
| 191 | (% class="col-xs-12 col-sm-4" %) | ||
| 192 | ((( | ||
| 193 | {{gallery}} | ||
| 194 | image:chart_after.png | ||
| 195 | image:chart_types.png | ||
| 196 | image:chart_after_2.png | ||
| 197 | {{/gallery}} | ||
| 198 | |||
| 199 | {{code}} | ||
| 200 | <select> | ||
| 201 | <option disabled="" selected="">Select an option</option> | ||
| 202 | <option>area </option> | ||
| 203 | <option>bar </option> | ||
| 204 | <option>bar3D </option> | ||
| 205 | <option>line </option> | ||
| 206 | <option>line3D </option> | ||
| 207 | <option>pie </option> | ||
| 208 | <option>stackedbar </option> | ||
| 209 | <option>stackedbar3D </option> | ||
| 210 | <option>xy_area </option> | ||
| 211 | <option>xy_line_and_shape </option> | ||
| 212 | <option>xy_line3D </option> | ||
| 213 | <option>xy_step </option> | ||
| 214 | </select> | ||
| 215 | {{/code}} | ||
| 216 | |||
| 217 | {{code}} | ||
| 218 | {{chart type="pie" params="range:B2-D5" source="inline"}} | ||
| 219 | |=|=X|=Y|=Z | ||
| 220 | |Q1|1.2|3.4|1.3 | ||
| 221 | |Q2|4.5|3.4|2.3 | ||
| 222 | |Q3|1.2|4.5|9.0 | ||
| 223 | |Q4|3.4|1.2|1.2 | ||
| 224 | {{/chart}} | ||
| 225 | |||
| 226 | {{/code}} | ||
| 227 | ))) | ||
| 228 | ))) | ||
| 229 | |||
| 230 | (% class="row" %) | ||
| 231 | ((( | ||
| 232 | (% class="col-xs-12 col-sm-4" %) | ||
| 233 | ((( | ||
| 234 | === Macro: Content === | ||
| 235 | |||
| 236 | * [[URL>>doc:extensions:Extension.Content Macro]] | ||
| 237 | * Good Default | ||
| 238 | * Select control for ##syntax## param | ||
| 239 | ))) | ||
| 240 | |||
| 241 | (% class="col-xs-12 col-sm-4" %) | ||
| 242 | ((( | ||
| 243 | [[image:attach:content_before.png]] | ||
| 244 | ))) | ||
| 245 | |||
| 246 | (% class="col-xs-12 col-sm-4" %) | ||
| 247 | ((( | ||
| 248 | [[image:attach:content_after.png]] | ||
| 249 | ))) | ||
| 250 | ))) | ||
| 251 | |||
| 252 | (% class="row" %) | ||
| 253 | ((( | ||
| 254 | (% class="col-xs-12 col-sm-4" %) | ||
| 255 | ((( | ||
| 256 | === Macro: Display, Include === | ||
| 257 | |||
| 258 | * [[URL Display>>doc:extensions:Extension.Display Macro]] | ||
| 259 | * [[URL Include>>doc:extensions:Extension.Include Macro]] | ||
| 260 | * Auto-complete | ||
| 261 | ))) | ||
| 262 | |||
| 263 | (% class="col-xs-12 col-sm-4" %) | ||
| 264 | ((( | ||
| 265 | [[image:attach:display_before.png]] | ||
| 266 | ))) | ||
| 267 | |||
| 268 | (% class="col-xs-12 col-sm-4" %) | ||
| 269 | ((( | ||
| 270 | [[image:attach:display_after.png]] | ||
| 271 | ))) | ||
| 272 | ))) | ||
| 273 | |||
| 274 | |||
| 275 | (% class="row" %) | ||
| 276 | ((( | ||
| 277 | (% class="col-xs-12 col-sm-4" %) | ||
| 278 | ((( | ||
| 279 | === Macro: Office Document Viewer === | ||
| 280 | |||
| 281 | * [[URL>>doc:extensions:Extension.Office Macro]] | ||
| 282 | * Auto-complete | ||
| 283 | ))) | ||
| 284 | |||
| 285 | (% class="col-xs-12 col-sm-4" %) | ||
| 286 | ((( | ||
| 287 | [[image:attach:office_before.png]] | ||
| 288 | ))) | ||
| 289 | |||
| 290 | (% class="col-xs-12 col-sm-4" %) | ||
| 291 | ((( | ||
| 292 | [[image:attach:office_after.png]] | ||
| 293 | ))) | ||
| 294 | ))) | ||
| 295 | |||
| 296 | === etc. === | ||
| 297 | |||
| 298 | ---- | ||
| 299 | |||
| 300 | (% class="row" %) | ||
| 301 | ((( | ||
| 302 | (% class="col-xs-12 col-sm-4" %) | ||
| 303 | ((( | ||
| 304 | |||
| 305 | ))) | ||
| 306 | |||
| 307 | (% class="col-xs-12 col-sm-4" %) | ||
| 308 | ((( | ||
| 309 | |||
| 310 | ))) | ||
| 311 | |||
| 312 | (% class="col-xs-12 col-sm-4" %) | ||
| 313 | ((( | ||
| 314 | |||
| 315 | ))) | ||
| 316 | ))) |