[nvda-addons] Re: Fwd: Re: Fwd: Re: lambda editor addon

  • From: Noelia <nrm1977@xxxxxxxxx>
  • To: nvda-addons@xxxxxxxxxxxxx
  • Date: Wed, 14 Sep 2016 05:57:31 +0200

Hi again.

I see also that the generated HTML file available in add-on help doesn't have headings. You may want to check this.
I don't know why two readme are present in the repo, but my concern is just the binary and that the documentation shown on the website is what you want, included the format.


El 14/09/2016 a las 5:30, Noelia escribió:

Hi Alberto, here are the results of my revew after checking diffs:
Basic review: (copyright and license, security and user experience): pass.
I recommend to post a first version for testing, on the community
add-ons website, so that the add-ons becomes even better with users
feed-back.
Further comments:
- Readme: You may want to check spelling errors before posting it on the
website.
Would be needed to point out the Github link for the add-on, if the
add-on is reachable from the add-ons website?
Please provide the exact link or links to the add-on, eventually for dev
and stable versions if you want the two ones in any time.
- Doc scripts: You can, just if you prefer, remove .__doc__ for scripts
whose gestures depends on Lambda, if you don't want users to change them
mangling the scripts. Or let it like that if for you is more important
that keyboard help is available for these commands.
- Translation workflow:
When the add-on becomes stable (when you decide that), I strongly
recommend that you use the message function created by Alberto
Buffolino, another italian programer author of several add-ons including
instantTranslate.
So translators don't need to work translating strings contained in NVDA
core, and discrepancies would be avoided.

The doc for the selection reporting in NVDA and in the Lambda category
has two similar but different translations in Spanish, and it's uggly, I
think.
We can release the dev version later if you want.
Thanks.

El 13/09/2016 a las 17:56, Alberto Zanella escribió:
Hi Noelia,

I want to thank you so much for the time you've spent reviewing the
code, the help and suggestions you provide me. I really appreciated that.

I worked on all issues we have discussed and now they're closed.

Now you can do the review of diffs, and then, if there are any other
feedback on something to fix (from you or from anyone here in this
list), we can publish the release.

Thank you again,

Cheers.

Alberto

2016-09-12 20:52 GMT+02:00 Noelia <nrm1977@xxxxxxxxx
<mailto:nrm1977@xxxxxxxxx>>:

    Hi, great.
    I will perform basic review on the last diffs when you want.
    Imo, if this is fixed an a category, like lambda, added, we can post
    the dev version when you want, and other things can be enhanced
    later, specially the translation workflow if you want to manage it
    throught the automated process..
    Thanks.


    El 12/09/2016 a las 20:49, Alberto Zanella escribió:

        Hi Noelia,

        Here you go.
        Now you can add table files with names starting with lamda-*
and the
        addon will populate the GUI braille combo box.

        When you quit the program, the addon automatically removes the
        lambda-*
        tables from the list.

        You can of course save your config with another table (not
        related to
        your language) and the addon takes care to update the absolute
        path of
        the table each time you start the application without altering
your
        table choice.

        Cheers,

        Alberto

        2016-09-12 10:04 GMT+02:00 Noelia <nrm1977@xxxxxxxxx
        <mailto:nrm1977@xxxxxxxxx>
        <mailto:nrm1977@xxxxxxxxx ;<mailto:nrm1977@xxxxxxxxx>>>:


            OK, about tables, I was wondering if there is a way to allow
        people
            to choose different tables, for instance I would like to
compare
            spanish and italian, and see the two tables in the combo box.

            Thanks.


            El 12/09/2016 a las 9:33, Alberto Zanella escribió:

                Hi Noelia,

                You wrote:


                    Hi Alberto, thanks for your work.
                    I think this add-on (as others) is very important
