[ELPA] New package: Auto Capitalize Mode

[ELPA] New package: Auto Capitalize Mode

[Ian Dunn]

[-- Attachment #1: Type: text/plain, Size: 300 bytes --]


I'd like to submit auto-capitalize-mode.el to ELPA as a single-package file.  It's a small package that creates a minor-mode for automatic sentence capitalization, complete with buffer-local enable predicate and sentence bound finding.

If there are no issues, I'll push it to the git repo myself.


[-- Attachment #2: auto-capitalize-mode.el --]
[-- Type: application/emacs-lisp, Size: 4663 bytes --]

[-- Attachment #3: Type: text/plain, Size: 14 bytes --]


-- 
Ian Dunn

Re: [ELPA] New package: Auto Capitalize Mode

[Stefan Monnier]

> If there are no issues, I'll push it to the git repo myself.

No objection on my side.  Thanks you.
Just one comment:

> (defvar-local auto-capitalize-sentence-bounds-function
>   #'auto-capitalize--default-sentence-bounds
>   "Function to determine the bounds of the current sentence.
>
> Should return the bounds just as `bounds-of-thing-at-point'.")

You only use the `car` part of the return value AFAICT, so requiring the
cdr part just imposes an extra burden.

IOW, I'd remove the `car` you have (twice) in auto-capitalize--run and
put it inside auto-capitalize--default-sentence-bounds instead
(and rename since it doesn't return "bounds" any more).

> (defun turn-on-auto-capitalize-mode ()
>   (auto-capitalize-mode 1))

AKA 

    (defun turn-on-auto-capitalize-mode ()
      (auto-capitalize-mode))

hence, it's unnecessary, you can just do:

    ;;;###autoload
    (define-globalized-minor-mode global-auto-capitalize-mode
      auto-capitalize-mode auto-capitalize-mode)


        Stefan

Re: [ELPA] New package: Auto Capitalize Mode

[Ian Dunn]

[-- Attachment #1: Type: text/plain, Size: 1305 bytes --]

>>>>> "Stefan" == Stefan Monnier <monnier@iro.umontreal.ca> writes:

    >> If there are no issues, I'll push it to the git repo myself.
    Stefan> No objection on my side.  Thanks you.  Just one comment:

    >> (defvar-local auto-capitalize-sentence-bounds-function
    >> #'auto-capitalize--default-sentence-bounds "Function to determine
    >> the bounds of the current sentence.
    >> 
    >> Should return the bounds just as `bounds-of-thing-at-point'.")

    Stefan> You only use the `car` part of the return value AFAICT, so
    Stefan> requiring the cdr part just imposes an extra burden.

    Stefan> IOW, I'd remove the `car` you have (twice) in
    Stefan> auto-capitalize--run and put it inside
    Stefan> auto-capitalize--default-sentence-bounds instead (and rename
    Stefan> since it doesn't return "bounds" any more).

    >> (defun turn-on-auto-capitalize-mode () (auto-capitalize-mode 1))

    Stefan> AKA

    Stefan>     (defun turn-on-auto-capitalize-mode ()
    Stefan> (auto-capitalize-mode))

    Stefan> hence, it's unnecessary, you can just do:

    Stefan>     ;;;###autoload (define-globalized-minor-mode
    Stefan> global-auto-capitalize-mode auto-capitalize-mode
    Stefan> auto-capitalize-mode)

I agree on both counts.  I've attached a file with the fixes applied.


[-- Attachment #2: auto-capitalize-mode.el --]
[-- Type: application/emacs-lisp, Size: 4732 bytes --]

[-- Attachment #3: Type: text/plain, Size: 14 bytes --]


-- 
Ian Dunn

Re: [ELPA] New package: Auto Capitalize Mode

[Uwe Brauer]

>>> "Ian" == Ian Dunn <dunni@gnu.org> writes:

   > I'd like to submit auto-capitalize-mode.el to ELPA as a single-package
   > file. It's a small package that creates a minor-mode for automatic
   > sentence capitalization, complete with buffer-local enable predicate
   > and sentence bound finding.

   > If there are no issues, I'll push it to the git repo myself.

Are you aware of auto-capitalize-mode by Kevin Rodgers, it is more than
10 years old and very sophisticated. Maybe you have a look, since you
might reinvent the wheel.

Uwe Brauer 

Re: [ELPA] New package: Auto Capitalize Mode

[Ian Dunn]

>>>>> "Uwe" == Uwe Brauer <oub@mat.ucm.es> writes:

    Uwe> Are you aware of auto-capitalize-mode by Kevin Rodgers, it is
    Uwe> more than 10 years old and very sophisticated. Maybe you have a
    Uwe> look, since you might reinvent the wheel.

I am aware of it.  I tried it before writing my version, but I can't remember what issues I encountered with it that made me not like it.  After a brief trial, the big difference I see is it not handling *This* or /This/ in Org mode sentences, which is a big deal to me.  I use the same formatting in my custom writing mode, so when writing internal dialogue (for which I use italics), I want the dialogue to be capitalized.

One feature of mine that's absent in that one is the ability for a user to specify a sentence start function.  I've found this exceedingly helpful in every mode.  I can specify a function to check for a comment in programming modes, the start of a list or heading in Org mode, and the start of the input line in chat modes.  The way Rodgers's version is implemented, such a feature isn't possible.

-- 
Ian Dunn

Re: [ELPA] New package: Auto Capitalize Mode

[Uwe Brauer]

   Uwe> Are you aware of auto-capitalize-mode by Kevin Rodgers, it is
   Uwe> more than 10 years old and very sophisticated. Maybe you have a
   Uwe> look, since you might reinvent the wheel.

   > I am aware of it. I tried it before writing my version, but I can't
   > remember what issues I encountered with it that made me not like it.
   > After a brief trial, the big difference I see is it not handling
   > *This* or /This/ in Org mode sentences, which is a big deal to me. I
   > use the same formatting in my custom writing mode, so when writing
   > internal dialogue (for which I use italics), I want the dialogue to be
   > capitalized.

Ok, I put quite some time ago auto-capitalize-mode, with the permission
to MELPA. Maybe it would be good to chose a slightly different name,
although I admit right now, nothing really neat pops up in my mind. But
Kevin's auto-capitalize-mode is 20 years, so people might be confused if
a very different implementation with the same name pops up.

   > One feature of mine that's absent in that one is the ability for a
   > user to specify a sentence start function. I've found this exceedingly
   > helpful in every mode. I can specify a function to check for a comment
   > in programming modes, the start of a list or heading in Org mode, and
   > the start of the input line in chat modes. The way Rodgers's version
   > is implemented, such a feature isn't possible.

One thing which was a considerable headache, but could be solved in
Kevin's version concerned  letters in math formula in latex (auctex) mode.
For example

\[
\sum_{i=1}^n A_i
\]

Should not give 

\[
\sum_{I=1}^n A_I
\]

Did you check this for your code?

Re: [ELPA] New package: Auto Capitalize Mode

[Ian Dunn]

>>>>> "Uwe" == Uwe Brauer <oub@mat.ucm.es> writes:

    Uwe> One thing which was a considerable headache, but could be
    Uwe> solved in Kevin's version concerned letters in math formula in
    Uwe> latex (auctex) mode.  For example

    Uwe> \[ \sum_{i=1}^n A_i \]

    Uwe> Should not give

    Uwe> \[ \sum_{I=1}^n A_I \]

    Uwe> Did you check this for your code?

Confirmed, that doesn't happen with my version.

    Uwe> Ok, I put quite some time ago auto-capitalize-mode, with the
    Uwe> permission to MELPA. Maybe it would be good to chose a slightly
    Uwe> different name, although I admit right now, nothing really neat
    Uwe> pops up in my mind. But Kevin's auto-capitalize-mode is 20
    Uwe> years, so people might be confused if a very different
    Uwe> implementation with the same name pops up.

I agree that having two packages that provide "auto-capitalize-mode" will be confusing to users.  What about "cisa" (Capitalization IS Automatic) or "capp-e" (Capitalization is an Automatic and Pleasant Process in Emacs)?

-- 
Ian Dunn

Re: [ELPA] New package: Auto Capitalize Mode

[Stefan Monnier]

> I agree that having two packages that provide "auto-capitalize-mode" will be
> confusing to users.

Unless one of them is abandoned and the other can be considered as
a newer version (no idea if it's the case, here).


        Stefan

Re: [ELPA] New package: Captain (was [ELPA] New package: Auto Capitalize Mode)

[Ian Dunn]

[-- Attachment #1: Type: text/plain, Size: 1196 bytes --]

>>>>> "Stefan" == Stefan Monnier <monnier@iro.umontreal.ca> writes:

    >> I agree that having two packages that provide
    >> "auto-capitalize-mode" will be confusing to users.

    Stefan> Unless one of them is abandoned and the other can be
    Stefan> considered as a newer version (no idea if it's the case,
    Stefan> here).

I don't know for sure that the old one's abandoned, although it looks
like little has been done on it in the past few years.  That could be
because it was determined to be in a stable state, or it could be
because it's been abandoned.

In any case, I've chosen to rename the package and add two new features
to it to mostly match what the old package did.

Specifically, I added the ability to capitalize a word once and have it
automatically capitalized in the future, and the ability to capitalize
the current sentence using the function it was already using to find the
start of the sentence.  The latter is implemented to open the
possibility of capitalizing yanked text in the future, a feature of the
old package, although I see no need for it right now.

I also mention the old package in the commentary, in case other users
may want to try it instead.


[-- Attachment #2: captain.el --]
[-- Type: application/emacs-lisp, Size: 7631 bytes --]

[-- Attachment #3: Type: text/plain, Size: 14 bytes --]


-- 
Ian Dunn

Re: [ELPA] New package: Captain (was [ELPA] New package: Auto Capitalize Mode)

[Stefan Monnier]

> I don't know for sure that the old one's abandoned, although it looks
> like little has been done on it in the past few years.

It doesn't need to be some fact that we need to figure out: it can be
a fact we create by discussing with the other author.


        Stefan

Re: [ELPA] New package: Captain (was [ELPA] New package: Auto Capitalize Mode)

[Ian Dunn]

>>>>> "Stefan" == Stefan Monnier <monnier@iro.umontreal.ca> writes:

    >> I don't know for sure that the old one's abandoned, although it
    >> looks like little has been done on it in the past few years.

    Stefan> It doesn't need to be some fact that we need to figure out:
    Stefan> it can be a fact we create by discussing with the other
    Stefan> author.

Of course.  I reached out to him a few minutes ago about it.

-- 
Ian Dunn

Re: [ELPA] New package: Auto Capitalize Mode

[Uwe Brauer]

   > I agree that having two packages that provide "auto-capitalize-mode"
   > will be confusing to users. What about "cisa" (Capitalization IS
   > Automatic) or "capp-e" (Capitalization is an Automatic and Pleasant
   > Process in Emacs)?

I am not a native speaker, so self-capitalize-mode does not sound too
good, doesn't it?

 automatic-cap-mode?

Uwe 

Re: [ELPA] New package: Auto Capitalize Mode

[Timur Aydin]

On 9/2/2017 10:54 AM, Uwe Brauer wrote:
> 
> 
> 
> I am not a native speaker, so self-capitalize-mode does not sound too
> good, doesn't it?
> 

Perhaps a suffix after "auto-capitalize-mode" would be more suitable, 
like auto-capitalize-mode-dunn.  That way, if somebody else comes up 
with an alternative implementation, it can be accomodated as well, 
without needing to invent yet another name for the same task.

--
Timur