Refactor database wizard help pages (part)

Change-Id: Ifcd63a48ca5faa3fa55f19f2949cccc4bd4ccaf3 Reviewed-on: https://gerrit.libreoffice.org/c/help/+/123002 Tested-by: Jenkins Reviewed-by: Olivier Hallot <olivier.hallot@libreoffice.org>
author: Olivier Hallot <olivier.hallot@libreoffice.org> 2021-10-02 13:50:24 -0300
committer: Olivier Hallot <olivier.hallot@libreoffice.org> 2021-10-02 18:54:24 +0200
commit: 6ad6a7c10c2684a5fbdac4bea643a215c3bcb8ab (patch)
tree: cbf63cf29b64c040ed246f466f9ee970949aa889 /source/text/sdatabase
parent: 39a1884a024666840913646b12841a458aeb51ab (diff)
4 files changed, 190 insertions, 11 deletions
diff --git a/source/text/sdatabase/dabawiz00.xhp b/source/text/sdatabase/dabawiz00.xhp
new file mode 100644
index 0000000000..bbb1492b72
--- /dev/null
+++ b/source/text/sdatabase/dabawiz00.xhp
@@ -0,0 +1,69 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<helpdocument version="1.0">
+
+<!--
+ * This file is part of the LibreOffice project.
+ *
+ * This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at http://mozilla.org/MPL/2.0/.
+ *
+ * This file incorporates work covered by the following license notice:
+ *
+ *   Licensed to the Apache Software Foundation (ASF) under one or more
+ *   contributor license agreements. See the NOTICE file distributed
+ *   with this work for additional information regarding copyright
+ *   ownership. The ASF licenses this file to you under the Apache
+ *   License, Version 2.0 (the "License"); you may not use this file
+ *   except in compliance with the License. You may obtain a copy of
+ *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
+ -->
+
+
+<meta>
+<topic id="textsharedexplorerdatabasedabawiz00xml" indexer="include">
+<title id="tit" xml-lang="en-US">Database Wizard</title>
+<filename>/text/sdatabase/dabawiz00.xhp</filename>
+</topic>
+</meta>
+<body>
+<section id="dabawiz00">
+<bookmark xml-lang="en-US" branch="index" id="bm_id2026429">
+<bookmark_value>wizards;databases (Base)</bookmark_value>
+<bookmark_value>Database Wizard (Base)</bookmark_value>
+<bookmark_value>databases; formats (Base)</bookmark_value>
+<bookmark_value>MySQL databases (Base)</bookmark_value>
+<bookmark_value>MariaDB databases (Base)</bookmark_value>
+<bookmark_value>dBASE; database settings (Base)</bookmark_value>
+<bookmark_value>jdbc; database settings (Base)</bookmark_value>
+<bookmark_value>odbc; database settings (Base)</bookmark_value>
+<bookmark_value>spreadsheets;as databases (base)</bookmark_value>
+</bookmark><comment>mw added "(Base)" to all entries</comment>
+<bookmark xml-lang="en-US" branch="hid/dbaccess/ui/generalpagewizard/PageGeneral" id="bm_id3952452" localize="false"/>
+<bookmark xml-lang="en-US" branch="hid/dbaccess/ui/generalpagewizard/@@nowidget@@" id="bm_id4952452" localize="false"/>
+<h1 id="par_idN105B4"><variable id="databasewizardh1"><link href="text/sdatabase/dabawiz00.xhp">Database Wizard</link></variable></h1>
+<paragraph role="paragraph" id="par_id9856563" xml-lang="en-US">The Database Wizard creates a <link href="text/sdatabase/dabadoc.xhp">database file</link> that contains information about a database.</paragraph>
+</section>
+<paragraph role="paragraph" id="par_idN105D5" xml-lang="en-US">Depending on the type of operation and the type of database, the Database Wizard consists of a varying number of steps.</paragraph>
+<paragraph role="paragraph" id="par_idN105DB" xml-lang="en-US">If you create a new database file, the wizard contains two steps.</paragraph>
+<embed href="text/sdatabase/dabawiz01.xhp#dabaselection"/>
+<embed href="text/shared/explorer/database/dabawiz02.xhp#nextsteps"/>
+<paragraph role="paragraph" id="par_idN105DF" xml-lang="en-US">If you open the Database Wizard to create a database file for an existing database connection, there may be more steps to specify paths, authentication information, and more.</paragraph>
+<paragraph role="paragraph" id="par_idN105F2" xml-lang="en-US"><link href="text/shared/explorer/database/dabawiz02text.xhp">Set up text file connection</link></paragraph>
+<switch select="sys">
+<case select="WIN">
+<paragraph role="paragraph" id="par_idN10601" xml-lang="en-US"><link href="text/shared/explorer/database/dabawiz02access.xhp">Set up Microsoft Access connection</link></paragraph>
+<paragraph role="paragraph" id="par_idN1062E" xml-lang="en-US"><link href="text/shared/explorer/database/dabawiz02ado.xhp">Set up ADO connection</link></paragraph>
+</case>
+</switch>
+<paragraph role="paragraph" id="par_idN1070F" xml-lang="en-US"><link href="text/shared/explorer/database/dabawiz02dbase.xhp">Set up dBASE connection</link></paragraph>
+<paragraph role="paragraph" id="par_idN1063D" xml-lang="en-US"><link href="text/shared/explorer/database/dabawiz02jdbc.xhp">Set up JDBC connection</link></paragraph>
+<paragraph role="paragraph" id="par_idN1064C" xml-lang="en-US"><link href="text/shared/explorer/database/dabawiz02oracle.xhp">Set up Oracle database connection</link></paragraph>
+<embed href="text/shared/explorer/database/dabawiz02mysql.xhp#mysql"/>
+<paragraph role="paragraph" id="par_idN1066A" xml-lang="en-US"><link href="text/shared/explorer/database/dabawiz02odbc.xhp">ODBC settings</link></paragraph>
+<paragraph role="paragraph" id="par_idN10679" xml-lang="en-US"><link href="text/shared/explorer/database/dabawiz02spreadsheet.xhp">Set up Spreadsheet connection</link></paragraph>
+<embed href="text/shared/00/00000001.xhp#cancel"/>
+<embed href="text/shared/00/00000001.xhp#back"/>
+<embed href="text/shared/00/00000001.xhp#next"/>
+</body>
+</helpdocument>
diff --git a/source/text/sdatabase/dabawiz01.xhp b/source/text/sdatabase/dabawiz01.xhp
new file mode 100644
index 0000000000..a6e22814a4
--- /dev/null
+++ b/source/text/sdatabase/dabawiz01.xhp
@@ -0,0 +1,71 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<helpdocument version="1.0">
+
+<!--
+ * This file is part of the LibreOffice project.
+ *
+ * This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at http://mozilla.org/MPL/2.0/.
+ *
+ * This file incorporates work covered by the following license notice:
+ *
+ *   Licensed to the Apache Software Foundation (ASF) under one or more
+ *   contributor license agreements. See the NOTICE file distributed
+ *   with this work for additional information regarding copyright
+ *   ownership. The ASF licenses this file to you under the Apache
+ *   License, Version 2.0 (the "License"); you may not use this file
+ *   except in compliance with the License. You may obtain a copy of
+ *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
+ -->
+
+
+<meta>
+<topic id="textsharedexplorerdatabasedabawiz01xml" indexer="include">
+<title id="tit" xml-lang="en-US">Database Selection</title>
+<filename>/text/sdatabase/dabawiz01.xhp</filename>
+</topic>
+</meta>
+<body>
+<section id="dabaselection">
+<bookmark xml-lang="en-US" branch="index" id="bm_id2082583"><bookmark_value>databases; connecting (Base)</bookmark_value>
+</bookmark>
+<h1 id="par_idN1054D"><variable id="databaseselectionh1"><link href="text/sdatabase/dabawiz01.xhp">Select Database</link></variable></h1>
+<paragraph role="paragraph" id="par_idN1055D" xml-lang="en-US"><ahelp hid=".">Creates a new database, opens a database file, or connects to an existing database.</ahelp></paragraph>
+</section>
+<bookmark xml-lang="en-US" branch="hid/dbaccess/ui/generalpagewizard/createDatabase" id="bm_id2482985" localize="false"/>
+<h2 id="par_idN10585">Create a new database</h2>
+<paragraph role="paragraph" id="par_idN10589" xml-lang="en-US"><ahelp hid=".">Select to create a new database. </ahelp>This option uses the HSQL database engine with default settings. The final page of the wizard appears next.</paragraph>
+<paragraph role="paragraph" id="par_id8584246" xml-lang="en-US"><link href="http://hsqldb.org/">External web page about HSQL</link>.</paragraph>
+
+<bookmark xml-lang="en-US" branch="hid/dbaccess/ui/generalpagewizard/openExistingDatabase" id="bm_id2400585" localize="false"/>
+<h2 id="par_idN105F9">Open an existing database file</h2>
+<paragraph role="paragraph" id="par_idN105FD" xml-lang="en-US"><ahelp hid=".">Select to open a database file from a list of recently used files or from a file selection dialog.</ahelp></paragraph>
+
+<bookmark xml-lang="en-US" branch="hid/dbaccess/ui/generalpagewizard/docListBox" id="bm_id5958128" localize="false"/>
+<h3 id="par_idN10614">Recently used</h3>
+<paragraph role="paragraph" id="par_idN10618" xml-lang="en-US"><ahelp hid=".">Select a database file to open from the list of recently used files. Click Finish to open the file immediately and to exit the wizard.</ahelp></paragraph>
+
+<bookmark xml-lang="en-US" branch="hid/dbaccess/ui/generalpagewizard/openDatabase" id="bm_id6427198" localize="false"/>
+<h3 id="par_idN1062F">Open</h3>
+<paragraph role="paragraph" id="par_idN10633" xml-lang="en-US"><ahelp hid=".">Opens a file selection dialog where you can select a database file. Click Open or OK in the file selection dialog to open the file immediately and to exit the wizard.</ahelp></paragraph>
+<bookmark xml-lang="en-US" branch="hid/dbaccess/ui/generalpagewizard/connectDatabase" id="bm_id5028229" localize="false"/>
+<h2 id="par_idN1058C">Connect to an existing database</h2>
+<paragraph role="paragraph" id="par_idN10590" xml-lang="en-US"><ahelp hid=".">Select to create a database document for an existing database connection.</ahelp></paragraph>
+<bookmark xml-lang="en-US" branch="hid/dbaccess/ui/generalpagewizard/datasourceType" id="bm_id763267" localize="false"/>
+<h3 id="par_idN10593">Database type</h3>
+<paragraph role="paragraph" id="par_idN10597" xml-lang="en-US"><ahelp hid=".">Select the database type for the existing database connection.</ahelp></paragraph>
+<note id="par_idN1059A">The Outlook, Evolution, KDE Address Book, and Seamonkey database types do not need additional information. For other database types, the wizard contains additional pages to specify the required information.</note>
+<paragraph role="paragraph" id="par_idN10611" xml-lang="en-US">The next wizard page is one of the following pages:</paragraph>
+<embed href="text/shared/explorer/database/dabawiz02.xhp#nextsteps"/>
+<paragraph role="paragraph" id="par_idN1061C" xml-lang="en-US"><link href="text/shared/explorer/database/dabawiz02text.xhp">Set up text file connection</link></paragraph>
+<paragraph role="paragraph" id="par_idN1062B" xml-lang="en-US"><link href="text/shared/explorer/database/dabawiz02access.xhp">Set up Microsoft Access or Microsoft Access 2007 connection</link></paragraph>
+<paragraph role="paragraph" id="par_idN1063A" xml-lang="en-US"><link href="text/shared/explorer/database/dabawiz02ldap.xhp">Set up LDAP connection</link></paragraph>
+<paragraph role="paragraph" id="par_idN10658" xml-lang="en-US"><link href="text/shared/explorer/database/dabawiz02ado.xhp">Set up ADO connection</link></paragraph>
+<paragraph role="paragraph" id="par_idN10667" xml-lang="en-US"><link href="text/shared/explorer/database/dabawiz02jdbc.xhp">Set up JDBC connection</link></paragraph>
+<paragraph role="paragraph" id="par_idN10676" xml-lang="en-US"><link href="text/shared/explorer/database/dabawiz02oracle.xhp">Set up Oracle database connection</link></paragraph>
+<embed href="text/shared/explorer/database/dabawiz02mysql.xhp#mysql"/>
+<paragraph role="paragraph" id="par_idN10694" xml-lang="en-US"><link href="text/shared/explorer/database/dabawiz02odbc.xhp">ODBC settings</link></paragraph>
+<paragraph role="paragraph" id="par_idN106A3" xml-lang="en-US"><link href="text/shared/explorer/database/dabawiz02spreadsheet.xhp">Set up Spreadsheet connection</link></paragraph>
+</body>
+</helpdocument>
diff --git a/source/text/sdatabase/dabawiz03auth.xhp b/source/text/sdatabase/dabawiz03auth.xhp
new file mode 100644
index 0000000000..6be4555990
--- /dev/null
+++ b/source/text/sdatabase/dabawiz03auth.xhp
@@ -0,0 +1,44 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+ * This file is part of the LibreOffice project.
+ *
+ * This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at http://mozilla.org/MPL/2.0/.
+ *
+ * This file incorporates work covered by the following license notice:
+ *
+ *   Licensed to the Apache Software Foundation (ASF) under one or more
+ *   contributor license agreements. See the NOTICE file distributed
+ *   with this work for additional information regarding copyright
+ *   ownership. The ASF licenses this file to you under the Apache
+ *   License, Version 2.0 (the "License"); you may not use this file
+ *   except in compliance with the License. You may obtain a copy of
+ *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
+ -->
+<helpdocument version="1.0">
+<meta>
+<topic id="textsharedexplorerdatabasedabawiz03authxml" indexer="include" status="PUBLISH">
+<title id="tit" xml-lang="en-US">Set up user authentication</title>
+<filename>/text/sdatabase/dabawiz03auth.xhp</filename>
+</topic>
+<history>
+<created date="2004-07-28T16:40:10">UFI: Database Wizard Authentication page</created>
+</history>
+</meta>
+<body>
+<h1 id="par_idN1053A">Set up user authentication</h1>
+<paragraph role="paragraph" id="par_idN1053E" xml-lang="en-US">Some databases require a user name and password.</paragraph>
+<bookmark xml-lang="en-US" branch="hid/dbaccess/ui/authentificationpage/generalUserNameEntry" id="bm_id5520493" localize="false"/>
+<h2 id="par_idN10541">User name</h2>
+<paragraph role="paragraph" id="par_idN10545" xml-lang="en-US"><ahelp hid=".">Enter the user name to access the database.</ahelp></paragraph>
+<bookmark xml-lang="en-US" branch="hid/dbaccess/ui/authentificationpage/passRequiredCheckbutton" id="bm_id6467787" localize="false"/>
+<h3 id="par_idN10548">Password required</h3>
+<paragraph role="paragraph" id="par_idN1054C" xml-lang="en-US"><ahelp hid=".">Select to prompt a user for a password to access the database.</ahelp></paragraph>
+<bookmark xml-lang="en-US" branch="hid/dbaccess/ui/authentificationpage/testConnectionButton" id="bm_id6467788" localize="false"/>
+<h3 id="par_idN10549">Test Connection</h3>
+<paragraph role="paragraph" id="par_idN10546" xml-lang="en-US"><ahelp hid=".">Check if the configured connection can be used to access the database.</ahelp></paragraph>
+<paragraph role="paragraph" id="par_idN1054F" xml-lang="en-US"><link href="text/shared/explorer/database/dabawiz02.xhp">Save and proceed</link></paragraph>
+<paragraph role="paragraph" localize="false" id="par_idN1061A" xml-lang="en-US"><embedvar href="text/sdatabase/dabawiz00.xhp#databasewizardh1"/></paragraph>
+</body>
+</helpdocument>
diff --git a/source/text/sdatabase/main.xhp b/source/text/sdatabase/main.xhp
index 2925265dca..806e88419c 100644
--- a/source/text/sdatabase/main.xhp
+++ b/source/text/sdatabase/main.xhp
@@ -1,7 +1,4 @@
 <?xml version="1.0" encoding="UTF-8"?>