since
                    working with science and math requires previous
            accessible
                    frameworks, so that people don't find this so hard
            and don't
                    put they work just in literature and so on, which is
            really sad.


                Yes, and that's the reason why, even if Lambda is not as
            good as
                can be expected, I've decided to develop this addon to
            let users
                to work with it and NVDA.

                You wrote:


                    1. Why is needed to include in the tables dir of the
            add-on,
                    for instance, cti files?
                    Is not enough if they are contained in NVDA?


                Since I've specify another source for the braille table,
            I think
                all the references and "include" are required. I've
tried to
                remove it, and it seems that liblouis is unable to
            locate files
                and it exits with an exception.

                You wrote:


                    2. Hope there is now a way to add other tables, for
            instance
                    listing the tables contained in the tables dir. I
            will see
                    tomorrow.receiving the po files automatically, as
            explained in
                    the NVDA website wiki.


                Yes, the string with the table name is part of the
            translations.
                So each language could have it's filename, that
            corresponds to the
                localized version of the Lambda braille table.

                You wrote:


                    If you want to follow the automated system, as I try
            to said
                    previously, the spanish translation files should be
            removed
                    and translators should way until the po files are
            provided,
                    when they choose to translate the add-on using the
            settings
                    file for their languages, and po files are
provided for
                    messages and documentation.
                    Please, see the NVDA wiki and the add-ons guidelines.
                    Thanks.


                Yes, I get your point. I think is more convenient to
            complete this
                release as-it-is, and then we can follow the automate
            system. In
                this way people can test and use the addon, and
            translators have
                all the time to translate it. Then all next releases
            will have
                translation performed with the automatic system
integrated.

                You wrote:


                    3. About Bitbucket, this just makes sense if you
            want to put
                    the add-on under the automated translation system.
                    It's not needed if you prefer that translators
            individually
                    send the translation there, without


                I think that the solution suggested by Joseph is
easier and
                requires less effort.

                Thanks,
                Bye
                Alberto




                    El 11/09/2016 a las 21:14, Alberto Zanella escribió:

                        Hi Noelia and All,

                        Sorry for my late reply.

                        I closed all points we have discussed in
            previous email
                        and I've added
                        few more code documentation, hoping it can help
            others to
                        contribute to
                        the project.

                        I'm going to release version 1.1.3 in few days.

                        If anyone else would like to review the code or
            test we
                        can posticipate
                        without any problem.

                        I'm going to stay on Github as my main projects
            repository.
                        I'll release version 1.1.3 on the "Release"
            section of the
                        Github
                        repository as previous versions, in addition, we
            can put
                        the addon on
                        the development page of the group.
                        You can push the project on bitbucket after the
            release
                        1.1.3 (with the
                        specific tag) will be created on github.
                        Otherwise I can add another remote to the
            project, in this
                        case I ask to
                        the group admins if they can send an invitation
            to me at
                        this email address.
                        In the latter case, only releases will be
pushed on
                        Bitbucket and the
                        development stays on Github.

                        Finally I'd like to thanks Ivan for the spanish
                        translation, and I'm
                        looking for people who wants to contribute
            converting the
                        spanish JFW
                        lambda braille table to a liblouis-compliant.

                        Thank you,

                        Regards.

                        Alberto

                        The repository for the Lambda editor addon is:
                        https://github.com/nvdaaddons/lambda
            <https://github.com/nvdaaddons/lambda>
                        <https://github.com/nvdaaddons/lambda
            <https://github.com/nvdaaddons/lambda>>

                        2016-09-05 20:26 GMT+02:00 Noelia
            <nrm1977@xxxxxxxxx <mailto:nrm1977@xxxxxxxxx>
                        <mailto:nrm1977@xxxxxxxxx
            <mailto:nrm1977@xxxxxxxxx>>
                        <mailto:nrm1977@xxxxxxxxx
            <mailto:nrm1977@xxxxxxxxx> <mailto:nrm1977@xxxxxxxxx
            <mailto:nrm1977@xxxxxxxxx>>>>:

                            Hi, I forward this part of a public
            conversation, sent
                        privately to
                            Alberto as a mistake.
                            Cheers.



                            -------- Mensaje reenviado --------
                            Asunto:         Re: [nvda-addons] lambda
            editor addon
                            Fecha:  Mon, 5 Sep 2016 12:49:16 +0200
                            De:     Noelia <nrm1977@xxxxxxxxx
            <mailto:nrm1977@xxxxxxxxx>
                        <mailto:nrm1977@xxxxxxxxx
            <mailto:nrm1977@xxxxxxxxx>> <mailto:nrm1977@xxxxxxxxx
            <mailto:nrm1977@xxxxxxxxx>
                        <mailto:nrm1977@xxxxxxxxx
            <mailto:nrm1977@xxxxxxxxx>>>>
                            Para:   Alberto Zanella
            <lapostadialberto@xxxxxxxxx
