[Libreoffice-commits] help.git: AllLangHelp_sbasic.mk AllLangHelp_shared.mk source/text
Olivier Hallot
olivier.hallot at edx.srv.br
Tue Aug 25 08:12:58 PDT 2015
AllLangHelp_sbasic.mk | 1
AllLangHelp_shared.mk | 1
source/text/sbasic/shared/01030000.xhp | 3 -
source/text/sbasic/shared/code-stubs.xhp | 46 +++++++++++++++++
source/text/shared/00/00000406.xhp | 2
source/text/shared/need_help.xhp | 49 ++++++++++--------
source/text/shared/optionen/BasicIDE.xhp | 70 +++++++++++++++++++++++----
source/text/shared/optionen/experimental.xhp | 36 +++++++++++++
8 files changed, 174 insertions(+), 34 deletions(-)
New commits:
commit fff841e50d4e1b36453820b66f150d708ebfff2b
Author: Olivier Hallot <olivier.hallot at edx.srv.br>
Date: Sun Jul 26 17:39:23 2015 -0300
TDF#80588 Help page for Basic IDE Options
Help page for Basic IDE Option in Tools - LibreOffice - Basic IDE Options
Before merging this patch it is necessary to verify correctness of the help page contents.
Change-Id: Ic80410910ed3eadb02c4fd49c02fc5f1dce053db
Reviewed-on: https://gerrit.libreoffice.org/17356
Reviewed-by: Caolán McNamara <caolanm at redhat.com>
Tested-by: Caolán McNamara <caolanm at redhat.com>
diff --git a/AllLangHelp_sbasic.mk b/AllLangHelp_sbasic.mk
index 183490b..d93e0b7 100644
--- a/AllLangHelp_sbasic.mk
+++ b/AllLangHelp_sbasic.mk
@@ -319,6 +319,7 @@ $(eval $(call gb_AllLangHelp_add_helpfiles,sbasic,\
helpcontent2/source/text/sbasic/shared/03132400 \
helpcontent2/source/text/sbasic/shared/03132500 \
helpcontent2/source/text/sbasic/shared/05060700 \
+ helpcontent2/source/text/sbasic/shared/code-stubs \
helpcontent2/source/text/sbasic/shared/keys \
helpcontent2/source/text/sbasic/shared/main0211 \
helpcontent2/source/text/sbasic/shared/main0601 \
diff --git a/AllLangHelp_shared.mk b/AllLangHelp_shared.mk
index b6ffe86..50cd9a6 100644
--- a/AllLangHelp_shared.mk
+++ b/AllLangHelp_shared.mk
@@ -899,6 +899,7 @@ $(eval $(call gb_AllLangHelp_add_helpfiles,shared,\
helpcontent2/source/text/shared/optionen/01160200 \
helpcontent2/source/text/shared/optionen/01160201 \
helpcontent2/source/text/shared/optionen/BasicIDE \
+ helpcontent2/source/text/shared/optionen/experimental \
helpcontent2/source/text/shared/optionen/java \
helpcontent2/source/text/shared/optionen/javaclasspath \
helpcontent2/source/text/shared/optionen/javaparameters \
diff --git a/source/text/sbasic/shared/01030000.xhp b/source/text/sbasic/shared/01030000.xhp
index a231d8c..8ff95c2 100644
--- a/source/text/sbasic/shared/01030000.xhp
+++ b/source/text/sbasic/shared/01030000.xhp
@@ -18,7 +18,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">
<meta>
<topic id="textsbasicshared01030000xml" indexer="include" status="PUBLISH">
@@ -42,5 +42,6 @@
<embed href="text/sbasic/shared/01030400.xhp#anlegenverwalten"/>
<embed href="text/sbasic/shared/01030200.xhp#basiceditor"/>
<embed href="text/sbasic/shared/01030300.xhp#basicfehler"/>
+<embed href="text/sbasic/shared/BasicIDE.xhp#basicide"/>
</body>
</helpdocument>
diff --git a/source/text/sbasic/shared/code-stubs.xhp b/source/text/sbasic/shared/code-stubs.xhp
new file mode 100644
index 0000000..469c2d9
--- /dev/null
+++ b/source/text/sbasic/shared/code-stubs.xhp
@@ -0,0 +1,46 @@
+<?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="topic_2507201510192393">
+ <title xml-lang="en-US" id="tit">BasicCodeStubs</title>
+ <filename>/text/sbasic/shared/code-stubs.xhp</filename>
+ </topic>
+</meta>
+<body>
+
+<section id="BasicIDEOption01">
+ <bascode>
+ <paragraph id="hd_id1000010" role="bascode" xml-lang="en-US" localize="false">Dim aPicker As com.sun.star.ui.dialogs.XfilePicker</paragraph>
+ </bascode>
+</section>
+<section id="BasicIDEOption02">
+ <bascode>
+ <paragraph id="hd_id1000020" role="bascode" xml-lang="en-US" localize="false">aPicker.getDisplayDirectory()</paragraph>
+ </bascode>
+</section>
+<section id="BasicIDEOption03">
+ <bascode>
+ <paragraph id="hd_id1000030" role="bascode" xml-lang="en-US" localize="false">Dim intVar as Integer</paragraph>
+ </bascode>
+</section>
+</body>
+
+</helpdocument>
\ No newline at end of file
diff --git a/source/text/shared/00/00000406.xhp b/source/text/shared/00/00000406.xhp
index b83488e..4dd7eb7 100644
--- a/source/text/shared/00/00000406.xhp
+++ b/source/text/shared/00/00000406.xhp
@@ -202,7 +202,7 @@
</variable></paragraph>
<paragraph xml-lang="en-US" id="par_idN11C3F" role="paragraph" l10n="NEW"><variable id="opencl">Choose <emph><switchinline select="sys"><caseinline select="MAC">%PRODUCTNAME - Preferences</caseinline><defaultinline>Tools - Options</defaultinline></switchinline> - $[officename] - Open CL</emph>
</variable></paragraph>
- <paragraph xml-lang="en-US" id="par_idN11C3G" role="paragraph" l10n="NEW"><variable id="basicide">Choose <emph><switchinline select="sys"><caseinline select="MAC">%PRODUCTNAME - Preferences</caseinline><defaultinline>Tools - Options</defaultinline></switchinline> - $[officename] - Basic IDE</emph>
+ <paragraph xml-lang="en-US" id="par_idN11C3G" role="paragraph" l10n="NEW"><variable id="basicide">Choose <emph><switchinline select="sys"><caseinline select="MAC">%PRODUCTNAME - Preferences</caseinline><defaultinline>Tools - Options</defaultinline></switchinline> - $[officename] - Basic IDE Options</emph>
</variable></paragraph>
<paragraph xml-lang="en-US" id="par_id5485702" role="paragraph" l10n="NEW"><variable id="online_update">Choose <emph><switchinline select="sys"><caseinline select="MAC">%PRODUCTNAME - Preferences</caseinline><defaultinline>Tools - Options</defaultinline></switchinline> - $[officename] - Online Update </emph>
</variable></paragraph>
diff --git a/source/text/shared/need_help.xhp b/source/text/shared/need_help.xhp
index 414d5fc..8788bf4 100644
--- a/source/text/shared/need_help.xhp
+++ b/source/text/shared/need_help.xhp
@@ -1,31 +1,36 @@
-<?xml version="1.0"?>
+<?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 .
-****************************************************************-->
+<!--
+ * 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="topic_0506201512363995">
-<title xml-lang="en-US" id="tit">Need Help</title>
-<filename>/text/need_help.xhp</filename>
-</topic>
+ <topic id="topic_2507201510192393">
+ <title xml-lang="en-US" id="tit">Need Help</title>
+ <filename>/text/shared/need_help.xhp</filename>
+ </topic>
</meta>
+
<body>
+
+
<section id="needhelp">
<paragraph id="hd_id1000010" role="warning" xml-lang="en-US">This help page needs further work for correctness and completion. Please help LibreOffice project to write the missing information. Join the LibreOffice community.</paragraph>
</section>
</body>
+
</helpdocument>
\ No newline at end of file
diff --git a/source/text/shared/optionen/BasicIDE.xhp b/source/text/shared/optionen/BasicIDE.xhp
index b156ab0..a4b4e91 100644
--- a/source/text/shared/optionen/BasicIDE.xhp
+++ b/source/text/shared/optionen/BasicIDE.xhp
@@ -1,4 +1,4 @@
-<?xml version="1.0"?>
+<?xml version="1.0" encoding="UTF-8"?>
<helpdocument version="1.0">
<!--
* This file is part of the LibreOffice project.
@@ -19,23 +19,73 @@
-->
<meta>
-<topic id="topic_2015201522062086" indexer="include" status="PUBLISH">
-<title xml-lang="en-US" id="tit_basicide">Open CL</title>
-<filename>/text/shared/optionen/BasicIDE.xhp</filename>
-</topic>
+ <topic id="topic_2607201514535161" indexer="include" status="PUBLISH">
+ <title xml-lang="en-US" id="tit_BasicIDE">Basic IDE Options</title>
+ <filename>/text/shared/optionen/BasicIDE.xhp</filename>
+ </topic>
</meta>
+
<body>
<section id="basicide">
<bookmark xml-lang="en-US" branch="hid/cui/ui/optbasicidepage/OptBasicIDEPage" id="bm_id6882839" localize="false"/>
<bookmark xml-lang="en-US" branch="index" id="bm_id4077578">
-<bookmark_value>Basic IDE;setting options</bookmark_value>
-<bookmark_value>setting options;Basic IDE</bookmark_value>
+ <bookmark_value>Basic IDE options;Autocorrection</bookmark_value>
+ <bookmark_value>Basic IDE options;Autocompletion</bookmark_value>
+ <bookmark_value>Basic IDE options;Autoclose quotes</bookmark_value>
+ <bookmark_value>Basic IDE options;Basic UNO extended types</bookmark_value>
+ <bookmark_value>Basic IDE options;Autoclose parenthesis</bookmark_value>
+ <bookmark_value>Basic IDE;options</bookmark_value>
+ <bookmark_value>options;Basic IDE</bookmark_value>
</bookmark>
-<paragraph id="par_idN10558" role="heading" xml-lang="en-US" level="1"><link href="text/shared/optionen/BasicIDE.xhp">Basic IDE</link></paragraph>
+<paragraph id="par_idN10558" role="heading" xml-lang="en-US" level="1"><link href="text/shared/optionen/BasicIDE.xhp">Basic IDE Options</link></paragraph>
<paragraph id="par_idN10568" role="paragraph" xml-lang="en-US">Defines the settings for the Basic IDE (Integrated Development Environment) to help edit macros in Basic.</paragraph>
-</section>
+</section><embed href="text/shared/optionen/experimental.xhp#experimental"/>
+
<section id="howtoget"><embed href="text/shared/00/00000406.xhp#basicide"/>
</section>
-<embed href="text/shared/need_help.xhp#needhelp"/>
+
+<paragraph id="hd_id2507201509433418" role="heading" xml-lang="en-US" level="2">Code Completion</paragraph>
+<paragraph id="par_id2607201514295746" role="paragraph" xml-lang="en-US">This feature helps the Basic programmer to complete the code, saves extensive typing and helps to reduce coding errors.</paragraph>
+
+<paragraph id="par_id2507201509433497" role="heading" xml-lang="en-US" level="3">Enable code completion</paragraph>
+<paragraph id="par_id2507201509570245" role="paragraph" xml-lang="en-US"><ahelp hid="cui/ui/optbasicidepage/codecomplete_enable">Display methods of a Basic object.</ahelp> Code completion will display the methods of a Basic object, provided the object is a UNO extended type. Its does not work on a generic <item type="literal">Object</item> or <item type="literal">Variant</item> Basic types.</paragraph>
+<paragraph id="par_id2507201516150454" role="paragraph" xml-lang="en-US">When a variable is a UNO interface or structure, a list box appears when pressing the dot after a variable's name (like <item type="literal">aVar.</item> [list box appears] ). Its methods and variables are listed in the list box, displayed just below. You can navigate between the suggested methods and variables with the arrow keys. To insert the selected entry, press the <item type="keycode">Enter</item> key or double click on it with the mouse. To cancel the list box, press the <item type="keycode">Esc</item> key.</paragraph>
+<paragraph id="par_id2507201516150494" role="paragraph" xml-lang="en-US">When typing the method's name, and pressing the <item type="keycode">Tab</item> key once, it will complete the selected entry, pressing the Tab key again will cycle through the matches with the longest prefix. For example, when <item type="literal">aVar.aMeth</item> is typed, it will cycle through <item type="literal">aMeth1, aMethod2, aMethod3</item> entries, and other entries are not hidden.</paragraph>
+<paragraph id="par_id2507201516150482" role="paragraph" xml-lang="en-US">Example:</paragraph>
+<embed href="text/sbasic/shared/code-stubs.xhp#BasicIDEOption01"/>
+<paragraph id="par_id2507201516150420" role="paragraph" xml-lang="en-US">is a valid variable definition, its methods can be accessed via the dot (".") operator:</paragraph>
+<embed href="text/sbasic/shared/code-stubs.xhp#BasicIDEOption02"/>
+<paragraph id="hd_id2507201509433468" role="heading" xml-lang="en-US" level="2">Code Suggestion</paragraph>
+<paragraph id="par_id250720150943346" role="paragraph" xml-lang="en-US">These are coding helpers for the Basic programmer.</paragraph>
+
+<paragraph id="hd_id2507201510011472" role="heading" xml-lang="en-US" level="3">Autocorrection</paragraph>
+
+<paragraph id="par_id2507201509570353" role="paragraph" xml-lang="en-US"><ahelp hid="cui/ui/optbasicidepage/autocorrect">Correct cases of Basic variables and keywords while typing.</ahelp> %PRODUCTNAME Basic IDE will modify the typing of Basic statements and Basic variables of your code to improve coding style and readability. Modifications of the code are based on the program's variables declarations and on the %PRODUCTNAME Basic commands parsed.</paragraph>
+<paragraph id="par_id2507201516150496" role="paragraph" xml-lang="en-US">Example: </paragraph>
+<embed href="text/sbasic/shared/code-stubs.xhp#BasicIDEOption03"/>
+<paragraph id="par_id2507201516150498" role="paragraph" xml-lang="en-US">and when writing <item type="literal">Intvar</item>, will be corrected to <item type="literal">intVar</item> to match the case existing in the declaration of <item type="literal">intVar</item> .</paragraph>
+<paragraph id="par_id2507201516150461" role="paragraph" xml-lang="en-US">Basic keywords are also automatically corrected (the list of the keywords is grabbed out from the parser).</paragraph>
+<paragraph id="par_id2507201516150462" role="paragraph" xml-lang="en-US">Examples: </paragraph>
+<paragraph id="par_id2507201516144117" role="code" xml-lang="en-US" localize="false">Integer, String, ReDim, ElseIf, etc...</paragraph>
+
+<paragraph id="hd_id2507201509433473" role="heading" xml-lang="en-US" level="3">Autoclose quotes</paragraph>
+<paragraph id="par_id2507201509433451" role="paragraph" xml-lang="en-US"><ahelp hid="cui/ui/optbasicidepage/autoclose_quotes">Automatically close open quotes.</ahelp> %PRODUCTNAME Basic IDE will add a closing quote each time you type an opening quote. Handy for inserting strings in the Basic code.</paragraph>
+
+<paragraph id="hd_id250720150943348" role="heading" xml-lang="en-US" level="3">Autoclose parenthesis</paragraph>
+<paragraph id="par_id2507201509433483" role="paragraph" xml-lang="en-US"><ahelp hid="cui/ui/optbasicidepage/autoclose_paren">Automatically close open parenthesis.</ahelp> %PRODUCTNAME Basic IDE will add a closing parenthesis “)” each time you type an opening parenthesis “(“.</paragraph>
+
+<paragraph id="hd_id2507201509433489" role="heading" xml-lang="en-US" level="3">Autoclose procedures</paragraph>
+<paragraph id="par_id2507201509433461" role="paragraph" xml-lang="en-US"><ahelp hid="cui/ui/optbasicidepage/autoclose_proc">Automatically insert closing statements for procedures.</ahelp> %PRODUCTNAME Basic IDE will add a statement <item type="literal">End Sub</item> or <item type="literal">End Function</item> after you type a <item type="literal">Sub</item> or <item type="literal">Function</item> statement and press <item type="keycode">Enter</item>.</paragraph>
+
+<paragraph id="hd_id2507201509433412" role="heading" xml-lang="en-US" level="2">Language Features</paragraph>
+
+<paragraph id="hd_id2507201509433456" role="heading" xml-lang="en-US" level="3">Use extended types</paragraph>
+<paragraph id="par_id2507201516150463" role="paragraph" xml-lang="en-US"><ahelp hid="cui/ui/optbasicidepage/extendedtypes_enable">Allow UNO object types as valid Basic types.</ahelp> This feature extend the Basic programming language standard types with the %PRODUCTNAME UNO types. This allows the programmer to define variables with the right UNO type and is necessary for the code completion feature.</paragraph>
+<paragraph id="par_id2507201516150422" role="warning" xml-lang="en-US">The use of UNO Extended Types in Basic programs can restrain interoperability of the program when executed in other office suites.</paragraph>
+
+<section id="relatedtopics">
+<paragraph id="par_id250720151836489" role="paragraph" xml-lang="en-US"><link href="text/sbasic/shared/01030100.xhp">Basic IDE</link></paragraph>
+</section>
</body>
+
</helpdocument>
\ No newline at end of file
diff --git a/source/text/shared/optionen/experimental.xhp b/source/text/shared/optionen/experimental.xhp
new file mode 100644
index 0000000..83caaeb
--- /dev/null
+++ b/source/text/shared/optionen/experimental.xhp
@@ -0,0 +1,36 @@
+<?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="topic_2507201510234246">
+ <title xml-lang="en-US" id="tit">Need Help</title>
+ <filename>text/shared/optionen/experimental.xhp</filename>
+ </topic>
+</meta>
+
+<body>
+
+
+<section id="experimental">
+<paragraph id="hd_id1000010" role="warning" xml-lang="en-US">This feature is experimental and may produce errors or behave unexpectedly. To enable it anyway, <variable id="exptal">choose <emph><switchinline select="sys"><caseinline select="MAC">%PRODUCTNAME - Preferences</caseinline><defaultinline>Tools - Options</defaultinline></switchinline> - %PRODUCTNAME - Advanced</emph> and select <emph>Enable experimental features</emph> checkbox.</variable></paragraph>
+</section>
+</body>
+
+</helpdocument>
\ No newline at end of file
More information about the Libreoffice-commits
mailing list