Commit Graph

79 Commits

Author SHA1 Message Date
9ae4ee41e4 Refactor help tree files
This patch applies "xmlling --format" to all *.tree files in helpcontent2/source/auxiliary.

The reason for this refactoring is that these files' indentation is very messy and it makes it harder to maintain and update the files. Also, the indentation used here relies on Tabs whereas XHP files use two blank spaces as indentation.

So this refactoring also applies 2 blank spaces as indentation to the tree files.

Change-Id: I54366d6efd011a09baf45c3b74c089bd9b0401f1
Reviewed-on: https://gerrit.libreoffice.org/c/help/+/125718
Tested-by: Jenkins
Reviewed-by: Olivier Hallot <olivier.hallot@libreoffice.org>
2021-11-24 14:33:42 +01:00
5ce3e1b6c3 Create PopupMenu service documentation
Change-Id: I511221e68e9504a5c9e5e6c00bb31047a6ccf11b
Reviewed-on: https://gerrit.libreoffice.org/c/help/+/124982
Tested-by: Jenkins
Reviewed-by: Rafael Lima <rafael.palma.lima@gmail.com>
2021-11-18 15:30:10 +01:00
3445df8b37 Create help page for SF_Chart service
Change-Id: Ie244e4416d2b523dfe460701297f6ecfc81f964d
Reviewed-on: https://gerrit.libreoffice.org/c/help/+/124195
Tested-by: Jenkins
Reviewed-by: Rafael Lima <rafael.palma.lima@gmail.com>
2021-10-29 22:41:46 +02:00
28499f409a tdf#145067 Document the Basic Collection object
Change-Id: I0ea7be144cca78b48ab3dfd07426ad679b07b26b
Reviewed-on: https://gerrit.libreoffice.org/c/help/+/123398
Tested-by: Jenkins
Reviewed-by: Alain Romedenne <alain.romedenne@libreoffice.org>
2021-10-14 19:52:24 +02:00
152530c436 Create documentation for Basic "New" operator
Change-Id: I11157f8db43811a107eb5270db5b39c351b37dcc
Reviewed-on: https://gerrit.libreoffice.org/c/help/+/123159
Tested-by: Jenkins
Reviewed-by: Olivier Hallot <olivier.hallot@libreoffice.org>
2021-10-11 02:05:24 +02:00
7f942a62c3 Create a guide on Calc macros on reading and writing cell values
This patch also creates a new entry in the Calc tree menu to store all pages about Calc macros. Currently there are only two, but in future patches new pages will be added.

Change-Id: Iac55c87d1159f4163ba3150e83160b4156d0d0f6
Reviewed-on: https://gerrit.libreoffice.org/c/help/+/122936
Tested-by: Jenkins
Reviewed-by: Rafael Lima <rafael.palma.lima@gmail.com>
2021-10-07 21:28:32 +02:00
82e70eb6ef tdf#143687 Document the "IS" Basic keyword
This patch also improves related help pages about the functions IsObject and EqualUnoObjects.

Change-Id: I5f16596ed057c1104d5fa2650299861741bd7b2e
Reviewed-on: https://gerrit.libreoffice.org/c/help/+/123153
Tested-by: Jenkins
Reviewed-by: Alain Romedenne <alain.romedenne@libreoffice.org>
2021-10-07 19:37:03 +02:00
62f7c4a827 SFDocuments.Writer new service - WiP
Change-Id: Ia3da307c224aaea53d6a0e2067a78db113119b50
Reviewed-on: https://gerrit.libreoffice.org/c/help/+/121770
Tested-by: Jenkins
Reviewed-by: Alain Romedenne <alain.romedenne@libreoffice.org>
2021-09-27 16:56:32 +02:00
9b8c44b49d Create guide about Calc macros to format cell borders
This patch is a follow-up to a previous revert:
https://gerrit.libreoffice.org/c/help/+/121554

This patch uses the correct path for the new file "calc_borders.xhp".

Change-Id: I4eb72db1ef8f5d964905be46dcb645dbd4e28e67
Reviewed-on: https://gerrit.libreoffice.org/c/help/+/121556
Tested-by: Jenkins
Reviewed-by: Olivier Hallot <olivier.hallot@libreoffice.org>
2021-09-03 17:50:08 +02:00
844431301f Revert "Create guide about Calc macros to format cell borders"
This reverts commit ce0d3ff57a732b1f89f88b5f0c4cbb22e0d050c3.

