Git commit d3a1ba9d8cd4ee8d04946278a1498eee49e49a42 by Yuri Chornoivan. Committed on 26/12/2018 at 20:40. Pushed by yurchor into branch 'master'.
Make man page translatable and conform to general KDE docs structure Summary: It is impossible now to translate man page, it is separated from the other docs and that is non-logical. Test Plan: Compiles, man page installs as expected, can be translated, conforms to the general KDE man page structure. Reviewers: #labplot, #documentation, sgerlach Reviewed By: #labplot, sgerlach Subscribers: sgerlach, kde-edu, kde-doc-english Tags: #kde_edu, #documentation Differential Revision: https://phabricator.kde.org/D17772 M +1 -0 CMakeLists.txt M +1 -0 doc/CMakeLists.txt A +101 -0 doc/man-labplot2.1.docbook M +0 -1 src/CMakeLists.txt D +0 -51 src/labplot2.1 https://commits.kde.org/labplot/d3a1ba9d8cd4ee8d04946278a1498eee49e49a42 diff --git a/CMakeLists.txt b/CMakeLists.txt index b16efbc0..a0a49112 100644 --- a/CMakeLists.txt +++ b/CMakeLists.txt @@ -417,6 +417,7 @@ ENDIF() add_subdirectory(data) add_subdirectory(icons) add_subdirectory(src) +add_subdirectory(doc) IF (ENABLE_LIBORIGIN) add_subdirectory(liborigin) diff --git a/doc/CMakeLists.txt b/doc/CMakeLists.txt index 59230d42..99e09e50 100644 --- a/doc/CMakeLists.txt +++ b/doc/CMakeLists.txt @@ -2,3 +2,4 @@ # # kdoctools_create_handbook(index.docbook INSTALL_DESTINATION ${HTML_INSTALL_DIR}/en SUBDIR ${PROJECT_NAME}) +kdoctools_create_manpage(man-labplot2.1.docbook 1 INSTALL_DESTINATION ${KDE_INSTALL_MANDIR}) diff --git a/doc/man-labplot2.1.docbook b/doc/man-labplot2.1.docbook new file mode 100644 index 00000000..5b1b52b0 --- /dev/null +++ b/doc/man-labplot2.1.docbook @@ -0,0 +1,101 @@ +<?xml version="1.0" ?> +<!DOCTYPE refentry PUBLIC "-//KDE//DTD DocBook XML V4.5-Based Variant V1.1//EN" "dtd/kdedbx45.dtd" [ +<!ENTITY % English "INCLUDE"> +]> + +<!-- Please keep this man page content in sync with Command Line Options sections of Okular handbook --> +<refentry lang="&language;"> +<refentryinfo> +<title>LabPlot User's Manual</title> +<author><firstname>Helen</firstname><surname>Faulkner</surname> +<contrib>LabPlot man page.</contrib> +<email>helen_ml_faulk...@yahoo.co.uk</email></author> +<date>2018-09-28</date> +<releaseinfo>LabPlot 2.6</releaseinfo> +<productname>KDE Extragear Applications</productname> +</refentryinfo> + +<refmeta> +<refentrytitle><command>labplot2</command></refentrytitle> +<manvolnum>1</manvolnum> +</refmeta> + +<refnamediv> +<refname>labplot2</refname> +<refpurpose>a KDE-application for interactive graphing and analysis of scientific data.</refpurpose> +</refnamediv> +<!-- body begins here --> +<refsynopsisdiv id='synopsis'> +<cmdsynopsis> + <command>labplot2</command> + <arg choice="opt"><replaceable>generic-options</replaceable></arg> + <arg choice="opt"><replaceable>file</replaceable></arg> +</cmdsynopsis> +</refsynopsisdiv> + + +<refsect1 id="description"><title>Description</title> +<para> + LabPlot is a data plotting and analysis tool for the Plasma desktop. +</para> +<para> + Its features include 2D and 3D data and function plotting, easy editing of plots, analysis of data and functions, support for different worksheets using MDI and LabPlot project files. +</para> +<para> + Note that LabPlot is called using <command>labplot2</command>. +</para> + +</refsect1> + +<refsect1 id="options"><title>Options</title> +<para> + For a full summary of generic options, run <userinput><command>labplot2</command> <parameter>--help</parameter></userinput>. +</para> +</refsect1> + +<refsect1 id="arguments"><title>Arguments</title> +<variablelist> + <varlistentry> + <term><option>file</option></term> + <listitem> + <para>An address of the project to be opened.</para> + </listitem> + </varlistentry> +</variablelist> +</refsect1> + +<refsect1> +<title>See Also</title> +<simplelist> +<member>Full user documentation is available through the KDE Help Centre. +You can also enter the URL <ulink +url="help:/labplot2">help:/labplot2</ulink> +(either enter this <acronym>URL</acronym> into &dolphin;, or run +<userinput><command>khelpcenter</command> +<parameter>help:/labplot2</parameter></userinput>).</member> +<member>kf5options(7)</member> +<member>qt5options(7)</member> +<member>There is also further information available at +<ulink url="https://labplot.kde.org/">https://labplot.kde.org/</ulink></member> +</simplelist> +</refsect1> + +<refsect1 id="authors"><title>Authors</title> +<para> + LabPlot2 was written by +</para> +<simplelist> + <member>Stefan Gerlach <stefan.gerl...@uni.kn>,</member> + <member>Alexander Semke <alexander.se...@web.de>,</member> + <member>Fábián Kristóf-Szabolcs <f-kris...@hotmail.com></member> + <member>and several other authors.</member> +</simplelist> +<para> + This manual page was prepared by Helen Faulkner <helen_ml_faulk...@yahoo.co.uk> for the Debian GNU/Linux system (but may be used by others). +</para> +<para> + License: GNU General Public Version 2 <<ulink url="http://www.gnu.org/licenses/gpl-2.0.html">http://www.gnu.org/licenses/gpl-2.0.html</ulink>> +</para> +</refsect1> +</refentry> + diff --git a/src/CMakeLists.txt b/src/CMakeLists.txt index ba8170c2..43a5a63d 100644 --- a/src/CMakeLists.txt +++ b/src/CMakeLists.txt @@ -470,5 +470,4 @@ install( FILES ${KDEFRONTEND_DIR}/splash.png ${KDEFRONTEND_DIR}/labplot2.ico ${C install( PROGRAMS org.kde.labplot2.desktop DESTINATION ${XDG_APPS_INSTALL_DIR} ) install( FILES labplot2.xml DESTINATION ${XDG_MIME_INSTALL_DIR} ) install( FILES labplot2_themes.knsrc DESTINATION ${CONFIG_INSTALL_DIR} ) -install( FILES labplot2.1 DESTINATION ${CMAKE_INSTALL_MANDIR}/man1 ) update_xdg_mimetypes( ${XDG_MIME_INSTALL_DIR} ) diff --git a/src/labplot2.1 b/src/labplot2.1 deleted file mode 100755 index b2ccc592..00000000 --- a/src/labplot2.1 +++ /dev/null @@ -1,51 +0,0 @@ -.\" Hey, EMACS: -*- nroff -*- -.\" First parameter, NAME, should be all caps -.\" Second parameter, SECTION, should be 1-8, maybe w/ subsection -.\" other parameters are allowed: see man(7), man(1) -.\" Please adjust this date whenever revising the manpage. -.\" -.\" Some roff macros, for reference: -.\" .nh disable hyphenation -.\" .hy enable hyphenation -.\" .ad l left justify -.\" .ad b justify to both left and right margins -.\" .nf disable filling -.\" .fi enable filling -.\" .br insert line break -.\" .sp <n> insert n+1 empty lines -.\" for manpage-specific macros, see man(7) -.TH "LabPlot" "1" "September 29, 2018" "" "" -.SH "NAME" -LabPlot \- a KDE-application for interactive graphing and analysis of scientific data. -.SH "SYNOPSIS" -.B labplot2 -[ \fIgeneric\-options\fP ] -[ \fIfile\fP ... ] - - - -.SH "DESCRIPTION" -\fBLabPlot\fP is a data plotting and analysis tool for the KDE desktop. -.PP -Its features include 2D and 3D data and function, plotting, easy editing of plots, analysis of data and functions, support for different worksheets using MDI and LabPlot project files. -.PP -Note that LabPlot is called using labplot2. -.SH "OPTIONS" -For a full summary of options, run \fIlabplot2 \-\-help\fP. - - - -.SH "SEE ALSO" -Full user documentation is available through the KDE Help Centre. -You can also enter the URL -\fIhelp:/labplot2/\fP -directly into dolphin or you can run -`\fIkhelpcenter help:/labplot2/\fP' -from the command\-line. -.PP - -.SH "AUTHOR" -LabPlot2 was written by Stefan Gerlach <stefan.gerl...@uni.kn>, Alexander Semke <alexander.se...@web.de>, Fábián Kristóf-Szabolcs <f-kris...@hotmail.com> and several other authors. -.br -This manual page was prepared by Helen Faulkner <helen_ml_faulk...@yahoo.co.uk> -for the Debian GNU/Linux system (but may be used by others).