Corrections/precisions in ScriptForge help pages

- removing outdated comments
- deprecation and omissions in sf_form, sf_formcontrol, sf_formdocument

Change-Id: Id5b1abdb812edc13a1489f0b01fff7f34a17416c
Reviewed-on: https://gerrit.libreoffice.org/c/help/+/163548
Tested-by: Jenkins
Reviewed-by: Alain Romedenne <alain.romedenne@libreoffice.org>

4 files changed, 31 insertions, 80 deletions

diff --git a/source/text/sbasic/python/python_handler.xhp b/source/text/sbasic/python/python_handler.xhp
index 5bb294f6e3..42b079cb0c 100644
--- a/source/text/sbasic/python/python_handler.xhp
+++ b/source/text/sbasic/python/python_handler.xhp
@@ -92,8 +92,6 @@
       <paragraph role="pycode" localize="false" id="N0725">        dlg = dp.createDialogWithHandler(&quot;vnd.sun.star.script:&quot;+libr_dlg+location, self)</paragraph>
       <paragraph role="pycode" localize="false" id="N0726">        return dlg</paragraph>
       <paragraph role="pycode" localize="false" id="N072A">    </paragraph>
-      <!-- WIP need extra work to embed remote code
-      <embed href="text/sbasic/python/Python_2_Basic.xhp#Python_getBasicScript" /> -->
       <paragraph role="pycode" localize="false" id="N072B"># def getBasicScript()  # see note</paragraph>
       <paragraph role="pycode" localize="false" id="N0727">     </paragraph>
       <paragraph role="pycode" localize="false" id="N0728">def _msgbox(prompt=&apos;&apos;, title=&apos;&apos;):</paragraph>
diff --git a/source/text/sbasic/shared/03/sf_form.xhp b/source/text/sbasic/shared/03/sf_form.xhp
index 163c32e390..cc33940bce 100644
--- a/source/text/sbasic/shared/03/sf_form.xhp
+++ b/source/text/sbasic/shared/03/sf_form.xhp
@@ -563,15 +563,14 @@
     <tablerow>
        <tablecell><paragraph id="par_id381606472825856" role="tablecontent" localize="false">
            <link href="text/sbasic/shared/03/sf_form.xhp#Activate">Activate</link><br/>
-           <link href="text/sbasic/shared/03/sf_form.xhp#CloseFormDocument">CloseFormDocument</link><br/>
            <link href="text/sbasic/shared/03/sf_form.xhp#Controls">Controls</link><br/>
            <link href="text/sbasic/shared/03/sf_form.xhp#GetDatabase">GetDatabase</link><br/>
+           <link href="text/sbasic/shared/03/sf_form.xhp#MoveFirst">MoveFirst</link><br/>
        </paragraph></tablecell>
        <tablecell><paragraph id="par_id451606472825856" role="tablecontent" localize="false">
-           <link href="text/sbasic/shared/03/sf_form.xhp#MoveFirst">MoveFirst</link><br/>
            <link href="text/sbasic/shared/03/sf_form.xhp#MoveLast">MoveLast</link><br/>
            <link href="text/sbasic/shared/03/sf_form.xhp#MoveNext">MoveNext</link><br/>
-           <link href="text/sbasic/shared/03/sf_form.xhp#MoveNew">MoveNew</link><br/>
+           <link href="text/sbasic/shared/03/sf_form.xhp#MoveNew">MoveNew</link><br/><br/>
        </paragraph></tablecell>
        <tablecell><paragraph id="par_id161606472825856" role="tablecontent" localize="false">
            <link href="text/sbasic/shared/03/sf_form.xhp#MovePrevious">MovePrevious</link><br/>
@@ -622,10 +621,8 @@
 </section>
 <section id="CloseFormDocument">
   <comment> CloseFormDocument -------------------------------------------------------------------------------------------------------------------------- </comment>
-   <bookmark xml-lang="en-US" localize="false" branch="index" id="bm_id14161686043795">
-      <bookmark_value>Form service;CloseFormDocument</bookmark_value>
-   </bookmark>
    <h2 id="hd_id18161686043718" localize="false">CloseFormDocument</h2>
+   <warning id="par_id951709729717741">This method is deprecated, use <link href="text/sbasic/shared/03/sf_formdocument.xhp#CloseDocument">ScriptForge.FormDocument.CloseDocument</link> method instead.</warning>
    <paragraph role="paragraph" id="par_id501616860541195" xml-lang="en-US">Closes the form document containing the actual <literal>Form</literal> instance. The <literal>Form</literal> instance is disposed.</paragraph>
    <embed href="text/sbasic/shared/00000003.xhp#functsyntax"/>
    <paragraph role="paragraph" id="par_id811622538068303" localize="false"><input>svc.CloseFormDocument(): bool</input></paragraph>
@@ -637,7 +634,6 @@
    <pycode>
       <paragraph role="pycode" localize="false" id="pyc_id331622538021746">form.CloseFormDocument()  # Python</paragraph>
    </pycode>
