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

tdf#121736 initial Help pages for Python scripts

Browse Source 
Work in progress, initial addition of help pages for python
scripts in LO.

Change-Id: Iee95b1340c821fdb08524fdedeca3817b0de1459
Reviewed-on: https://gerrit.libreoffice.org/64137
Tested-by: Jenkins
Reviewed-by: Olivier Hallot <olivier.hallot@libreoffice.org>
This commit is contained in:
Olivier Hallot
2018-11-27 22:10:50 -02:00
parent 6c2abb8601
commit 949606895b
7 changed files with 442 additions and 317 deletions
Download Patch File Download Diff File Expand all files Collapse all files

39
source/text/sbasic/python/main0000.xhp Normal file
View File

@ -0,0 +1,39 @@
<?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/.
*
-->
<meta>
<topic id="pythonmain0000" indexer="include" status="PUBLISH">
<title id="tit" xml-lang="en-US">Python Scripts</title>
<filename>/text/sbasic/python/main0000.xhp</filename>
</topic>
</meta>
<body>
<bookmark xml-lang="en-US" branch="index" id="bm_id491543348147708">
<bookmark_value>macros;Python scripts</bookmark_value>
<bookmark_value>Python;macros</bookmark_value>
</bookmark>
<paragraph id="hd_id3154232" role="heading" level="1" xml-lang="en-US"><link href="text/sbasic/python/main0000.xhp" name="$[officename] Python Scripts">%PRODUCTNAME Python Scripts Help</link></paragraph>
<section id="pythonalt">
<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"/>
<paragraph id="hd_id3146957" role="heading" level="3" xml-lang="en-US">Working with Python Scripts in %PRODUCTNAME.</paragraph>
<embed href="text/sbasic/python/python_ide.xhp#pythonideh1"/>
<embed href="text/sbasic/python/python_locations.xhp#pythonlocations1"/>
<paragraph role="paragraph" id="par_id551543347858350" xml-lang="en-US">Programming with Python Scripts
</paragraph>
<paragraph role="paragraph" id="par_id861543347870798" xml-lang="en-US">Creating a dialog</paragraph>
<paragraph role="paragraph" id="par_id71543347877088" xml-lang="en-US">Programming Examples</paragraph>
<embed href="text/swriter/main0000.xhp#helpabouthelp"/>
</body>
</helpdocument>

32
source/text/sbasic/python/python_ide.xhp Normal file
View File

@ -0,0 +1,32 @@
<?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/.
*
-->
<meta>
<topic id="pythonidesetup" indexer="include" status="PUBLISH">
<title id="tit" xml-lang="en-US">IDE for Python</title>
<filename>/text/sbasic/python/python_ide.xhp</filename>
</topic>
</meta>
<body>
<section id="pythonideheading">
<bookmark id="bm_id341543348965463" xml-lang="en-US" branch="hid/zzzz" localize="false"/>
<bookmark xml-lang="en-US" branch="index" id="bm_id761543349138561">
<bookmark_value>python;IDE - integrated development environment</bookmark_value>
<bookmark_value>python;editor</bookmark_value>
</bookmark>
<paragraph id="hd_id151543348965464" role="heading" level="1" xml-lang="en-US"><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></paragraph>
<paragraph id="par_id541543348965465" role="paragraph" xml-lang="en-US">Writing Python macros requires extra configuration steps in order set an IDE of choice.</paragraph>
</section>
<embed href="text/shared/need_help.xhp#needhelp"/>
<paragraph role="paragraph" id="par_id341543353455014" xml-lang="en-US">Unlike Basic language macros development in %PRODUCTNAME, writing Python macros requires extra configuration steps in order to build your IDE of choice. In return you are provided with flexible design experience built upon your Python developing preferences or habits. Hereafter are IDE setup guidelines that range from beginner to advanced user.</paragraph>
</body>
</helpdocument>

29
source/text/sbasic/python/python_locations.xhp Normal file
View File

@ -0,0 +1,29 @@
<?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/.
*
-->
<meta>
<topic id="pythonlocations" indexer="include" status="PUBLISH">
<title id="tit" xml-lang="en-US">Location of Python Scripts</title>
<filename>/text/sbasic/python/python_locations.xhp</filename>
</topic>
</meta>
<body>
<section id="pythonlocation">
<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">Location of Python scripts</link></variable></paragraph>
<paragraph id="par_id771543358231022" role="paragraph" xml-lang="en-US">The Python script files are simply stored within the file system.</paragraph>
</section>
<embed href="text/shared/need_help.xhp#needhelp"/>
<paragraph role="heading" level="2" id="par_id591543360063141" xml-lang="en-US">%PRODUCTNAME installation share</paragraph>
<paragraph role="heading" level="2" id="par_id251543360075956" xml-lang="en-US">%PRODUCTNAME user profile</paragraph>
<paragraph role="heading" level="2" id="par_id671543360098182" xml-lang="en-US">Embedded in the document</paragraph>
</body>
</helpdocument>