-
-
-
 <!--
  * This file is part of the LibreOffice project.
  *
@@ -19,9 +16,7 @@
  *   except in compliance with the License. You may obtain a copy of
  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  -->
-
-
-		<helpdocument version="1.0">
+<helpdocument version="1.0">
 <meta>
 <topic id="textsharedexplorerdatabasemainxml" indexer="include" status="PUBLISH">
 <title id="tit" xml-lang="en-US">%PRODUCTNAME Database</title>
@@ -33,8 +28,8 @@
 <bookmark xml-lang="en-US" branch="index" id="bm_id8622089"><bookmark_value>databases;main page (Base)</bookmark_value>
 <bookmark_value>$[officename] Base data sources</bookmark_value>
 <bookmark_value>data sources;$[officename] Base</bookmark_value>
-</bookmark><comment>mw changed "Base,..."</comment><paragraph role="heading" id="par_idN10579" xml-lang="en-US" level="1"><variable id="base"><link href="text/sdatabase/main.xhp">Using Databases in %PRODUCTNAME Base</link>
-</variable></paragraph>
+</bookmark><comment>mw changed "Base,..."</comment><h1 id="par_idN10579"><variable id="base"><link href="text/sdatabase/main.xhp">Using Databases in %PRODUCTNAME Base</link>
+</variable></h1>
 <embed href="text/shared/06/youtubevideos.xhp#whatisit"/>
 <paragraph role="paragraph" id="par_idN107BD" xml-lang="en-US">In %PRODUCTNAME Base, you can access data that is stored in a wide variety of database file formats. %PRODUCTNAME Base natively supports some flat file database formats, such as the dBASE format. You can also use %PRODUCTNAME Base to connect to external relational databases, such as databases from MySQL or Oracle.</paragraph>
 </section>
