wangxin/help
1
0
Fork 0
forked from amazingfate/help
Code Pull Requests Activity

Python: improve navigation between Help pages

Browse Source 
add links between python pages
add links from Contents section

Change-Id: Ifc6704862c8213008eeb5d6e6baf86aa7c7be50b
Reviewed-on: https://gerrit.libreoffice.org/67778
Tested-by: Jenkins
Reviewed-by: Olivier Hallot <olivier.hallot@libreoffice.org>
This commit is contained in:
Olivier Hallot
2019-02-13 12:28:01 -02:00
parent 675b040e84
commit 5f787a1f2d
9 changed files with 18 additions and 9 deletions
Download Patch File Download Diff File Expand all files Collapse all files

3
source/text/sbasic/python/main0000.xhp
View File

@ -26,15 +26,14 @@
<paragraph id="par_id3153894" role="paragraph" xml-lang="en-US">%PRODUCTNAME provides an Application Programming Interface (API) that allows controlling the $[officename] components with different programming languages by using the $[officename] Software Development Kit (SDK). For more information about the $[officename] API and the Software Development Kit, visit <link href="https://api.libreoffice.org/" name="api.libreoffice.org">https://api.libreoffice.org</link></paragraph>
<paragraph id="par_id3147226" role="paragraph" xml-lang="en-US">This help section explains the most common Python script functions for %PRODUCTNAME. For more in-depth information please refer to the <link href="https://wiki.documentfoundation.org/Macros/Python_Design_Guide" name="wiki.documentfoundation.org PYTHON Guide">Designing &amp; Developing Python Applications</link> on the Wiki.</paragraph>
</section>
<embed href="text/shared/need_help.xhp#needhelp"/>
<h2 id="hd_id3146957">Working with Python Scripts in %PRODUCTNAME</h2>
<paragraph role="paragraph" id="N0102">You can execute Python scripts choosing <menuitem>Tools - Macros - Run Macro</menuitem>. Editing scripts can be done with your preferred text editor. Python scripts are present in various locations detailed hereafter. You can refer to Programming examples for macros illustrating how to run the Python interactive console from %PRODUCTNAME.</paragraph>
<embed href="text/sbasic/python/python_ide.xhp#pythonideh1"/>
<embed href="text/sbasic/python/python_locations.xhp#pythonlocations1"/>
<embed href="text/sbasic/python/python_shell.xhp#pythonshell1"/>
<embed href="text/sbasic/python/python_programming.xhp#pythonprogrammingheading"/>
<paragraph role="paragraph" id="par_id861543347870798" xml-lang="en-US">Creating a dialog</paragraph>
<embed href="text/sbasic/python/python_examples.xhp#pythonexamples2"/>
<embed href="text/swriter/main0000.xhp#helpabouthelp"/>
</body>
</helpdocument>

4
source/text/sbasic/python/python_examples.xhp
View File

@ -35,6 +35,8 @@
<embed href="text/sbasic/python/python_platform.xhp#pythonplatform"/>
<embed href="text/sbasic/python/python_import.xhp#pythonimporth1"/>
<embed href="text/sbasic/python/python_screen.xhp#ioscreen"/>
<embed href="text/sbasic/python/python_shell.xhp#pythonshell1"/>
<section id="relatedtopics">
<embed href="text/sbasic/python/main0000.xhp#pythonscriptshelp"/>
</section>
</body>
</helpdocument>

2
source/text/sbasic/python/python_ide.xhp
View File

