doc/info/figures/README

   1 #  by Jaime E. Villate
   2 #  Time-stamp: "2021-04-22 15:19:44 villate"
   3
   4 INTRODUCTION
   5 ------------
   6
   7 The figures in this directory will be used in the Maxima manual.
   8 Each figure should be in two versions, PDF and PNG. The PDF version
   9 will be used in the PDF version of the manual, and the PNG version
  10 will be used in the HTML version.
  11
  12 CREATING FIGURES FOR THE MAXIMA MANUAL
  13 --------------------------------------
  14
  15 If the figures are the result of a plot2d or plot3d command, the two
  16 versions needed can be created adding the options pdf_file and
  17 png_file to the plotting command. For example, the two commands needed
  18 to produce the figure "plotting6", shown in the file plotting6.mac,
  19 are the following:
  20
  21 plot2d(sin(x), [x, -%pi, %pi], [pdf_file, "./plotting6.pdf"]);
  22 plot2d(sin(x), [x, -%pi, %pi], [png_file, "./plotting6.png"]);
  23
  24 The two files "plotting6.pdf" and "plotting6.png" can then be
  25 created by runnig Maxima in batch mode:
  26
  27 maxima -b plotting6.mac
  28
  29 ADDING FIGURES TO THE MANUAL
  30 ----------------------------
  31
  32 Once the files "plotting6.pdf" and "plotting6.png" have been created
  33 in the doc/info/figures directory, they should be added in a section
  34 of the manual using the following syntax:
  35
  36 @ifnotinfo
  37 @image{figures/plotting6,8cm}
  38 @end ifnotinfo
  39
  40 Notice that no file-name extension or directory should be given. That
  41 way, "plotting6.png" will included in the HTML version of the manual
  42 and "plotting6.pdf" will be inserted with a width of 8 cm into the PDF
  43 version of the manual.
  44
  45 ADDING THE FIGURE TO THE LIST OF FILES TO BE DISTRIBUTED
  46 --------------------------------------------------------
  47
  48 Every time you add a new figure, do not forget to modify the
  49 doc/info/Makefile.am file, adding the name of the two files (PDF and
  50 PNG) to the lists "figurefiles" and "pdffigures". In the example
  51 above,
  52
  53   figures/plotting6.png
  54
  55 should be added to figurefiles and
  56
  57 figures/plotting6.pdf
  58
  59 to pdffigures.
  60
  61 # Added by Gunter Königsmann on 2015
  62
  63 MACROS THAT HELP CREATING FIGURE FILES IN THE NEEDED FORMATS
  64 ------------------------------------------------------------
  65
  66 ../docdraw.mac contains macros that create a figure in both formats
  67 needed for building the documentation:
  68
  69 docdraw("test",gr2d(explicit(sin(x),x,1,10)));
  70 docdraw2d("test",explicit(sin(x),x,1,10));
  71 docdraw3d("test",explicit(sin(x)*cos(y),x,1,10,y,1,10));
  72
  73
  74 In order to ease the use of the figures found in the manual as a testbench
  75 for the plotting functions all new plot commands should be added to
  76 the .wxm files in the "tests" directory of the maxima source tree.
  77
  78
  79
  80
  81