Mercurial > octave

changeset 33049:8bb630882630

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
maint: Merge stable to default.
author Nicholas R. Jankowski <jankowski.nicholas@gmail.com>
date Sun, 18 Feb 2024 23:25:15 -0500
parents 359f922209d4 (current diff) f8c85e404acf (diff)
children 651bee56d638 5b54c2fb69bb
files doc/interpreter/genpropdoc.m libgui/src/documentation.cc
diffstat 4 files changed, 37 insertions(+), 28 deletions(-) [+]
line wrap: on
line diff
--- a/doc/interpreter/genpropdoc.m	Sat Feb 17 22:35:46 2024 -0500
+++ b/doc/interpreter/genpropdoc.m	Sun Feb 18 23:25:15 2024 -0500
@@ -402,9 +402,9 @@
 
       case "units"
         s.doc = "The unit type used for the \
-@ref{XREFrootmonitorpositions, , @w{@qcode{\"monitorpositions\"}}}, \
-@ref{XREFrootpointerlocation, , @w{@qcode{\"pointerlocation\"}}}, and \
-@ref{XREFrootscreensize, , @w{@qcode{\"screensize\"}}} properties.";
+@ref{XREFrootmonitorpositions, , @qcode{\"monitorpositions\"}}, \
+@ref{XREFrootpointerlocation, , @qcode{\"pointerlocation\"}}, and \
+@ref{XREFrootscreensize, , @qcode{\"screensize\"}} properties.";
         s.category = "Screen Information";
 
     endswitch
@@ -695,12 +695,14 @@
       case "toolbar"
         s.doc = "Control the display of the toolbar (along the bottom of the \
 menubar) and the status bar.  When set to @qcode{\"auto\"}, the display is \
-based on the value of the @code{menubar} property.";
+based on the value of the @ref{XREFfiguremenubar,,@qcode{\"menubar\"}} \
+property.";
         s.category = "Mouse Interaction";
 
       case "units"
-        s.doc = "The unit used to compute the @code{position} and \
-@code{outerposition} properties.";
+        s.doc = "The unit used to compute the \
+@ref{XREFfigureposition,,position} and \
+@ref{XREFfigureouterposition,,outerposition} properties.";
         s.category = "Object Position";
 
       case "windowbuttondownfcn"
@@ -1042,7 +1044,7 @@
         s.doc = "List of linestyles to be used in order by axes child \
 objects, specified as a cell array of line specification strings.  Note that \
 the linestyle is only incremented after cycling through the full \
-@ref{XREFaxescolororder, , @w{@qcode{\"colororder\"}}} list.  \
+@ref{XREFaxescolororder, , @qcode{\"colororder\"}} list.  \
 @xref{Line Styles}.";
         s.category = "Automatic Child Properties";
 
@@ -1098,8 +1100,8 @@
 
       case "nextseriesindex"
         s.doc = "Current index value into the \
-@ref{XREFaxescolororder, , @w{\"colororder\"}} and \
-@ref{XREFaxeslinestyleorder, , @w{\"linestyleorder\"}} \
+@ref{XREFaxescolororder, , \"colororder\"} and \
+@ref{XREFaxeslinestyleorder, , \"linestyleorder\"} \
 properties, indicating the item that will be used by the next child object";
         s.valid = "whole number scalar";
         s.category = "Automatic Child Properties";
@@ -1835,8 +1837,8 @@
 
       case "units"
         s.doc = "Sets the measurement unit or method applied to the \
-@ref{XREFtextposition, , @w{@qcode{\"position\"}}} and \
-@ref{XREFtextextent, , @w{@qcode{\"extent\"}}} properties.  The default \
+@ref{XREFtextposition, , @qcode{\"position\"}} and \
+@ref{XREFtextextent, , @qcode{\"extent\"}} properties.  The default \
 option @qcode{\"data\"} uses the same units and limits as the data plotted in \
 the figure.  The @qcode{\"normalized\"} option applies a unitless 0 to 1 scale \
 to the limits along each axis of the displayed data.";
@@ -1945,7 +1947,7 @@
       case "cdata"
         s.doc = "Color data values for __objname__ vertices. Data is stored \
 either as a 2-D matrix the same size as \
-@ref{XREFsurfacezdata, , @w{@qcode{\"zdata\"}}} where each element's value \
+@ref{XREFsurfacezdata, , @qcode{\"zdata\"}} where each element's value \
 determines that vertex's color according to the current colormap, or as a \
 3-D array where the third dimension contains separate red, blue, and green \
 components for each vertex.";
@@ -1991,7 +1993,7 @@
 @qcode{\"flat\"}, or @qcode{\"interp\"}.  @qcode{\"flat\"} and \
 @qcode{\"interp\"} will set either a single color for each edge or a color \
 interpolated between two adjacent vertices using the color value data stored \
-in @ref{XREFsurfacecdata, , @w{@qcode{\"cdata\"}}}.  \
+in @ref{XREFsurfacecdata, , @qcode{\"cdata\"}}.  \
 @xref{Colors, , colorspec}.";
         s.valid = packopt ({valid_color, ...
                             "@qcode{\"none\"}", ...
@@ -2028,7 +2030,7 @@
 @qcode{\"flat\"}, or @qcode{\"interp\"}.  @qcode{\"flat\"} and \
 @qcode{\"interp\"} will set either a single color for each face or a color \
 interpolated across the face's vertices using the color value data stored in \
-@ref{XREFsurfacecdata, , @w{@qcode{\"cdata\"}}}.  \
+@ref{XREFsurfacecdata, , @qcode{\"cdata\"}}.  \
 @xref{Colors, , colorspec}.";
         s.valid = packopt ({valid_color, ...
                             "@qcode{\"none\"}", ...
@@ -2210,8 +2212,8 @@
 
       case "cdatamapping"
         s.doc = "Sets the method for mapping data from the \
-@ref{XREFpatchcdata, , @w{@qcode{\"cdata\"}}} or \
-@ref{XREFpatchcdata, , @w{@qcode{\"cdata\"}}} property to the current \
+@ref{XREFpatchcdata, , @qcode{\"cdata\"}} or \
+@ref{XREFpatchcdata, , @qcode{\"cdata\"}} property to the current \
 colormap.  @qcode{\"Direct\"} mapping selects the color using the \
 @qcode{\"cdata\"} or @qcode{\"facevertexcdata\"} value as an index to the \
 current colormap.  @qcode{\"Scaled\"} mapping scales the @qcode{\"cdata\"} \
@@ -2240,7 +2242,7 @@
 @qcode{\"flat\"}, or @qcode{\"interp\"}.  @qcode{\"flat\"} and \
 @qcode{\"interp\"} will set either a single color for each edge or a color \
 interpolated between edge's vertices using the color value data stored in \
-@ref{XREFpatchcdata, , @w{@qcode{\"cdata\"}}}.  \
+@ref{XREFpatchcdata, , @qcode{\"cdata\"}}.  \
 @xref{Colors, , colorspec}.";
         s.valid = packopt ({valid_color, ...
                             "@qcode{\"none\"}", ...
@@ -2276,8 +2278,8 @@
 @qcode{\"flat\"}, or @qcode{\"interp\"}.  @qcode{\"flat\"} and \
 @qcode{\"interp\"} will set either a single color for each face or a color \
 interpolated across the face's vertices using the color value data stored in \
-either the @ref{XREFpatchcdata, , @w{@qcode{\"cdata\"}}} or \
-@ref{XREFpatchfacevertexcdata, , @w{@qcode{\"facevertexcdata\"}}} \
+either the @ref{XREFpatchcdata, , @qcode{\"cdata\"}} or \
+@ref{XREFpatchfacevertexcdata, , @qcode{\"facevertexcdata\"}} \
 properties.  @xref{Colors, , colorspec}.";
         ## Don't provide a default value, and mark colorspec with
         ## braces, this forces the default RGB triplet to be displayed
--- a/doc/interpreter/grammar.txi	Sat Feb 17 22:35:46 2024 -0500
+++ b/doc/interpreter/grammar.txi	Sun Feb 18 23:25:15 2024 -0500
@@ -171,9 +171,13 @@
 
 @DOCSTRING(endclassdef)
 
-@c methods definition must be manually created to avoid
+@c properties definition must be manually created to avoid
 @c collision with function of the same name.
 @anchor{XREFkwpropertyproperties}
+@html
+<span style="display:block; margin-top:-4.5ex;">&nbsp;</span>
+@end html
+
 @deftypefn {} {} properties
 Mark the beginning of a block of properties in a classdef definition.  Note
 that the @ref{XREFproperties, , function @qcode{"properties"}} is a function
@@ -186,6 +190,10 @@
 @c methods definition must be manually created to avoid
 @c collision with function of the same name.
 @anchor{XREFkwpropertymethods}
+@html
+<span style="display:block; margin-top:-4.5ex;">&nbsp;</span>
+@end html
+
 @deftypefn {} {} methods
 Mark the beginning of a block of methods in a classdef definition.  Note that
 the @ref{XREFmethods, , function @qcode{"methods"}} is a function that lists
--- a/doc/interpreter/munge-texi.pl	Sat Feb 17 22:35:46 2024 -0500
+++ b/doc/interpreter/munge-texi.pl	Sun Feb 18 23:25:15 2024 -0500
@@ -94,7 +94,11 @@
 
     $func =~ s/^@/@@/;   # Texinfo uses @@ to produce '@'
     $func =~ s/\./_/g;   # Texinfo doesn't like '.' in node names
-    $docstring =~ s/^$tex_delim$/\@anchor{XREF$func}/m;
+    # Replace texinfo start tag by an anchor. QtHelp requires a string
+    # directly following the anchor. Adding a &nbsp; in html mode adds an
+    # additional vertical space which is compensated by span-tag with
+    # negativ top margin
+    $docstring =~ s/^$tex_delim$/\@anchor{XREF$func}\n\@html\n<span style=\"display:block; margin-top:-4.5ex;\">&nbsp;<\/span>\n\@end html\n\n/m;
     print $docstring,"\n";
 
     next TXI_LINE;
--- a/libgui/src/documentation.cc	Sat Feb 17 22:35:46 2024 -0500
+++ b/libgui/src/documentation.cc	Sun Feb 18 23:25:15 2024 -0500
@@ -1101,14 +1101,9 @@
 documentation_browser::handle_index_clicked (const QUrl& url, const QString&)
 {
   if (url.scheme () == "qthelp")
-    {
-      // URL wihtin the help system, replace #XREF by #index-
-      QString u = url.toString ();
-      u.replace ("#XREF", "#index-");
-      setSource (QUrl (u));
-    }
+    setSource (QUrl (url));
   else
-    QDesktopServices::openUrl (url);  // URL outside help system
+    QDesktopServices::openUrl (url);
 }
 
 void