@ -27,8 +27,6 @@
<h1 id="hd_id151543348965464"><variable id="pythonideh1"><link href="text/sbasic/python/python_ide.xhp" name="Python IDE Setup">Setting up an Integrated Development Environment (IDE) for Python</link></variable></h1>
<paragraph id="par_id541543348965465" role="paragraph" xml-lang="en-US">Writing Python macros requires extra configuration steps to set an IDE of choice.</paragraph>
</section>
<embed href="text/shared/need_help.xhp#needhelp"/>
<paragraph role="paragraph" id="N0106">Unlike Basic language macros development in %PRODUCTNAME, developing Python scripts for %PRODUCTNAME requires to configure an external Integrated Development Environment (IDE). Multiple IDEs are available that range from beginners to advanced Python coders. While using a Python IDE programmers benefit from numerous features such as syntax highlighting, code folding, class browsing, code completion, coding standard enforcement, test driven development, debugging, version control and many more. You can refer to <link href="https://wiki.documentfoundation.org/Macros/Python_Design_Guide" name ="external">Designing &amp; Developing Python Applications</link> on the Wiki for more in-depth information about the setup of a bridge between your IDE and a running instance %PRODUCTNAME.</paragraph>
<h2 id="hd_id761544698669786">The APSO Extension</h2>

1
source/text/sbasic/python/python_locations.xhp
View File

@ -20,7 +20,6 @@
<paragraph id="hd_id391543358231021" role="heading" level="1" xml-lang="en-US"><variable id="pythonlocations1"><link href="text/sbasic/python/python_locations.xhp" name="command_name">Python Scripts Organization and Location</link></variable></paragraph>
<paragraph id="par_id771543358231022" role="paragraph" xml-lang="en-US">The Python script files are stored in the filesystem, in folders controlled by %PRODUCTNAME. The macros can be started at installation, user or file level.</paragraph>
</section>
<embed href="text/shared/need_help.xhp#needhelp"/>
<h2 id="hd_id911544049584458">Python Script Locations</h2>
<h3 id="hd_id591544049572647">%PRODUCTNAME Macros container</h3>
<paragraph role="paragraph" id="par_id261544049064421">Existing macros in this location (container) were copied by the installation program and are available to every computer user, and any open document can access macros stored the container. You need administrative rights to store or edit macros here.</paragraph>

1
source/text/sbasic/python/python_platform.xhp
View File

@ -112,6 +112,7 @@
<link href="text/sbasic/python/python_from_basic.xhp">Basic to Python function calls</link>
</paragraph>-->
<embed href="text/sbasic/python/python_examples.xhp#pythonexamples2"/>
<embed href="text/sbasic/python/main0000.xhp#pythonscriptshelp"/>
</section>
</body>
</helpdocument>

5
source/text/sbasic/python/python_programming.xhp
View File

@ -296,8 +296,9 @@
</section>
<section id="relatedtopics">
<paragraph role="paragraph" id="N0321"><link href="text/sbasic/shared/uno_objects.xhp" name ="external">Basic UNO Objects, Functions and Services</link></paragraph>
<paragraph role="paragraph" id="N0322"><link href="text/sbasic/python/python_import.xhp" name ="external">Importing Modules</link></paragraph>
<paragraph role="paragraph" id="N0323"><link href="text/sbasic/python/python_screen.xhp" name ="external">Input/Output to Screen</link></paragraph>
<embed href="text/sbasic/python/python_import.xhp#pythonimporth1"/>
<embed href="text/sbasic/python/python_screen.xhp#ioscreen"/>
<embed href="text/sbasic/python/main0000.xhp#pythonscriptshelp"/>
</section>
</body>
</helpdocument>

1
source/text/sbasic/python/python_screen.xhp
View File

@ -99,6 +99,7 @@
</paragraph>
<embed href="text/sbasic/shared/03010000.xhp#BasicScreenIO"/>
<embed href="text/sbasic/python/python_examples.xhp#pythonexamples2"/>
<embed href="text/sbasic/python/main0000.xhp#pythonscriptshelp"/>
</section>
</body>
</helpdocument>

1
source/text/sbasic/python/python_shell.xhp
View File

@ -53,6 +53,7 @@
<image src="media/helpimg/python/python_shell.png" id="N0143"><alt id="N0144">Python Interactive Console</alt></image>
</paragraph>
<section id="relatedtopics">
<embed href="text/sbasic/python/python_examples.xhp#pythonexamples2"/>
<embed href="text/sbasic/python/main0000.xhp#pythonscriptshelp"/>
</section>
</body>