|
| 1 | +##### |
| 2 | + |
| 3 | +# Changelog |
| 4 | + |
| 5 | +All notable changes to "Au3LibreOffice" SDK/API will be documented in this file. |
| 6 | + |
| 7 | +The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/), |
| 8 | +This project also adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). |
| 9 | + |
| 10 | +Go to [legend](#legend---types-of-changes) for further information about the types of changes. |
| 11 | + |
| 12 | +## [0.9.0] - 2023-10-28 |
| 13 | + |
| 14 | +**LibreOfficeWriter** |
| 15 | +### Added |
| 16 | + |
| 17 | +- directive for Au3Check to each UDF file branch. (@mLipok) |
| 18 | +- Image functions. (@donnyh13) |
| 19 | + - _ImageAreaColor, |
| 20 | + - _ImageAreaGradient, |
| 21 | + - _ImageAreaTransparency, |
| 22 | + - _ImageAreaTransparencyGradient, |
| 23 | + - _ImageBorderColor, |
| 24 | + - _ImageBorderPadding, |
| 25 | + - _ImageBorderStyle, |
| 26 | + - _ImageBorderWidth, |
| 27 | + - _ImageColorAdjust, |
| 28 | + - _ImageCrop, |
| 29 | + - _ImageDelete, |
| 30 | + - _ImageGetAnchor, |
| 31 | + - _ImageGetObjByName, |
| 32 | + - _ImageHyperlink, |
| 33 | + - _ImageInsert, |
| 34 | + - _ImageModify, |
| 35 | + - _ImageOptions, |
| 36 | + - _ImageOptionsName, |
| 37 | + - _ImageReplace, |
| 38 | + - _ImagesGetNames, |
| 39 | + - _ImageShadow, |
| 40 | + - _ImageSize, |
| 41 | + - _ImageTransparency, |
| 42 | + - _ImageTypePosition, |
| 43 | + - _ImageTypeSize, |
| 44 | + - _ImageWrap, |
| 45 | + - _ImageWrapOptions |
| 46 | + |
| 47 | +### Changed |
| 48 | + |
| 49 | +- Original LibreOffice UDF file split into individual elements, per specific usages. (@mLipok.) |
| 50 | + - LibreOfficeWriter_Cell, |
| 51 | + - LibreOfficeWriter_Char, |
| 52 | + - LibreOfficeWriter_Constants, |
| 53 | + - LibreOfficeWriter_Cursor, |
| 54 | + - LibreOfficeWriter_DirectFormating, |
| 55 | + - LibreOfficeWriter_Doc, |
| 56 | + - LibreOfficeWriter_Field, |
| 57 | + - LibreOfficeWriter_Font, |
| 58 | + - LibreOfficeWriter_FootEndNotes, |
| 59 | + - LibreOfficeWriter_Frame, |
| 60 | + - LibreOfficeWriter_Helper, |
| 61 | + - LibreOfficeWriter_Images, |
| 62 | + - LibreOfficeWriter_Internal, |
| 63 | + - LibreOfficeWriter_Num, |
| 64 | + - LibreOfficeWriter_Page, |
| 65 | + - LibreOfficeWriter_Par, |
| 66 | + - LibreOfficeWriter_Shapes, |
| 67 | + - LibreOfficeWriter_Table. |
| 68 | +- Renamed Constants: |
| 69 | + - $LOW_PAPER_PORTRAIT --> $LOW_PAPER_ORIENT_PORTRAIT |
| 70 | + - $LOW_PAPER_LANDSCAPE --> $LOW_PAPER_ORIENT_LANDSCAPE |
| 71 | +- Examples layout and error checking cleaned up. (@mLipok.) |
| 72 | +- Examples now work from their separate folder. (@mLipok.) |
| 73 | +- Major editing of Header layout for every function. As well as several typo corrections and wordiness. (@mLipok) & (@donnyh13.) |
| 74 | +- Constants are now all located in the separate Constants files. (@mLipok.) |
| 75 | +- All files re-processed with TIDY. (@mLipok) |
| 76 | + |
| 77 | +### Fixed |
| 78 | + |
| 79 | +- Errors caused by residual function calls from filling in "Related" section of the header. (@mLipok.) |
| 80 | + - _LOWriter_DocFindAllInRange, |
| 81 | + - _LOWriter_DocGenPropTemplate. |
| 82 | + |
| 83 | +### Project |
| 84 | + |
| 85 | +- @mLipok and @donnyh13 began jointly working on this project. — Thanks to @mLipok for his tireless work cleaning up many things in this UDF. |
| 86 | +- All Constants descriptions are moved to the Constants file. (@donnyh13) |
| 87 | +- Added documentation and improved CHANGELOG.md. (@donnyh13) |
| 88 | +- Added bug_report.md. (@donnyh13) |
| 89 | +- Added feature_request.md. (@donnyh13) |
| 90 | +- Added PULL_REQUEST_TEMPLATE.md. (@donnyh13) |
| 91 | +- Added CODE_OF_CONDUCT.md (@donnyh13) |
| 92 | +- Added CONTRIBUTING.md. (@donnyh13) |
| 93 | + |
| 94 | +Thanks @danp2 and @Sven-Seyfert. All above mentioned MD documents was based on adequate documents from https://github.com/Danp2/au3WebDriver. |
| 95 | + |
| 96 | +## [0.0.0.3] - 2023-08-10 |
| 97 | + |
| 98 | +**LibreOfficeWriter** |
| 99 | +### Added |
| 100 | + |
| 101 | +- Paragraph Object functions which allows the ability to copy and paste content without using the clipboard quickly. Thanks to user @Heiko for inspiration. |
| 102 | + - _ParObjSelect, |
| 103 | + - _ParObjCopy, |
| 104 | + - _ParObjPaste, |
| 105 | + - _ParObjDelete. |
| 106 | +- _DocExecuteDispatch function, adding some shortcuts to certain commands, such as select all, copy/paste content to/from clipboard. |
| 107 | +- _DocConvertTextToTable. |
| 108 | +- _DocConvertTableToText. |
| 109 | +- examples for the new functions. |
| 110 | +- "Related" functions section for most function headers. |
| 111 | +- Warning to _ShapesGetNames, about Images inserted in a document also being called "TextFrames". |
| 112 | +- processing error check. |
| 113 | + - _DocInsertString, |
| 114 | + - _DocInsertControlChar. |
| 115 | +- a missing Datatype for possible Cursor data position types, $LOW_CURDATA_HEADER_FOOTER, previously attempting to insert a content while the insertion point was located in a Header/Footer would have failed. — Thanks to user @Heiko for helping me locate this error. The affected functions are: |
| 116 | + - _CursorGetDataType. |
| 117 | + - _DocCreateTextCursor, |
| 118 | + - _EndnoteInsert, |
| 119 | + - _FootnoteInsert, |
| 120 | + - _TableInsert, |
| 121 | + |
| 122 | +### Changed |
| 123 | + |
| 124 | +- Renamed Name functions and examples for consistency. |
| 125 | + - _DocListTableNames --> _TablesGetNames |
| 126 | + - _FramesListNames --> _FramesGetNames |
| 127 | + - _ShapesListNames --> _ShapesGetNames |
| 128 | + - _ParGetObjects --> _ParObjCreateList. |
| 129 | + - _ParSectionsGet --> _ParObjSectionsGet. |
| 130 | + - _TableGetByCursor --> _TableGetObjByCursor. |
| 131 | + - _TableGetByName --> _TableGetObjByName. |
| 132 | + - _TableGetCellByCursor --> _TableGetCellObjByCursor. |
| 133 | + - _TableGetCellByName --> _TableGetCellObjByName. |
| 134 | + - _TableGetCellByPosition --> _TableGetCellObjByPosition. |
| 135 | +- Removed "IsCollpased" check and error from _DocGetString. |
| 136 | +- _FramesListNames to have an option to search for Frames listed under shapes. |
| 137 | +- _ShapesGetNames, Corrected an error that could occur if images are present. |
| 138 | + |
| 139 | +### Fixed |
| 140 | + |
| 141 | +- An error where a COM error would be produced when attempting to insert a string or control character in certain data types. — Thanks to user @Heiko for helping me locate this error. |
| 142 | + - _DocInsertControlChar, |
| 143 | + - _DocInsertString. |
| 144 | + |
| 145 | +## [0.0.0.2] - 2023-07-16 |
| 146 | + |
| 147 | +**LibreOfficeWriter** |
| 148 | +### Added |
| 149 | + |
| 150 | +- UDF version number in the UDF Header. |
| 151 | + |
| 152 | +### Changed |
| 153 | + |
| 154 | +- _DocReplaceAllInRange to have two methods of performing a Regular Expression find and replace. |
| 155 | +- Removed the if/else block in $atFindFormat parameter checking. |
| 156 | + - _DocReplaceAll, |
| 157 | + - _DocReplaceAllInRange, |
| 158 | + - _DocFindNext, |
| 159 | + - _DocFindAll, |
| 160 | + - _DocFindAllInRange. |
| 161 | + |
| 162 | +### Fixed |
| 163 | + |
| 164 | +- Method for skipping $atFindFormat and $atReplaceFormat, now uses an empty array called in each parameter to skip. |
| 165 | + - _DocReplaceAll, |
| 166 | + - _DocReplaceAllInRange. |
| 167 | + |
| 168 | +### Project |
| 169 | + |
| 170 | +- Updated function documentation to reflect the changes. |
| 171 | + |
| 172 | +## [0.0.0.1] - 2023-07-02 |
| 173 | + |
| 174 | +**LibreOfficeWriter** |
| 175 | +### Added |
| 176 | + |
| 177 | +- Initial UDF Release. |
| 178 | + |
| 179 | +--- |
| 180 | + |
| 181 | +[Unreleased]: https://github.com/mlipok/Au3LibreOffice/compare/v1.0.0...v0.0.0.3 |
| 182 | +[0.0.0.3]: https://github.com/mlipok/Au3LibreOffice/releases/tag/v0.0.0.3 |
| 183 | + |
| 184 | +### Legend - Types of changes |
| 185 | + |
| 186 | +- `Added` for new features. |
| 187 | +- `Changed` for changes in existing functionality. |
| 188 | +- `Deprecated` for soon-to-be removed features. |
| 189 | +- `Fixed` for any bug fixes. |
| 190 | +- `Removed` for now removed features. |
| 191 | +- `Security` in case of vulnerabilities. |
| 192 | +- `Project` for documentation or overall project improvements. |
| 193 | + |
| 194 | +## |
| 195 | + |
| 196 | +[To the top](#) |
0 commit comments