Help files not working with screen reader

Hi I am having problems getting my screen reader on my computer to read the help files in the mush help menu I am running windows 10 with window eyes and mush client Version 5.02

There is a plugin called MUSHclient_Help that ships with MUSHclient. That shows the help information in the output window, and thus is spoken by the screen reader. For example you can type "mchelp triggers".

Unfortunately my version of SAPI pronounces "mchelp" (which is supposed to stand for MUSHclient help) as "M Chelp".

The help database ships with the client nowadays, so you will get the same information as in the help file. Also it is the same information that appears on the web page:

http://www.gammon.com.au/scripts/doc.php

Presumably the screen reader can read out a web page, so you don't need to use the help file.

Do i have to install the plugin i know i can read it on the webpage but it is more organized in the help menu

Okay i have installed the plug in now how do i use it

Type "mchelp" for help on using it.

You would normally type "mchelp <something>" to get help on that thing (eg. triggers).

Okay one more question where do i type all of this i tried typing it all in the area when you first start mush with no luck

How are you getting the screen spoken? I tested with the plugin "Text_To_Speech" which ships with MUSHclient.

Yes, you type that into the command window, same as everything else.

Window eyes but I could try using it and use the text-to-speech voice

OK so I figured out how to type the command now how do I get it to read all of the text with in that help topic for example it just says help getting started it doesn't say anything else when I typed that in what a my doing wrong i'm also typing it in within a game and you are within a game command window not with in the starting window of mush

Yes, the game command window, where you type commands, is where it works.

Please tell me what you type, so I can reproduce what you are seeing/hearing.

Let me put this another way. What are you trying to get help on exactly? Scripting functions? Dialogs? How to use the client in general?

For now just using the mud client in general for example I would type help getting started and then it would say topic getting started but it wouldn't Read anything after

Yes, I see what you mean. If you type "mchelp getting started" you see this:



The words "Getting started" are underlined and are a hyperlink. The intention is that you click on the hyperlink and then you get more information, much the same as a web page works.

I'm not sure of a simple solution to this. Can you propose how you would like it to work?

One idea that springs to mind is that it says something like: "1. Getting started", and then you type something like "mchelp 1" where the "1" refers to the most recent information shown on the screen.

I like that idea for when you type something like when you type mchelp infermation and the menu and you associate each option with a number
For example type mchelp infermation and then type the number 1 to go to the first option in the list
But then when you select an option the screen reader should automaticly read the infermation
For example mchelp getting started it should read out as topic getting started and read all of the infermation that goes with that topic automaticly

Yes, but a lot of topics (eg. triggers) have multiple links. That is organized like a help page (or table of contents if you like). So what I was thinking was something like:

1. Add trigger
2. Delete trigger
3. Enable trigger

and so on. That way you listen to the options and then choose one.

Yes and then you just type the number of the topic that you want to read about but the topic set only have one topic should just be read automatically

Hi I'm having trouble using the plug and when I type MC help getting started and go down to getting started after topic and press enter on it it says nothing it doesn't do anything what a my doing wrong

I have amended the plugin to provide a numbered list. You can download the plugin source from here:

https://raw.githubusercontent.com/nickgammon/mushclient/master/plugins/MUSHclient_Help.xml

Just replace the contents of the file MUSHclient_Help.xml with that page. Save it and reload the plugin from within MUSHclient.

Now if you type, for example, "mchelp sounds" then you see a list like this:



Note the numbers at the start. Now to choose one, like "PlaySound" you can type:



If there is only one match, like "mchelp getting started" then as well as the list, the only matching help topic is also displayed.