|
From: villate <vi...@us...> - 2025-08-24 14:13:18
|
This is an automated email from the git hooks/post-receive script. It was
generated because a ref change was pushed to the repository containing
the project "Maxima CAS".
The branch, master has been updated
via 6466d800d08b62a492725b5aacc48fcc7dbe7ede (commit)
from 8e5b42f0bc211c6fbb088214b6406464fe3346d2 (commit)
Those revisions listed above that are new to this repository have
not appeared on any other notification email; so we list those
revisions in full, below.
- Log -----------------------------------------------------------------
commit 6466d800d08b62a492725b5aacc48fcc7dbe7ede
Author: villate <vi...@fe...>
Date: Sun Aug 24 15:12:36 2025 +0100
Updates the procedure to include figures in the manual.
diff --git a/doc/info/README b/doc/info/README
index c967fc313..c6f5f582e 100644
--- a/doc/info/README
+++ b/doc/info/README
@@ -37,6 +37,11 @@ the user would need to select one (or all) without knowing how they
differ. But using `@fname`, there's only one function and the help is
imediately displayed.
+Adding figures to the manual
+----------------------------
+
+Please read the README file in the subdirectory figures.
+
How to test the documentation?
==============================
@@ -58,11 +63,14 @@ have proven helpful:
make pdf PDFTEX=xetex
to select xetex for building it.
-
- Do all of the documentation types look like they should?
- Is the documentation accessible to the ? and ?? commands of maxima?
+- Can the HTML version of the manual be browsed with a Web browser?
+ (it should be found in the subdirectory share/maxima/<version_number>/doc/html
+ in the installation directory.
+
Documentation internals
=======================
diff --git a/doc/info/figures/README b/doc/info/figures/README
index bf9a65a75..781332994 100644
--- a/doc/info/figures/README
+++ b/doc/info/figures/README
@@ -32,15 +32,25 @@ Once the files "plotting6.pdf" and "plotting6.png" have been created
in the doc/info/figures directory, they should be added in a section
of the manual using the following syntax:
-@ifnotinfo
-@image{figures/plotting6,8cm}
-@end ifnotinfo
+@altfigure{plotting6,Descriptive text}
Notice that no file-name extension or directory should be given. That
way, "plotting6.png" will included in the HTML version of the manual
and "plotting6.pdf" will be inserted with a width of 8 cm into the PDF
-version of the manual.
+version of the manual. In the info version of the manual the following
+will appear:
+ (Figure plotting6: Descriptive text)
+The "Descriptive text" is important to describe the figur for someone who
+is not looking at it. For instance, when a user is reading a manual section
+using "describe" in the Maxima console, or a blind user hearing to a screen
+reader describe whats in an HTML page of the manual.
+
+The is an older macro, @figure, which takes only one argument, the name of
+the file, and will use that name also as descriptive text.
+
+
+-----------------------------------------------------------
# Added by Gunter Königsmann on 2015
MACROS THAT HELP CREATING FIGURE FILES IN THE NEEDED FORMATS
-----------------------------------------------------------------------
Summary of changes:
doc/info/README | 10 +++++++++-
doc/info/figures/README | 18 ++++++++++++++----
2 files changed, 23 insertions(+), 5 deletions(-)
hooks/post-receive
--
Maxima CAS
|