<mailto:lapostadialberto@xxxxxxxxx>
                        <mailto:lapostadialberto@xxxxxxxxx
            <mailto:lapostadialberto@xxxxxxxxx>>
                            <mailto:lapostadialberto@xxxxxxxxx
            <mailto:lapostadialberto@xxxxxxxxx>

                        <mailto:lapostadialberto@xxxxxxxxx
            <mailto:lapostadialberto@xxxxxxxxx>>>>




                            Hi Alberto, thanks for your quick answer.

                            You wrote:

                            I don't understand the difference between
            the Github
                        and the
                            bitbucket repository, Why do I have to
            manage two
                        different repos?
                            Are they two remotes of the same repo? In
            this case I
                        suppose to
                            need to attach the git repo to another
            remote source.
                        Am I correct?


                            First, in 2012, the NVDA add-on team was
            created on
                        Bitbucket, where
                            add-ons, add-on files (a repo to manage the
            add-ons
                        posted on the
                            website) and mr config to manage
            translations, are stored.

                            Later, in 2016, Joseph Lee, the creator of
            this list,
                        contributor of
                            NVDA and author and reviewer of several
add-ons,
                        created another
                            team on Github. He and I are the admins of
            this last team.

                            I decided to release add-ons on Github,
            because of its
                        release
                            system (we can attach binaries easily) and