Reason for revert: new file in wrong position

Change-Id: Icebc9502ad250493c704d309eefeb388f6118c11
Reviewed-on: https://gerrit.libreoffice.org/c/help/+/121554
Tested-by: Jenkins
Reviewed-by: Olivier Hallot <olivier.hallot@libreoffice.org>
2021-09-03 14:09:43 +02:00
ce0d3ff57a Create guide about Calc macros to format cell borders
Change-Id: Ia7bbbf25322775e3a291fcb474079b2e2bc4e41e
Reviewed-on: https://gerrit.libreoffice.org/c/help/+/121461
Tested-by: Jenkins
Reviewed-by: Olivier Hallot <olivier.hallot@libreoffice.org>
2021-09-03 13:59:57 +02:00
0b7cde3aab Create help page for the Development Tools feature
Change-Id: Ib392399fa71c27ce6be7fca8c55985d75519ea87
Reviewed-on: https://gerrit.libreoffice.org/c/help/+/119855
Tested-by: Jenkins
Reviewed-by: Olivier Hallot <olivier.hallot@libreoffice.org>
2021-08-03 01:39:29 +02:00
ff452e27c1 ScriptForge method signatures
Change-Id: I5c29d5c08a8c5bd46ca45dc1d17449a0ae4789b8
Reviewed-on: https://gerrit.libreoffice.org/c/help/+/116910
Tested-by: Jenkins
Reviewed-by: Rafael Lima <rafael.palma.lima@gmail.com>
2021-06-21 19:32:01 +02:00
693c6bf5fa Add SF services to the Help tree
Change-Id: Ifbd98abbfde88ea293bd920cbcd0f12c8b399a91
Reviewed-on: https://gerrit.libreoffice.org/c/help/+/117131
Tested-by: Jenkins
Reviewed-by: Olivier Hallot <olivier.hallot@libreoffice.org>
2021-06-14 23:06:19 +02:00
9fffc3e09d ThisDatabaseDocument new help page
Change-Id: I9ad35913bbc5fef9208b3a9ea5eb9be01f882131
Reviewed-on: https://gerrit.libreoffice.org/c/help/+/116463
Tested-by: Jenkins
Reviewed-by: Rafael Lima <rafael.palma.lima@gmail.com>
2021-06-09 16:49:57 +02:00
68a8e252d2 tdf#124066 Help for VBA StrConv function
1) LCID codes linked to LibreOffice internal LCID file
2) Examples borrowed from QA tests

Change-Id: I1b00a1901f32de0243b518de39abd633ba08eadc
Reviewed-on: https://gerrit.libreoffice.org/c/help/+/116684
Tested-by: Jenkins
Reviewed-by: Olivier Hallot <olivier.hallot@libreoffice.org>
2021-06-07 19:36:15 +02:00
140f7c8bd3 Basic Toc cleanup - pt. 2
- reordering
- adding missing topics

Change-Id: Ie049e96f7849f2b96d56a189cdb163c089eb8fe8
Reviewed-on: https://gerrit.libreoffice.org/c/help/+/113644
Tested-by: Jenkins
Reviewed-by: Olivier Hallot <olivier.hallot@libreoffice.org>
2021-04-15 11:45:15 +02:00
f44cc1049d BASIC Toc cleanup
Relocated topics are
- Generating random numbers
- (deletion) Comparison operators
- Numeric functions
- Trigonometric functions
- Further statements

Change-Id: I2ed75e20f790273460be56fab62ad6cc6e357397
Reviewed-on: https://gerrit.libreoffice.org/c/help/+/113366
Tested-by: Jenkins
Reviewed-by: Olivier Hallot <olivier.hallot@libreoffice.org>
2021-04-01 19:43:52 +02:00
268d92a454 (ScriptForge) SFDialogs library sf_Dialog sf_control new pages
- sf_calc unmuting L10N

Change-Id: I3799952c29f21570e6faa81c5b1b27bc28786fb5
Reviewed-on: https://gerrit.libreoffice.org/c/help/+/109674
Tested-by: Jenkins
Reviewed-by: Olivier Hallot <olivier.hallot@libreoffice.org>
2021-02-03 23:37:42 +01:00
165f2eb082 ScriptForge library modules - WiP
- sf_array page restored after being overwritten
- self-links in both pages on H1 tag