@@ -50,14 +45,14 @@
 <paragraph role="paragraph" id="par_id6747337" xml-lang="en-US">Address book data</paragraph>
 </listitem>
 </list>
-<paragraph role="heading" id="par_idN107C0" xml-lang="en-US" level="2">Using a Database in %PRODUCTNAME</paragraph>
+<h2 id="par_idN107C0">Using a Database in %PRODUCTNAME</h2>
 <list type="unordered">
 <listitem>
 <paragraph role="paragraph" id="par_idN10838" xml-lang="en-US">To create a new database file, choose <emph>File - New - Database</emph>.</paragraph>
 </listitem>
 </list>
-<paragraph role="paragraph" id="par_idN1083B" xml-lang="en-US">The <link href="text/shared/explorer/database/dabawiz00.xhp">Database Wizard</link> helps you to create a database file and to register a new database within %PRODUCTNAME.</paragraph>
-<paragraph role="note" id="par_idN107E7" xml-lang="en-US">The database file contains queries, reports, and forms for the database as well as a link to the database where the records are stored. Formatting information is also stored in the database file.</paragraph>
+<paragraph role="paragraph" id="par_idN1083B" xml-lang="en-US">The <link href="text/sdatabase/dabawiz01.xhp">Database Wizard</link> helps you to create a database file and to register a new database within %PRODUCTNAME.</paragraph>
+<note id="par_idN107E7">The database file contains queries, reports, and forms for the database as well as a link to the database where the records are stored. Formatting information is also stored in the database file.</note>
 <list type="unordered">
 <listitem>
 <paragraph role="paragraph" id="par_idN1084A" xml-lang="en-US">To open a database file, choose <emph>File - Open</emph>. In the <emph>File type</emph> list box, select to view only "Database documents". Select a database document and click <emph>Open</emph>.</paragraph>
author	Olivier Hallot <olivier.hallot@libreoffice.org>	2021-10-02 13:50:24 -0300
committer	Olivier Hallot <olivier.hallot@libreoffice.org>	2021-10-02 18:54:24 +0200
commit	6ad6a7c10c2684a5fbdac4bea643a215c3bcb8ab (patch)
tree	cbf63cf29b64c040ed246f466f9ee970949aa889 /source/text/sdatabase
parent	39a1884a024666840913646b12841a458aeb51ab (diff)