more
                        comfortable
                            interface respect to Bitbucket.

                            So I add two URLs to push add-ons at the
            same time.
                        But you can just
                            join the Bitbucket add-on team, though the
            admins are
                        other people,
                            and for me is less comfortable.

                            I just create repos on Github for new
            add-ons, and
                        then import them
                            to Bitbucket, managing releases on Github.

                            Bitbucket team can't be removed since the
            translation
                        workflow uses
                            it, as well as add-on files, and these
            changes will
                        require work and
                            time by other admins.

                            If you just want to join Github, I will
            import your
                        repo to
                            Bitbucket and add it to the translation
            workflow system.


                            You wrote:

                            b) The command to say all using the review
            cursor is
                        not working
                            The review cursor simply doesn't work, I'm
            sorry. The
                        review mode
                            uses TextInfos to get information to be
            read. I don't
                        know any way
                            in which I can make an object with two
            textinfo, one
                        for the braille
                            and another for the speech. So TextInfos are
            reserved
                        for the
                            braille representation and speech doesn't
            rely on it.
                        If you try to
                            move using review cursor, you'll obtain the
            "real"
                        text on the
                            screen and not what is supposed to be spoken
            (which is
                        obtained via
                            a COM Object). Have you any idea on how to
            improve it?


                            No, I just can think on some kind of
            dictionary, as
                        used in
                            emoticons add-ons, but it's just a vague
            idea, erhaps
                        unuseful.


                            You wrote:

                            What shortcut do you use to read the
            selection? If you
                        are using
                            nvda+shift+s yes, I forgot to remap this
            keystroke. If
                        you are using
                            nvda+shift+uparrow let me know.


                            I use NVDA+shift+s.


                            You wrote:

                            In the init method of the appModule, the
            addon checks
                        if a profile
                            called "lambda" exists. If it doesn't it
            creates a
                        profile with:
                            1- The braille table set to the localized
            version of
                        the lambda
                            table (contained inside the braillTable
            directory of
                        the appmodule;
                            - tether the braille to the focus;
                            - disable reading by paragraph;
                            - adds a custom [lambda] entry on the
            configuration
                        with the
                            flatMode parameter set to True.

                            I suggest you to clarify all this in the
            readme, so
                        that people can
                            be careful about this.


                            You wrote:

                            c) I saw that abspath is used to find a
            folder. Is
                        this needed? If
                            not, Should be removed as superflous?
                            Yes it is needed because otherwise the
            braille table
                        need needs to
                            be located inside the liblouis directory
            (which is
                        inside the NVDA
                            program directory). With this trick the
            addon can be
                        installed
                            without admin rights and all the addon data
            are in
                        windows user
                            profile directory.


                            I thought that it would be enough using
            os.path, not
                        abspath.



                            Hope more people review the add-on or
            provide feedback.

                            Let us know when you want to post the
            development
                        version on the
                            website for testing.

                            Thanks.







                            El 05/09/2016 a las 12:19, Alberto Zanella
            escribió:

                                Hi Noelia,
                                Thank you for your message.

                                You wrote:

                                    I have sent you an invitation to the
                        nvdaaddons team on Github.
                                    If you need an invitation to the
            Bitbucket
                        add-on team to manage
                                    addonFiles repo, to post add-ons
on the
                        community website,
                                and/or
                                    you want to create pages there,
            please ask for
                        an invitation and
                                    admins of the Bitbucket add-on team
            will send
                        it; for creating
                                    pages, you will need an invitation
from
                        translators.
                                    Otherwise, members of NVDA add-on
            team could
                        post your add-on on
                                    the website.


                                Ok, thank you. I don't think other
            repositories
                        are needed for me. I
                                don't understand the difference between
            the Github
                        and the bitbucket
                                repository, Why do I have to manage two
            different
                        repos? Are
                                they two
                                remotes of the same repo? In this case I
            suppose
                        to need to
                                attach the
                                git repo to another remote source. Am I
            correct?

                                    I made a first review of your
            add-on, and
                        makes really a good
                                    impression.


                                Thank you, You are too kind! (smile).

                                    I think you could post it soon,
            though you can
                        wait if you want
                                    further comments.

                                Yes, I would be glad if someone else
            could suggest
                        improvements or
                                review the code.

                                    I need to test this with braille.
            For now, my
                        basic review is as
                                    follows:
                                    1 License and copyright: pass.
                                    2. Security: pass (it doesn't
            contain harmful
                        code).
                                    3. User experience: pass (it doesn't
            mangle
                        NVDA or features on
                                    Windows, for instance overriding
            keystrokes
                        used by NVDA).
                                    You mentioned that you had never
            wrote on this
                        list. So, in case
                                    you don't know, basic review consist
            just on
                        ensuring that
                                add-ons
                                    ara write on this few criteria.

                                    Comments:
                                    1. On add-on usage, possible
            improvements:
                                    a) When I insert a table, in the
            dialog to
                        enter the number of
                                    rows and columns, the name of the
            second edit
                        box is not
                                read by NVDA.

                                I know, It has no label in the
            application, so
                        NVDA doesn't speak
                                anything.

                                    b) The command to say all using the
            review
                        cursor is not working

                                The review cursor simply doesn't work,
            I'm sorry.
                        The review
                                mode uses
                                TextInfos to get information to be read.
            I don't
                        know any way in
                                which
                                I can make an object with two textinfo,
            one for
                        the braille and
                                another for the speech. So TextInfos are
            reserved
                        for the braille
                                representation and speech doesn't rely
            on it. If
                        you try to move
                                using
                                review cursor, you'll obtain the "real"
            text on
                        the screen and not
                                what is supposed to be spoken (which is
            obtained
                        via a COM Object).
                                Have you any idea on how to improve it?


                                    c) When I read the selected text,
            the reading
                        is not natural,
                                    though I suppose this can't be
