Commits

Darrell Schiebel authored 294a67ba329
fid readme formatting

casatools/readme.md

Modified
256 256
257 257 4. __Bool__ --- (**automatic**) The majority of standard CASA XML files indicate boolean type parameters with *bool*. However, a small number of them use *boolean*. With CASAtools, only *bool* is accepted.
258 258
259 259 5. __StringArray__ --- (**automatic**) The majority of standard CASA XML files indicate the vector of strings type parameters with *stringArray*. However, a small number of them use *stringarray*. With CASAtools, only *stringArray* is accepted.
260 260
261 261 5. __Array Values__ --- (**developer**) With CASAtools, the behavior *`<value>`* elements for vector initialization has been rationalized:
262 262 * **`<value/>`** --- empty vector (zero elements)
263 263 * **`<value><value/></value>`** --- vector with one element initalized to the default initialization for the vector element type
264 264 * **`<value><value>0.0</value></value>`** --- vector with one element initialized as specified, more internal *`<value>`* elements can be used to increase the default size of the vector
265 265
266 + It is not possible to automatically adjust these because with the old XML translation `<value/>` will sometimes result in a one element vector and other times a zero element vector.
267 +
266 268 6. __Array Value Types__ --- There are now two Array types `<type>Array` and `<type>Vec`, e.g. `doubleArray` and `doubleVec`. Vec implies a one dimensional value, e.g. Python list, a one dimensonal numpy array, whereas Array implies potentially an N dimensional numpy array.
267 269
268 - It is not possible to automatically adjust these because with the old XML translation `<value/>` will sometimes result in a one element vector and other times a zero element vector.
269 270
270 271 ## XML
271 272
272 273 ### Tool Specification
273 274
274 275 <pre>
275 276 &lt;tool name="<i><font color="red">tool-name</font></i>"&gt;
276 277 <font color="blue">&lt;shortdescription&gt;</font><i>one-line description</i><font color="blue">&lt;/shortdescription&gt;</font>
277 278 <font color="blue">&lt;description&gt;</font><i>paragraph description</i><font color="blue">&lt;/description&gt;</font>
278 279

Everything looks good. We'll let you know here if there's anything you should know about.

Add shortcut