Mercurial > octave

comparison doc/interpreter/genpropdoc.m @ 20886:3c986b688596

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Improve the documentation for the figure paper properties. * doc/interpreter/genpropdoc.m: Add additional detail to the documentation for "paperorientation", "paperposition", "paperpositionmode", "papersize", "papertype", and "paperunits".
author Ben Abbott <bpabbott@mac.com>
date Sun, 13 Dec 2015 14:10:46 -0500
parents 5b7643257978
children c640ea6a1612
comparison
equal deleted inserted replaced
20885:e5f78891ad9e 20886:3c986b688596
383 383
384 case "outerposition" 384 case "outerposition"
385 s.valid = valid_4elvec; 385 s.valid = valid_4elvec;
386 386
387 case "paperorientation" 387 case "paperorientation"
388 s.doc = "Defines the orientaton of the printed page. The value for \
389 the @code{papersize} property depends upon __prop__.\
390 The @code{papersize} values reverse order when __prop__ is switched \
391 between @code{\"portrait\"} and either @code{\"landscape\"} or \
392 @code{\"rotated\"}. The value of @code{paperposition} is not dependent upon \
393 the value of __prop__, and must be adjusted indepdently when needed."
394
388 case "paperposition" 395 case "paperposition"
389 s.doc = "Vector @code{[x0 y0 width height]} defining the position of \ 396 s.doc = "Vector @code{[x0 y0 width height]} defining the position and \
390 the figure (in @code{paperunits} units) on the printed page.\ 397 size of the figure (in @code{paperunits} units) on the printed page. The \
391 __modemsg__."; 398 position @code{[x0 y0]} defines the lower left corner of the figure on the \
399 page, and the size is defined by @code{[width height]}. For output formats, \
400 not implicity rendered on paper, the @code{width} and @code{height} define the \
401 size of the image and the position information is ignored. __modemsg__.";
392 s.valid = valid_4elvec; 402 s.valid = valid_4elvec;
393 403
394 case "paperpositionmode" 404 case "paperpositionmode"
395 s.doc = "If __prop__ is set to @qcode{\"auto\"}, the \ 405 s.doc = "If __prop__ is set to @qcode{\"auto\"}, the \
396 @code{paperposition} property is automatically computed: the printed \ 406 @code{paperposition} property is automatically computed: the printed \
397 figure will have the same size as the on-screen figure and will be centered \ 407 figure will have the same size as the on-screen figure and will be centered \
398 on the output page."; 408 on the output page. Setting the __prop__ to @code{\"auto\"} does not modify \
409 the value of the @code{paperposition} property.";
399 410
400 case "papersize" 411 case "papersize"
401 s.doc = "Vector @code{[width height]} defining the size of the \ 412 s.doc = "Vector @code{[width height]} defining the size of the \
402 paper for printing. Setting this property forces the @code{papertype} \ 413 paper for printing. Setting the __prop__ property to a value, not associated \
403 property to the value @qcode{\"<custom>\"}."; 414 with one of the defined @code{papertypes} and consistent with the setting for \
415 @code{paperorientation}, forces the @code{papertype} property to the value \
416 @qcode{\"<custom>\"}. If __prop__ is set to a value associated with a \
417 supported @code{papertype} and consistent with the @code{paperorientation}, \
418 the @code{papertype} value is modified to the associated value.";
404 s.valid = valid_2elvec; 419 s.valid = valid_2elvec;
405 420
406 case "papertype" 421 case "papertype"
407 s.doc = "Name of the paper used for printed output. \ 422 s.doc = "Name of the paper used for printed output. \
408 Setting __prop__ also changes @code{papersize} accordingly."; 423 Setting __prop__ also changes @code{papersize}, while maintaining consistency \
424 with the @code{paperorientation} property.";
409 425
410 case "paperunits" 426 case "paperunits"
411 s.doc = "The unit used to compute the @code{paperposition} property."; 427 s.doc = "The unit used to compute the @code{paperposition} property. \
428 For __prop__ set to @code{\"pixels\"}, the conversion between physical \
429 units (ex: @code{\"inches\"}) and @code{\"pixels\"} is dependent on the \
430 @code{screenpixelsperinch} property of the root object.";
412 431
413 case "pointer" 432 case "pointer"
414 s.doc = doc_unused; 433 s.doc = doc_unused;
415 case "pointershapecdata" 434 case "pointershapecdata"
416 s.doc = doc_unused; 435 s.doc = doc_unused;