enhanced
                        easily, and I think that
                                    this should be optional and
            configurable, if
                        implemented. Or
                                just
                                    it can be let like that.

                                What shortcut do you use to read the
            selection? If
                        you are using
                                nvda+shift+s yes, I forgot to remap this
                        keystroke. If you are using
                                nvda+shift+uparrow let me know.

                                    d) Reading the documentation, I
            don't know
                        what the Lammbda
                                    profile does exactly, so maybe
that an
                        important parameter is
                                    overriden, in the same profile or
            due to a
                        manual profile,
                                or just
                                    disabling triggers. So I think this
            should be
                        clarified in
                                the readme.

                                In the init method of the appModule, the
            addon
                        checks if a profile
                                called "lambda" exists. If it doesn't it
            creates a
                        profile with:
                                1- The braille table set to the
            localized version
                        of the lambda
                                table
                                (contained inside the braillTable
            directory of the
                        appmodule;
                                - tether the braille to the focus;
                                - disable reading by paragraph;
                                - adds a custom [lambda] entry on the
                        configuration with the
                                flatMode
                                parameter set to True.

                                    e. switchFlatMode doesn't have a
            .__doc__
                        property, so the
                                    keystroke can't be reasigned.

                                Yes, thank you. I'll add it as soon as
            possible.


                                    2. Source code:
                                    a) In the header you put that this
            is part of
                        NVDA. I think this
                                    could be removed, since it's now an
            add-on,
                        and doesn't
                                belong to
                                    NVDA itself.

                                Ok,

                                    b) You use return... else, like
this:if

            (config.conf['lambda']['brailleFlatMode']) :

return
                        LambdaEditorFlatTextInfo
                                                            else : return
                        LambdaEditorTextInfo

                                    I think that this kind of else can
            be removed,
                        since if you
                                    previously have returned, the first
            option is
                        not available (or
                                    not?). this can be a logical
            simplification.


                                Yes Ok,


                                    c) I saw that abspath is used to
find a
                        folder. Is this
                                needed? If
                                    not, Should be removed as superflous?

                                Yes it is needed because otherwise the
            braille
                        table need needs
                                to be
                                located inside the liblouis directory
            (which is
                        inside the NVDA
                                program directory). With this trick the
            addon can
                        be installed
                                without
                                admin rights and all the addon data are
            in windows
                        user profile
                                directory.

                                    I think these comments perhaps can
            help to the
                        future
                                maintenance
                                    of the add-on, and readability.

                                Yes, for sure, and I'm happy to get
            these feedback.


                                    3. Translation workflow:
                                    The add-on name start with a capital
            letter,
                        and it's not
                                    supported by the translation system.
            Please
                        see add-on
                                guidelines,
                                    available from the development
            version of the
                        add-ons website.
                                    BTW, if you want to manage your
            add-on by the
                        automated
                                    translation system used by the
            translators
                        team of NVDA, I
                                    recommend not to include
            translations on your
                        repo, since the
                                    automated system is enabled for the
            add-on.
                        Sometimes I
                                think that
                                    this can produce problems with the
            system.


                                Ok, fine. I think that messages can be
            deleted
                        when translators will
                                decide on the translation of this addon.
            In this
                        way, in the
                                meantime,
                                people can have it translated

                                Thank you so much for your help


                                Cheers,

                                Alberto





