view scripts/help/private/__additional_help_message__.m @ 17029:359c5ca795cd

Display doc info pages using documentation browser when in GUI mode (Bug #39451) * scripts/help/doc.m: call __octave_link_show_doc if in gui mode. * libinterp/corefcn/octave-link.h, libinterp/corefcn/octave-link.cc (octave_link::show_doc): New function. (octave_link::do_show_doc): New virtual function. (__octave_link_show_doc__): New function. * libgui/src/octave-qt-link.h (octave_qt_link::show_doc_signal): New signal. (octave_qt_link::do_show_doc): New function. * libgui/src/documentation-dock-widget.cc, libgui/src/documentation-dock-widget.h (documentation_dock_widget::showDoc): New function. * libgui/src/main-window.cc, libgui/src/main-window.h (main_window::construct_octave_qt_link): connect handle_show_doc. (main_window::handle_show_doc): New function. (main_window::show_doc_signal): New signal. * libgui/src/qtinfo/parser.cc, libgui/src/qtinfo/parser.h (parser::find_ref): New function. * libgui/src/qtinfo/webinfo.cc, libgui/src/qtinfo/webinfo.h (webinfo::load_ref): New function.
author John Donoghue <john.donoghue@ieee.org>
date Sat, 20 Jul 2013 22:13:51 -0400
parents 6a4e79110857
children f4c8c66faf34
line wrap: on
line source

## Copyright (C) 2009-2012 S�ren Hauberg
##
## This file is part of Octave.
##
## Octave is free software; you can redistribute it and/or modify it
## under the terms of the GNU General Public License as published by
## the Free Software Foundation; either version 3 of the License, or (at
## your option) any later version.
##
## Octave is distributed in the hope that it will be useful, but
## WITHOUT ANY WARRANTY; without even the implied warranty of
## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
## General Public License for more details.
##
## You should have received a copy of the GNU General Public License
## along with Octave; see the file COPYING.  If not, see
## <http://www.gnu.org/licenses/>.

## -*- texinfo -*-
## @deftypefn {Function File} {} __additional_help_message__ ()
## Undocumented internal function.
## @end deftypefn

function msg = __additional_help_message__ ()

  if (suppress_verbose_help_message ())
    msg = "";
  else
    msg = "\
Additional help for built-in functions and operators is\n\
available in the online version of the manual.  Use the command\n\
'doc <topic>' to search the manual index.\n\
\n\
Help and information about Octave is also available on the WWW\n\
at http://www.octave.org and via the help@octave.org\n\
mailing list.\n";
  endif

endfunction