[Bug 41737] LOCALHELP: Indentation and colors missing in BASIC code examples

Hi,

We have a new documentation-related bug to deal with. Code samples in
the online help have no formatting to differentiate them as code
portions.

They would need indenting and, if syntax coloring is available in the
underlying editing system, they would need formatting as source code.

It's not an especially complicated job, but there must be lots of
places in the help where this needs doing.

Definitely needs to be a team effort....

Hi :slight_smile:
Sorry i completely lost track again. Has this bug-report been dealt with already?
Regards from
Tom :slight_smile:

Hi Tom,

Sorry i completely lost track again.  Has this bug-report been dealt with already?

No, nor even commenced... it's waiting for willing hands to the pumps....

David, I'm not a willing hand on that chore, but can you remind us
where and how one can make changes to the Help?

Do we have a "help needed" page for documentation other than the user
guides? I have trouble finding things on the website and the wiki (and
I forget what's where); I can just imagine that a new volunteer would
be totally lost. (Tom, when you're reorganising the Docs wiki, that's
something to consider including.)

--Jean

Hi :slight_smile:
A few people fairly recently have asked to be given tasks so it's possible they might be interested. At the time i was at a loss for tasks to hand out and i think it would be good to build-up a list on the
Documentation/Team
page or somewhere like that. Perhaps on the wish-list place?

One problem with building up any filing system is that what is obvious for one person is weird and obscure for another. I think the main problem with the wiki is that it grew organically and just needs re-organising a bit occasionally.

Alex, off-list, seemed to like some of the direction i was taking with
http://wiki.documentfoundation.org/Documentation
I had to re-write some paragraphs and people might like to edit that a bit which would be cool :slight_smile:

Regards from
Tom :slight_smile:

Hi :slight_smile:
For help needed i think the closest at the moment is
http://wiki.documentfoundation.org/Documentation/Production#Wish_List_for_User_Documentation

I think some of that can be pulled onto the
Documentation/Team
page. I could change the title of that and other pages if people can think of any names. Stupid ideas sometimes turn out to be good or inspire a good one so anyone please feel free to make suggestions.
Regards from
Tom :slight_smile:

What I have in mind would be quite a bit more specific and less
open-ended or huge and overwhelming than most of the items on the wish
list. Things that might suit people with limited time and/or not much
experience planning and writing a full document. Some of the bug
reports, for example. Of course, even "small" tasks usually need some
research, and often need to have a test case set up so the writer can
understand what a reader may need to know, take screenshots, etc.

The list of required updates for the user guide is sort of that kind
of list, but it hasn't resulted in any work getting done; perhaps no
one knows it's there.

The original topic of this thread ([Bug 41737] LOCALHELP: Indentation
and colors missing in BASIC code examples) seems to me to be an
excellent example of something people could work on in bite-sized
chunks, if (a) they knew about the need, and (b) they knew where and
how to start.

--Jean

Hi Jean,

David, I'm not a willing hand on that chore, but can you remind us
where and how one can make changes to the Help?

Do we have a "help needed" page for documentation other than the user
guides? I have trouble finding things on the website and the wiki (and
I forget what's where); I can just imagine that a new volunteer would
be totally lost. (Tom, when you're reorganising the Docs wiki, that's
something to consider including.)

I envision working on some of these bugs, and will post a guide about
how to do so, on the wiki and as an addition to the contributor docs.