-   <note id="par_id611618229004669">This method only closes form documents located in Base documents. If the form is stored in a Writer or Calc document, calling <literal>CloseFormDocument</literal> will have no effect.</note>
 </section>
 <section id="Controls">
    <comment> Controls -------------------------------------------------------------------------------------------------------------------------- </comment>
@@ -677,6 +673,7 @@
    <bookmark xml-lang="en-US" localize="false" branch="index" id="bm_id941616861134691">
       <bookmark_value>Form service;GetDatabase</bookmark_value>
    </bookmark>
+  <section id="getDbContent">
    <h2 id="hd_id141616861134554" localize="false">GetDatabase</h2>
    <paragraph role="paragraph" id="par_id291616861407907" xml-lang="en-US">Return a <link href="text/sbasic/shared/03/sf_database.xhp"><literal>SFDatabases</literal>.<literal>Database</literal></link> instance giving access to the execution of SQL commands on the database the current form is connected to and/or that is stored in the current Base document.</paragraph>
    <paragraph role="paragraph" id="par_id991616861417207" xml-lang="en-US">Each form has its own database connection, except in Base documents where they all share the same connection.</paragraph>
@@ -693,6 +690,7 @@
    <pycode>
       <paragraph role="pycode" localize="false" id="pyc_id871622547824003">db = form.GetDatabase()  # SFDatabases.Database</paragraph>
    </pycode>
+  </section>
 </section>
 <section id="MoveFirst">
   <comment> MoveFirst -------------------------------------------------------------------------------------------------------------------------- </comment>
diff --git a/source/text/sbasic/shared/03/sf_formcontrol.xhp b/source/text/sbasic/shared/03/sf_formcontrol.xhp
index 32f2e16a14..d14af07115 100644
--- a/source/text/sbasic/shared/03/sf_formcontrol.xhp
+++ b/source/text/sbasic/shared/03/sf_formcontrol.xhp
@@ -92,74 +92,20 @@
    </section>
    <h2 id="hd_id71598455687512" xml-lang="en-US">Control types</h2>
    <paragraph role="paragraph" id="par_id851598455863395" xml-lang="en-US">The <literal>FormControl</literal> service is available for the following control types:</paragraph>
-   <list type="unordered">
-      <listitem>
-         <paragraph id="par_id121598455880500" localize="false" role="listitem">Button</paragraph>
-      </listitem>
-      <listitem>
-         <paragraph id="par_id441598455934376" localize="false" role="listitem">CheckBox</paragraph>
-      </listitem>
-      <listitem>
-         <paragraph id="par_id471598455940400" localize="false" role="listitem">ComboBox</paragraph>
-      </listitem>
-      <listitem>
-         <paragraph id="par_id181598455945642" localize="false" role="listitem">CurrencyField</paragraph>
-      </listitem>
-      <listitem>
-         <paragraph id="par_id181598455949653" localize="false" role="listitem">DateField</paragraph>
-      </listitem>
-      <listitem>
-         <paragraph id="par_id541598455953714" localize="false" role="listitem">FileControl</paragraph>
-      </listitem>
-      <listitem>
-         <paragraph id="par_id971598455961404" localize="false" role="listitem">FixedText</paragraph>
-      </listitem>
-      <listitem>
-         <paragraph id="par_id721598455965612" localize="false" role="listitem">FormattedField</paragraph>
-      </listitem>
-      <listitem>
-         <paragraph id="par_id291598455969826" localize="false" role="listitem">GroupBox</paragraph>
-      </listitem>
-      <listitem>
-         <paragraph id="par_id111616941115924" localize="false" role="listitem">HiddenControl</paragraph>
-      </listitem>
-      <listitem>
-         <paragraph id="par_id101616941115596" localize="false" role="listitem">ImageButton</paragraph>
-      </listitem>
-      <listitem>
-         <paragraph id="par_id861598455974724" localize="false" role="listitem">ImageControl</paragraph>
-      </listitem>
-      <listitem>
-         <paragraph id="par_id851598455979572" localize="false" role="listitem">ListBox</paragraph>
-      </listitem>
-      <listitem>
-         <paragraph id="par_id851616941210356" localize="false" role="listitem">NavigationBar</paragraph>
-      </listitem>
-      <listitem>
-         <paragraph id="par_id321598455984243" localize="false" role="listitem">NumericField</paragraph>
-      </listitem>
-      <listitem>
-         <paragraph id="par_id981598455990524" localize="false" role="listitem">PatternField</paragraph>
-      </listitem>
-      <listitem>
-         <paragraph id="par_id281598456002561" localize="false" role="listitem">RadioButton</paragraph>
-      </listitem>
-      <listitem>
-         <paragraph id="par_id91598456007438" localize="false" role="listitem">ScrollBar</paragraph>
-      </listitem>
-      <listitem>
-         <paragraph id="par_id851616941293261" localize="false" role="listitem">SpinButton</paragraph>
-      </listitem>
-      <listitem>
-         <paragraph id="par_id241616941333335" localize="false" role="listitem">TableControl</paragraph>
-      </listitem>
-      <listitem>
-         <paragraph id="par_id271598456011504" localize="false" role="listitem">TextField</paragraph>
-      </listitem>
-      <listitem>
-         <paragraph id="par_id661598456015339" localize="false" role="listitem">TimeField</paragraph>
-      </listitem>
-   </list>
+   <table id="tab_id371709730484386">
+   <tablerow>
+       <tablecell>
+           <paragraph id="par_id531709730484386" role="tablecontent" localize="false">Button<br/>CheckBox<br/>ComboBox<br/>CurrencyField<br/>DateField<br/>FileControl<br/>FixedText<br/>FormattedField</paragraph>
+       </tablecell>
+       <tablecell>
+           <paragraph id="par_id591709730484386" role="tablecontent" localize="false">GroupBox<br/>HiddenControl<br/>ImageButton<br/>ImageControl<br/>ListBox<br/>NavigationBar<br/>NumericField</paragraph>
+       </tablecell>
+       <tablecell>
+           <paragraph id="par_id361709730484386" role="tablecontent" localize="false">PatternField<br/>RadioButton<br/>ScrollBar<br/>SpinButton<br/>TableControl<br/>TextField<br/>TimeField</paragraph>
+       </tablecell>
+     </tablerow>
+   </table>
+
    <h2 id="hd_id651583668365757" xml-lang="en-US">Properties</h2>
    <section id="properties_toc">
     <table id="tab_id381583668386455">
