Re: [libreoffice-documentation] How to for syntax highlighting code
Can you comment in terms of experience formatting code in the guide? I previously commented code colorization should be part of the style running any macro behind the scenes. It isn't (ie changing the template does nothing). If you look through the guides you'll see a lot of inconsistency from random processes. 1. Extension configuration is not specified anywhere 2. The code style does not color the text, it's done externally or maybe using this macro 3. The extension also styles text which can conflict with the documentation style 4. The hotkey description would be better replaced by a link. The whole process is pretty poor. On top of that, copy/paste doesn't work in pdf - https://listarchives.libreoffice.org/global/documentation/2022/msg00295.html On Wed, Mar 30, 2022 at 12:39 AM Dave Barton wrote: > Why has this unnecessary macro operation been added to chapter 2 of the > "Producing LibreOffice User Guides"? > We already have a perfectly good "Code" style in the 7.2x template. If > the docs team feel the style needs changing/improving then let's simply > agree on a revision of the template, not by adding more complexity to > documentation production. > -- To unsubscribe e-mail to: documentation+unsubscr...@global.libreoffice.org Problems? https://www.libreoffice.org/get-help/mailing-lists/how-to-unsubscribe/ Posting guidelines + more: https://wiki.documentfoundation.org/Netiquette List archive: https://listarchives.libreoffice.org/global/documentation/ Privacy Policy: https://www.documentfoundation.org/privacy
Re: [libreoffice-documentation] Long march towards accessibility
On 29/03/2022 11:55, Olivier Hallot wrote: > Hi Team > > LibreOffice has a tool to check some elements of accessibility (a11y) in > documents: > > Choose Tools - Accessibility check > > I ran the tool in a random chapter and found some issues, for example: > > - No alt text for graphic 'Image2' > - The text formatting conveys additional meaning. > - Text contrast is too low. > - Hyperlink text is the same as the link address > 'https://documentation.libreoffice.org/en/' > > It may be necessary to define a set of rules to address a11y in our > chapter. For example, a shorter caption text can serve as 'alt text' of > images. Other issues may demand for a change in formatting and contents > display (merged cells in tables). > > Let's run the tool in the chapters, within the review process, ensuring > we are in the way to turn our guides and other production accessible. > > More information on the Help page > https://help.libreoffice.org/master/en-US/text/swriter/01/accessibility_check.html?DbPAR=WRITER#bm_id551630942369429 > > > Cheers Hi Olivier, I would agree that we should pay more attention to a11y in our documentation. However, I feel the Accessibility Check tool needs additional work to raise it up to a more useable level. Just some rough basic examples: * I run the tool on some of my own documents and it shows headings for all possible issues in the document, not just those that actually do exist in the document and need consideration. Creating confusion for inexperienced users. * The dialog shows 2 instances of items where "The text formatting conveys additional meaning." is displayed, when the document actually has a total of 8 identical issues. * Clicking the "Go to issue" dialog button highlights a 1/2 special character, which tells the user absolutely nothing about the accessibility issue, IF ANY. I haven't yet checked Bugzilla, but I feel this needs to be drawn to the devs attention. You are probably aware that the "Help" button in the Accessibility Check dialog generates a 404 page error. Regards Dave -- To unsubscribe e-mail to: documentation+unsubscr...@global.libreoffice.org Problems? https://www.libreoffice.org/get-help/mailing-lists/how-to-unsubscribe/ Posting guidelines + more: https://wiki.documentfoundation.org/Netiquette List archive: https://listarchives.libreoffice.org/global/documentation/ Privacy Policy: https://www.documentfoundation.org/privacy
Re: [libreoffice-documentation] How to for syntax highlighting code
On 29/03/2022 13:52, flywire wrote: > Can someone confirm the process in: > https://wiki.documentfoundation.org/Documentation/DocumentationTeamInfo/ProducingLibreOfficeUserGuides#How_to_for_syntax_highlighting_code > > Issues: > * macro should just set colors without altering style > * red and green as the predominant colors is a poor choice for > https://en.wikipedia.org/wiki/Color_blindness > * keywords highlighted within function names is suspect > * inconsistent end of line characters > * random large text > * > https://listarchives.libreoffice.org/global/documentation/2022/msg00295.html > > There is better syntax highlighting code these days. Why has this unnecessary macro operation been added to chapter 2 of the "Producing LibreOffice User Guides"? We already have a perfectly good "Code" style in the 7.2x template. If the docs team feel the style needs changing/improving then let's simply agree on a revision of the template, not by adding more complexity to documentation production. -- To unsubscribe e-mail to: documentation+unsubscr...@global.libreoffice.org Problems? https://www.libreoffice.org/get-help/mailing-lists/how-to-unsubscribe/ Posting guidelines + more: https://wiki.documentfoundation.org/Netiquette List archive: https://listarchives.libreoffice.org/global/documentation/ Privacy Policy: https://www.documentfoundation.org/privacy
[libreoffice-documentation] How to for syntax highlighting code
Can someone confirm the process in: https://wiki.documentfoundation.org/Documentation/DocumentationTeamInfo/ProducingLibreOfficeUserGuides#How_to_for_syntax_highlighting_code Issues: * macro should just set colors without altering style * red and green as the predominant colors is a poor choice for https://en.wikipedia.org/wiki/Color_blindness * keywords highlighted within function names is suspect * inconsistent end of line characters * random large text * https://listarchives.libreoffice.org/global/documentation/2022/msg00295.html There is better syntax highlighting code these days. -- To unsubscribe e-mail to: documentation+unsubscr...@global.libreoffice.org Problems? https://www.libreoffice.org/get-help/mailing-lists/how-to-unsubscribe/ Posting guidelines + more: https://wiki.documentfoundation.org/Netiquette List archive: https://listarchives.libreoffice.org/global/documentation/ Privacy Policy: https://www.documentfoundation.org/privacy
[libreoffice-documentation] Long march towards accessibility
Hi Team LibreOffice has a tool to check some elements of accessibility (a11y) in documents: Choose Tools - Accessibility check I ran the tool in a random chapter and found some issues, for example: - No alt text for graphic 'Image2' - The text formatting conveys additional meaning. - Text contrast is too low. - Hyperlink text is the same as the link address 'https://documentation.libreoffice.org/en/' It may be necessary to define a set of rules to address a11y in our chapter. For example, a shorter caption text can serve as 'alt text' of images. Other issues may demand for a change in formatting and contents display (merged cells in tables). Let's run the tool in the chapters, within the review process, ensuring we are in the way to turn our guides and other production accessible. More information on the Help page https://help.libreoffice.org/master/en-US/text/swriter/01/accessibility_check.html?DbPAR=WRITER#bm_id551630942369429 Cheers -- Olivier Hallot LibreOffice Documentation Coordinator Rio de Janeiro - Brasil - Local Time: UTC-03:00 LibreOffice – free and open source office suite: https://www.libreoffice.org Respects your privacy, and gives you back control over your data http://tdf.io/joinus -- To unsubscribe e-mail to: documentation+unsubscr...@global.libreoffice.org Problems? https://www.libreoffice.org/get-help/mailing-lists/how-to-unsubscribe/ Posting guidelines + more: https://wiki.documentfoundation.org/Netiquette List archive: https://listarchives.libreoffice.org/global/documentation/ Privacy Policy: https://www.documentfoundation.org/privacy
[libreoffice-documentation] First review of IG7305-Managing-Graphic-Objects
I have given IG7305-Managing-Graphic-Objects a first review. Kees -- To unsubscribe e-mail to: documentation+unsubscr...@global.libreoffice.org Problems? https://www.libreoffice.org/get-help/mailing-lists/how-to-unsubscribe/ Posting guidelines + more: https://wiki.documentfoundation.org/Netiquette List archive: https://listarchives.libreoffice.org/global/documentation/ Privacy Policy: https://www.documentfoundation.org/privacy