Change-Id: I9c3d47447124d5c7199a03c9a7d76e0e337244ef
Reviewed-on: https://gerrit.libreoffice.org/c/help/+/107695
Tested-by: Jenkins
Reviewed-by: Olivier Hallot <olivier.hallot@libreoffice.org>
2020-12-17 13:53:39 +01:00
090116c279 tdf#134xxx DefErr syntax diagram
- toc update
- prefix dupe usage fixed - letter 'k'
- DefErr diagram

Change-Id: Ib3bd1b5907eae42b088d0b0b39d3e5f70dc0c43d
Reviewed-on: https://gerrit.libreoffice.org/c/help/+/103971
Tested-by: Jenkins
Reviewed-by: Olivier Hallot <olivier.hallot@libreoffice.org>
2020-10-09 18:02:44 +02:00
78dc9c1d05 tdf#131416 Basic Syntax Diagrams for Defxxx statements
- Basic language ref . toc additions
- Letter range option addition
- DefBool-based refactoring

Change-Id: I5744c63e9c21ad5ff2801cd03a119fd2c747fef3
Reviewed-on: https://gerrit.libreoffice.org/c/help/+/103056
Tested-by: Jenkins
Tested-by: Olivier Hallot <olivier.hallot@libreoffice.org>
Reviewed-by: Olivier Hallot <olivier.hallot@libreoffice.org>
2020-09-29 12:28:19 +02:00
5b2fdb324a tdf#136112 Date/Time are LibO Basic functions not statements
- Documenting Date/Date$, Time/Time$ as functions
- Date Time not be mentioned as statements in help

Change-Id: I828c4df92a2ae2347c8b057451ac7922eac896bf
Reviewed-on: https://gerrit.libreoffice.org/c/help/+/101954
Tested-by: Jenkins
Reviewed-by: Olivier Hallot <olivier.hallot@libreoffice.org>
2020-09-03 18:19:56 +02:00
290bab91da tdf#131416 How to read syntax diagrams
Change-Id: Ic8ec05c75658f600f5ea1509acb482cc3db5d796
Reviewed-on: https://gerrit.libreoffice.org/c/help/+/98343
Tested-by: Jenkins
Reviewed-by: Olivier Hallot <olivier.hallot@libreoffice.org>
2020-07-09 17:26:05 +02:00
b6f441acbe Basic advanced libraries brief descriptions
Change-Id: I4bdfd0983e52e8741b9082f0bc6dfa1a35b16510
Reviewed-on: https://gerrit.libreoffice.org/c/help/+/97582
Tested-by: Jenkins
Reviewed-by: Olivier Hallot <olivier.hallot@libreoffice.org>
2020-07-02 13:17:34 +02:00
fcf75206c5 Basic compiler/runtime options aggregation
- Base
- Explicit
- ClassModule
- Compatible
- Private Module
- VBASupport

Change-Id: If5edfe93a744d847bc387d868cbb26292b60ea0a
Reviewed-on: https://gerrit.libreoffice.org/c/help/+/96493
Tested-by: Jenkins
Reviewed-by: Olivier Hallot <olivier.hallot@libreoffice.org>
2020-06-17 23:57:21 +02:00
7af288d0fa tdf#134032 Calling Calc function from basic
Change-Id: I7c3c64e0df4d89b46e49afb869f3e2de0825a6e2
Reviewed-on: https://gerrit.libreoffice.org/c/help/+/96485
Tested-by: Jenkins
Reviewed-by: Olivier Hallot <olivier.hallot@libreoffice.org>
2020-06-17 13:38:36 +02:00
099f7cea6b tdf#131416 Syntax diagrams
- Erase: syntax + new examples + x-refs
- Managing flow of control: Do, If, While diagrams

- Basic Syntax Diagrams (WiP) cheatsheet:
  https://wiki.documentfoundation.org/User:LibreOfficiant/BasicSyntax

Change-Id: I68e03ccf8169d59e56f9a2e5b10b4bf09d8b217b
Reviewed-on: https://gerrit.libreoffice.org/c/help/+/93529
Tested-by: Jenkins
Reviewed-by: Olivier Hallot <olivier.hallot@libreoffice.org>
2020-05-11 02:00:00 +02:00
6522d1a261 tdf#131416 Syntax diagrams
- Print & Select Case statements
- GoSub,GoTo, On…GoSub/GoTo statements
  - section reuse + x-refs