@@ -399,7 +345,7 @@
             <paragraph id="par_id571598457655365" role="tablecontent" localize="false">Boolean</paragraph>
          </tablecell>
          <tablecell>
-            <paragraph id="par_id111598539631340" role="tablecontent" localize="false">ComboBox, CurrencyField, DateField, FileControl, FileControl, FormattedField, ImageControl, ListBox, NumericField, PatternField, TextField, TimeField</paragraph>
+            <paragraph id="par_id111598539631340" role="tablecontent" localize="false">ComboBox, CurrencyField, DateField, FileControl, FormattedField, ImageControl, ListBox, NumericField, PatternField, TextField, TimeField</paragraph>
          </tablecell>
          <tablecell>
             <paragraph id="par_id2159845765568" role="tablecontent" xml-lang="en-US">Specifies if the control is read-only.</paragraph>
diff --git a/source/text/sbasic/shared/03/sf_formdocument.xhp b/source/text/sbasic/shared/03/sf_formdocument.xhp
index 696f610276..1d8b1e6384 100644
--- a/source/text/sbasic/shared/03/sf_formdocument.xhp
+++ b/source/text/sbasic/shared/03/sf_formdocument.xhp
@@ -77,16 +77,17 @@
        <tablecell>
            <paragraph id="par_id981619034669263" role="tablecontent" localize="false">
              <link href="text/sbasic/shared/03/sf_formdocument.xhp#CloseDocument">CloseDocument</link><br/>
+             <link href="text/sbasic/shared/03/sf_formdocument.xhp#Forms">Forms</link><br/>
            </paragraph>
        </tablecell>
        <tablecell>
            <paragraph id="par_id721619034669263" role="tablecontent" localize="false">
-             <link href="text/sbasic/shared/03/sf_formdocument.xhp#Forms">Forms</link><br/>
+             <link href="text/sbasic/shared/03/sf_formdocument.xhp#GetDatabase">GetDatabase</link><br/><br/>
            </paragraph>
        </tablecell>
        <tablecell>
            <paragraph id="par_id711619034669263" role="tablecontent" localize="false">
-             <link href="text/sbasic/shared/03/sf_formdocument.xhp#PrintOut">PrintOut</link><br/>
+             <link href="text/sbasic/shared/03/sf_formdocument.xhp#PrintOut">PrintOut</link><br/><br/>
            </paragraph>
        </tablecell>
    </tablerow>
@@ -165,6 +166,14 @@
   <tip id="par_id921619036922844">To learn more about form methods and properties, refer to the <link href="text/sbasic/shared/03/sf_form.xhp"><literal>Form</literal> service help page</link>.</tip>
 </section>
 
+<section id="GetDatabase">
+   <comment> GetDatabase -------------------------------------------------------------------------------------------------------------------------- </comment>
+   <bookmark xml-lang="en-US" localize="false" branch="index" id="bm_id941616861134691">
+      <bookmark_value>FormDocument service;GetDatabase</bookmark_value>
+   </bookmark>
+   <embed href="text/sbasic/shared/03/sf_form.xhp#getDbContent"/>
+</section>
+
 <section id="PrintOut">
   <comment> PrintOut --------------------------------------------------------------------------------- </comment>
   <bookmark xml-lang="en-US" localize="false" branch="index" id="bm_id721985200121249">