Bug 135175 - Documentation of Styles Inspector missing
Summary: Documentation of Styles Inspector missing
Status: VERIFIED FIXED
Alias: None
Product: LibreOffice
Classification: Unclassified
Component: Documentation (show other bugs)
Version:
(earliest affected)
unspecified
Hardware: All All
: medium normal
Assignee: Not Assigned
URL:
Whiteboard: target:7.4.0
Keywords:
Depends on:
Blocks: Style-Inspector
  Show dependency treegraph
 
Reported: 2020-07-27 08:28 UTC by Heiko Tietze
Modified: 2022-01-08 11:03 UTC (History)
6 users (show)

See Also:
Crash report or crash signature:


Attachments
Documentation as per 2020-08-25 07:13 UTC (184.71 KB, application/vnd.oasis.opendocument.text)
2021-02-12 08:25 UTC, Mike Kaganski
Details

Note You need to log in before you can comment on or make changes to this bug.
Description Heiko Tietze 2020-07-27 08:28:25 UTC
Purpose and how to read the information should be documented. Ideally also with a note on hierarchical organization of styles and how it's applied (PS1 < PSx < CS < DF).
Comment 1 Shivam Kumar Singh 2020-07-29 17:51:41 UTC
This should be done at last, after all other Inspector related bugs are fixed, right?
Comment 2 Mike Kaganski 2020-07-29 18:00:24 UTC
(In reply to Shivam Kumar Singh from comment #1)

Yes, given that changing implementation will make problems to keep documentation in sync.
Comment 3 Xisco Faulí 2021-02-09 14:26:11 UTC
Dear Shivam Kumar Singh,
This bug has been in ASSIGNED status for more than 3 months without any
activity. Resetting it to NEW.
Please assign it back to yourself if you're still working on this.
Comment 4 Shivam Kumar Singh 2021-02-09 14:31:20 UTC
I had sent a documentation about the Inspector earlier which had adequate information about the basic use and features of the SI, I was unsure if that was enough or do we need to work on another detailed doc(talking more about category of the properties and all...). Maybe Heiko or Mike can comment on this?
Comment 5 Heiko Tietze 2021-02-10 08:31:23 UTC
I vaguely remember a wiki site. What/where was it, Shivam?

@Olivier, Seth: Documentation is your field of interest. Adding you for decision what we need.
Comment 6 Shivam Kumar Singh 2021-02-11 16:08:35 UTC
(In reply to Heiko Tietze from comment #5)
> I vaguely remember a wiki site. What/where was it, Shivam?
> 

That was more of an substitute for that time period. I had sent it as a mail to documentation@libreoffice.org and you on 25th August 2020, if you could check.
Comment 7 Heiko Tietze 2021-02-12 08:19:06 UTC
(In reply to Shivam Kumar Singh from comment #6)
> I had sent it as a mail...

Sorry, cannot find this message. Please resend.
Comment 8 Heiko Tietze 2021-02-12 08:19:29 UTC
(In reply to Heiko Tietze from comment #7)
> Please resend.

Or rather attach to this ticket.
Comment 9 Mike Kaganski 2021-02-12 08:25:08 UTC
Created attachment 169701 [details]
Documentation as per 2020-08-25 07:13 UTC

Supposedly this one?
Comment 10 Jean Weber 2021-05-17 04:54:19 UTC
I added a short section about the Style Inspector in Chapter 9 (Working with Styles) of the Writer Guide 7.1, which was published in April 2021. I did not include much detail, as I did not think it necessary there.
I have also put the same section in the draft Chapter 3 (Styles and Templates) for Getting Started 7.1, which is in development.
Comment 11 Heiko Tietze 2021-05-17 08:49:07 UTC
(In reply to Jean Weber from comment #10)
> I added a short section about the Style Inspector in Chapter 9...

Thanks for your work, seems you talk about this paragraph:
"The Style Inspector (Figure 224) is located on the Sidebar. It displays all the attributes of the styles (paragraph and character) and any direct formatting present in the paragraph or word where the cursor is located."

I miss information about the hierarchy. If you use "My Text Body" it is derived from "Text Body" that has "Default PS" as parent. The list shows modified attributes, and greys out those at the parent. Happens also when CS or DF affects the PS. Items (nodes) with more than 20 items are collapsed.
And I'd also expect some tips how the Styles Inspector is supposed to work.
Comment 12 Commit Notification 2022-01-06 10:31:42 UTC
Olivier Hallot committed a patch related to this issue.
It has been pushed to "master":

https://git.libreoffice.org/help/commit/9bcc5f53bd012afc91b7c86cd0779d179f93ab71

tdf#135175 Styles Inspector Help page
Comment 13 Dieter 2022-01-08 11:03:42 UTC
VERIFIED, see https://help.libreoffice.org/7.4/en-GB/text/swriter/01/style_inspector.html?&DbPAR=WRITER&System=WIN

Olivier, thank you for fixing it!