----------------------------------------------------------------
                            NVDA add-ons: A list to discuss add-on code
                        enhancements and for
                            reporting bugs.
                            Community addons are available from:
                        http://addons.nvda-project.org
                            To send a message to the list:
                        nvda-addons@xxxxxxxxxxxxx
            <mailto:nvda-addons@xxxxxxxxxxxxx>
            <mailto:nvda-addons@xxxxxxxxxxxxx
            <mailto:nvda-addons@xxxxxxxxxxxxx>>
                            <mailto:nvda-addons@xxxxxxxxxxxxx
            <mailto:nvda-addons@xxxxxxxxxxxxx>
                        <mailto:nvda-addons@xxxxxxxxxxxxx
            <mailto:nvda-addons@xxxxxxxxxxxxx>>>
                            To change your list settings/unsubscribe:
                            //www.freelists.org/list/nvda-addons
            <//www.freelists.org/list/nvda-addons>
                        <//www.freelists.org/list/nvda-addons
            <//www.freelists.org/list/nvda-addons>>
                            <//www.freelists.org/list/nvda-addons
            <//www.freelists.org/list/nvda-addons>
                        <//www.freelists.org/list/nvda-addons
            <//www.freelists.org/list/nvda-addons>>>
                            To contact list moderators:
                        nvda-addons-moderators@xxxxxxxxxxxxx
            <mailto:nvda-addons-moderators@xxxxxxxxxxxxx>
                        <mailto:nvda-addons-moderators@xxxxxxxxxxxxx
            <mailto:nvda-addons-moderators@xxxxxxxxxxxxx>>
                            <mailto:nvda-addons-moderators@xxxxxxxxxxxxx
            <mailto:nvda-addons-moderators@xxxxxxxxxxxxx>
                        <mailto:nvda-addons-moderators@xxxxxxxxxxxxx
            <mailto:nvda-addons-moderators@xxxxxxxxxxxxx>>>




----------------------------------------------------------------
                    NVDA add-ons: A list to discuss add-on code
            enhancements and
                    for reporting bugs.
                    Community addons are available from:
                    http://addons.nvda-project.org
                    To send a message to the list:
            nvda-addons@xxxxxxxxxxxxx <mailto:nvda-addons@xxxxxxxxxxxxx>
                    <mailto:nvda-addons@xxxxxxxxxxxxx
            <mailto:nvda-addons@xxxxxxxxxxxxx>>
                    To change your list settings/unsubscribe:
                    //www.freelists.org/list/nvda-addons
            <//www.freelists.org/list/nvda-addons>
                    <//www.freelists.org/list/nvda-addons
            <//www.freelists.org/list/nvda-addons>>
                    To contact list moderators:
                    nvda-addons-moderators@xxxxxxxxxxxxx
            <mailto:nvda-addons-moderators@xxxxxxxxxxxxx>
                    <mailto:nvda-addons-moderators@xxxxxxxxxxxxx
            <mailto:nvda-addons-moderators@xxxxxxxxxxxxx>>




    ----------------------------------------------------------------
    NVDA add-ons: A list to discuss add-on code enhancements and for
    reporting bugs.
    Community addons are available from: http://addons.nvda-project.org
    To send a message to the list: nvda-addons@xxxxxxxxxxxxx
    <mailto:nvda-addons@xxxxxxxxxxxxx>
    To change your list settings/unsubscribe:
    //www.freelists.org/list/nvda-addons
    <//www.freelists.org/list/nvda-addons>
    To contact list moderators: nvda-addons-moderators@xxxxxxxxxxxxx
    <mailto:nvda-addons-moderators@xxxxxxxxxxxxx>



----------------------------------------------------------------
NVDA add-ons: A list to discuss add-on code enhancements and for reporting bugs.
Community addons are available from: http://addons.nvda-project.org
To send a message to the list: nvda-addons@xxxxxxxxxxxxx
To change your list settings/unsubscribe: 
//www.freelists.org/list/nvda-addons
To contact list moderators: nvda-addons-moderators@xxxxxxxxxxxxx

Other related posts: