docs: expand the write/fill pages and replace their screenshots with grids - #979
Open
nkuprins wants to merge 14 commits into
Open
docs: expand the write/fill pages and replace their screenshots with grids#979nkuprins wants to merge 14 commits into
nkuprins wants to merge 14 commits into
Conversation
Replaces the PNG screenshots of template and result spreadsheets with semantic HTML tables styled via a new .xl-sheet ruleset, so the examples are selectable, searchable and theme-aware instead of fixed-size images. Also swaps sample data placeholders to locale-neutral names in the English docs.
Contributor
Author
|
This is intentionally a draft because I still have to polish and reverify... But the core part is already done. |
bengbengbalabalabeng
added
the
PR: developing
The .xl-sheet rules leave custom.css for src/css/xl-sheet.css, registered as a second customCss entry. Geometry is expressed in Excel's own units and classes are named after the spreadsheet value they render (xl-fill-red, xl-fs-20). Adds styles for pictures, comment and dropdown overlays, and sheet tabs.
Each grid keeps its first and last data rows with an ellipsis row between, and uses the value-named style classes.
Adds a table of the {name}, {.name}, {list.name} and escaped forms with what
fills each, plus notes on mixing placeholders with text and on unfilled
placeholders being cleared. Result grids are shortened.
Drops the trailing empty column and the repeated data rows.
The strategy example now uses a three-level header where names repeat in both directions, with one grid per strategy, and explains why AUTO leaves a vertical merge below the first header row unmerged.
Adds a table mapping each field type to its converter, notes that a picture is stretched to its cell, and documents the multi-image WriteCellData form. The result screenshots become grids drawing a sample SVG.
Documents that includeColumnFieldNames follows the POJO field order unless orderByIncludeColumn is set, and that @ExcelProperty index is an absolute position, so a skipped index leaves an empty column. Also fixes the includeColumnFiledNames typo and the Java 9 Set.of call.
The grids now carry the sheet tabs they produce, so the single-sheet, multi- sheet and table results are told apart, with a line on what each writes.
Shows what the three approaches write. The Chinese page also switches its sample data to 字符串, matching write/merge.
The comment and dropdown results are drawn open in the grid, and the dropdown handler gains the usage snippet that registers it.
The 19 PNGs under static/img/docs/write are no longer referenced by any page.
nkuprins
changed the title
Includes listFill_file.png, which only appears as a path inside a code sample in the contribute-doc guide and is not loaded by any page.
nkuprins
marked this pull request as ready for review
July 31, 2026 23:43
bengbengbalabalabeng
removed
the
PR: developing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Purpose of the pull request
Closed: #978
What's changed?
Screenshots in the
write/andfill/docs become HTML grids styled bywebsite/src/css/xl-sheet.css.In general, some screenshots were not aligned with the code and vice versa. For example, Fill Multiple Lists Together, had
data1horizontal on the image, but the code never usedWriteDirectionEnum.HORIZONTAL. In that case, I updated the code snippet with the horizontal part. Where a page leaned on the screenshot for what the text never said, the explanation is added too.fill/fill.md{name}vs{.name}vs{list.name}, escaping, unsupplied placeholderswrite/image.mdWriteCellData,UrlImageConverterfetch policywrite/head.mdwrite/pojo.mdincludeColumnFieldNamesordering,indexgaps; fixes a typo and a Java 9Set.ofcallwrite/sheet.mdWriteTablewrites its own headerwrite/extra.mdwrite/simple.mdwrite/style.md,write/format.md.xl-sheetrules moved out ofcustom.css; deletes the 31 replaced PNGsBrowsers
Verified in the latest Firefox, Brave, and Chrome
Chinese
I don't know Chinese - the
zh-cnpages mirror the English ones and are AI-translated, so please check the wording. I am sorry if I got something wrong there ❤️Checklist