Change-Id: I785d46013d7e8e9f571b2a2d2abaa3e2e41d223f
Reviewed-on: https://gerrit.libreoffice.org/c/help/+/93376
Tested-by: Jenkins
Reviewed-by: Olivier Hallot <olivier.hallot@libreoffice.org>
2020-05-05 19:59:53 +02:00
115422426e tdf#131416 Basic Subroutines help pages
- Function, Property & Sub statements
- Public, Private are keywords, Global removed from diagrams:
  -  Global=Public as Basic libraries remain in memory
- Basic toc & index

Change-Id: If107f4d148b4da399dd03d1b18ea3da5454bb9ac
Reviewed-on: https://gerrit.libreoffice.org/c/help/+/92784
Tested-by: Jenkins
Reviewed-by: Olivier Hallot <olivier.hallot@libreoffice.org>
2020-05-04 16:16:43 +02:00
82bb6643f1 Basic Table of content alphebetical ordering
Change-Id: I5e0d46bbbf64fe1b9296fc912e2492a7acd73af7
Reviewed-on: https://gerrit.libreoffice.org/c/help/+/92180
Tested-by: Jenkins
Reviewed-by: Olivier Hallot <olivier.hallot@libreoffice.org>
2020-04-15 19:40:54 +02:00
abb9f58751 tdf#129366 Resume statement new help page
its 3 available options are:
- 0
- label
- Next

+ associated examples in combination with On Error statement

To be rebased past #91709

Change-Id: I0986816580835bf9b2b2657ecdbdc06118b1ff9d
Reviewed-on: https://gerrit.libreoffice.org/c/help/+/91712
Tested-by: Olivier Hallot <olivier.hallot@libreoffice.org>
Reviewed-by: Olivier Hallot <olivier.hallot@libreoffice.org>
2020-04-09 19:46:44 +02:00
7bcd164e06 Variable insertions for future page embeds
"Relatedtopics" with x-refs to come after

Change-Id: Ic6d58f4e338ea2ddcbba7f063be9dafce34eb914
Reviewed-on: https://gerrit.libreoffice.org/c/help/+/91178
Tested-by: Jenkins
Reviewed-by: Olivier Hallot <olivier.hallot@libreoffice.org>
2020-04-09 00:51:22 +02:00
b6a60949a4 VBA Err object
- Handling exceptions or Throwing them w/ Basic

A limited set of VBA ERR object properties & methods are exhibiting useful features.
This page document that subset.

Change-Id: I98726a6ffbce370b81f1a26daa35a8a1bf3dc57c
Reviewed-on: https://gerrit.libreoffice.org/c/help/+/91177
Tested-by: Jenkins
Reviewed-by: Olivier Hallot <olivier.hallot@libreoffice.org>
2020-04-02 17:38:09 +02:00
2184ece0e3 Addition to Basic reference TOC
Change-Id: Icaea025c635127f5503270e071fab83f2760c480
Reviewed-on: https://gerrit.libreoffice.org/c/help/+/90278
Tested-by: Jenkins
Reviewed-by: Olivier Hallot <olivier.hallot@libreoffice.org>
2020-03-11 12:45:23 +01:00
9147d1fa9b sbasic.tree, uno_objects, ThisComponent better descriptions
Change-Id: Ie1778adf59317260cc0c9a1c1eb43ed2d66e7518
Reviewed-on: https://gerrit.libreoffice.org/81822
Tested-by: Jenkins
Reviewed-by: Olivier Hallot <olivier.hallot@libreoffice.org>
2019-10-31 10:58:33 +01:00
2ba8d7ab8a tdf#127716 Add GlobalScope object description
Also add BasicLibraries and DialogLibraries
Refactor page
Add entry in tree

Change-Id: I9754af4d98fc6267120c232e1ba366262534b3a7
Reviewed-on: https://gerrit.libreoffice.org/81803
Tested-by: Jenkins
Reviewed-by: Olivier Hallot <olivier.hallot@libreoffice.org>
2019-10-31 01:21:01 +01:00
aa272bf2b9 Fix links for basic_2_python page
Change-Id: I7ffd91ea10b22a5215a77be9639dd8d9c27c9ed0
Reviewed-on: https://gerrit.libreoffice.org/81509
Tested-by: Jenkins
Reviewed-by: Olivier Hallot <olivier.hallot@libreoffice.org>
2019-10-25 18:03:40 +02:00
6880ed4b73 Python dialog handler new topic
'Dialog Handler' new topic
bunch of x-ref between pages
make & toc

OH:
- fixed broken file path
- fixed broken links

Change-Id: I37e94fea48c394310298ff6f4b13f22c71c523c4
Reviewed-on: https://gerrit.libreoffice.org/76191
Tested-by: Jenkins
Reviewed-by: Olivier Hallot <olivier.hallot@libreoffice.org>
2019-07-26 13:30:28 +02:00
3d1c811073 Python to Basic Help page
- Python x Basic inter-language calls
- Dialog handlers with Basic or Python

Amend 1
- place page at right path
- inter-page link calls
- entry in Contents
- Some changes in passive voice, articles in text

Change-Id: I5bb54150f534486c092036a8ed4fa7cc38cc9ef0
Reviewed-on: https://gerrit.libreoffice.org/75057
Tested-by: Jenkins
Reviewed-by: Olivier Hallot <olivier.hallot@libreoffice.org>
2019-07-15 02:23:47 +02:00
e6dfe7b36e tdf#124066, tdf#114263 BASIC Replace function Help
with kind help of  Gerhard Weydt (tdf#124066)

Change-Id: I856c8ff600774bec82daafdef63ea8cca15b5097
Reviewed-on: https://gerrit.libreoffice.org/69255
Tested-by: Jenkins
Reviewed-by: Olivier Hallot <olivier.hallot@libreoffice.org>
2019-03-14 15:57:16 +01:00
5f787a1f2d Python: improve navigation between Help pages
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>
2019-02-14 13:21:02 +01:00
3f27275900 tdf#114263 Help page for Partition [VBA]
+ some hyperlinks and reordering of text in calssmodule
and compatible, option vba support.

Change-Id: Ic387086a5874989d22cf93caf0f3d0f48fd77a9e
Reviewed-on: https://gerrit.libreoffice.org/66910
Tested-by: Jenkins
Reviewed-by: Olivier Hallot <olivier.hallot@libreoffice.org>
2019-01-26 12:11:22 +01:00
441f600d21 tdf#114263 Undocumented BASIC Options
Option Compatible
Option ClassModule

Change-Id: Ieb07fddb216f4f8cc26089a30226da5760b0065e
Reviewed-on: https://gerrit.libreoffice.org/66824
Tested-by: Jenkins
Reviewed-by: Olivier Hallot <olivier.hallot@libreoffice.org>
2019-01-24 11:50:31 +01:00
afdcd47966 tdf#114263 Add info for BASIC Spc() function
Change-Id: Ic57ae1777e9e41c67a914b210b002f3ba89e678c
Reviewed-on: https://gerrit.libreoffice.org/65753
Tested-by: Jenkins
Reviewed-by: Olivier Hallot <olivier.hallot@libreoffice.org>
2018-12-30 23:38:57 +01:00
d7124af74a tdf#114263 Add Help page for BASIC Frac Function
Change-Id: Icc56a51597318d5c0683a2976b8d08f1b30ca49c
Reviewed-on: https://gerrit.libreoffice.org/65752
Tested-by: Jenkins
Reviewed-by: Olivier Hallot <olivier.hallot@libreoffice.org>
2018-12-30 23:20:51 +01:00
b1aec63bf0 tdf#114263 Help page for BASIC WaitUntil statement
Change-Id: I6ef145556a813f65ea509b146eadbf744b6f1fae
Reviewed-on: https://gerrit.libreoffice.org/65721
Tested-by: Jenkins
Reviewed-by: Olivier Hallot <olivier.hallot@libreoffice.org>
2018-12-30 18:56:34 +01:00
3f0f452519 StarDesktop object and reorder indexes
Add StarDesktop object description
Reorder "Other commands" to add UNO objects

Change-Id: Ia6547ea059276f8946b03392d29d968187bcd26c
Signed-off-by: Olivier Hallot <olivier.hallot@libreoffice.org>
Reviewed-on: https://gerrit.libreoffice.org/64981
Tested-by: Jenkins
2018-12-12 10:10:46 +01:00
93b7b1c8c7 Help pages for VBA Enum statement
Change-Id: I4f382453334aa964115d30d7e11e7d202d63a230
Reviewed-on: https://gerrit.libreoffice.org/64202
Tested-by: Jenkins
Reviewed-by: Olivier Hallot <olivier.hallot@libreoffice.org>
2018-11-29 21:41:15 +01:00
949606895b tdf#121736 initial Help pages for Python scripts
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>
2018-11-28 10:48:08 +01:00