You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@commons.apache.org by "David Leal (JIRA)" <ji...@apache.org> on 2006/06/05 14:16:29 UTC

[jira] Created: (CLI-116) Allow to configure the with of the first column on the HelperFormatter.print() method

Allow to configure the with of the first column on the HelperFormatter.print() method
-------------------------------------------------------------------------------------

         Key: CLI-116
         URL: http://issues.apache.org/jira/browse/CLI-116
     Project: Commons CLI
        Type: Improvement

    Versions: Nightly Builds    
    Reporter: David Leal


Just to suggest to allow the user to controll the with of the first column of the generated output from HelperFormatter.print() method, for the option description.

Now this with is delimited by the longest option and some times it is not the best solution, because the with of the second column (description) in order to fix the maximum length (default 80) has to be short.

My suggestion is to give the possibility to the user to wrap the option definition (first column), in case it is going to be longer to a given value. This is usefull for group options, for example something like this:

-report (-r)
    -date|-list|-template|-param-names|-param-values|-format 
      -date (-d) date
      -list (-l)
      -template (-t) template [template ...]
      -param-names (-pNames) name [name ...]
      -param-values (-pValues) value [value ...]
      -format (-f) format [format ...]

so the description field will be started after the longest option definition, at column possition after: 

    -date|-list|-template|-param-names|-param-values|-format 

a better solution would be nevertheless to wrap also this line to a given length, for example:

-report (-r)
    -date|-list|-template|-param-names
     |-param-values|-format 
      -date (-d) date
      -list (-l)
      -template (-t) template [template ...]
      -param-names (-pNames) name [name ...]
      -param-values (-pValues) value [value ...]
      -format (-f) format [format ...]

it is easy to see the line is wrapped because the indentation level, so now the second column, that is the description, will come after the -param-names option definition which is now the longest option definition.

Thanks in advance,

David Leal

-- 
This message is automatically generated by JIRA.
-
If you think it was sent incorrectly contact one of the administrators:
   http://issues.apache.org/jira/secure/Administrators.jspa
-
For more information on JIRA, see:
   http://www.atlassian.com/software/jira


---------------------------------------------------------------------
To unsubscribe, e-mail: commons-dev-unsubscribe@jakarta.apache.org
For additional commands, e-mail: commons-dev-help@jakarta.apache.org

[jira] Updated: (CLI-116) Allow to configure the with of the first column on the HelperFormatter.print() method

Posted by "Henri Yandell (JIRA)" <ji...@apache.org>.
     [ http://issues.apache.org/jira/browse/CLI-116?page=all ]

Henri Yandell updated CLI-116:
------------------------------

    Fix Version: 2.1

Setting as a feature request for 2.1 (2.0 should be releasable once a lot of tidying up has gone on - so still months away). 

Any thoughts on this feature? (Andrew? James?).

> Allow to configure the with of the first column on the HelperFormatter.print() method
> -------------------------------------------------------------------------------------
>
>          Key: CLI-116
>          URL: http://issues.apache.org/jira/browse/CLI-116
>      Project: Commons CLI
>         Type: Improvement

>     Versions: Nightly Builds
>     Reporter: David Leal
>      Fix For: 2.1

>
> Just to suggest to allow the user to controll the with of the first column of the generated output from HelperFormatter.print() method, for the option description.
> Now this with is delimited by the longest option and some times it is not the best solution, because the with of the second column (description) in order to fix the maximum length (default 80) has to be short.
> My suggestion is to give the possibility to the user to wrap the option definition (first column), in case it is going to be longer to a given value. This is usefull for group options, for example something like this:
> -report (-r)
>     -date|-list|-template|-param-names|-param-values|-format 
>       -date (-d) date
>       -list (-l)
>       -template (-t) template [template ...]
>       -param-names (-pNames) name [name ...]
>       -param-values (-pValues) value [value ...]
>       -format (-f) format [format ...]
> so the description field will be started after the longest option definition, at column possition after: 
>     -date|-list|-template|-param-names|-param-values|-format 
> a better solution would be nevertheless to wrap also this line to a given length, for example:
> -report (-r)
>     -date|-list|-template|-param-names
>      |-param-values|-format 
>       -date (-d) date
>       -list (-l)
>       -template (-t) template [template ...]
>       -param-names (-pNames) name [name ...]
>       -param-values (-pValues) value [value ...]
>       -format (-f) format [format ...]
> it is easy to see the line is wrapped because the indentation level, so now the second column, that is the description, will come after the -param-names option definition which is now the longest option definition.
> Thanks in advance,
> David Leal

-- 
This message is automatically generated by JIRA.
-
If you think it was sent incorrectly contact one of the administrators:
   http://issues.apache.org/jira/secure/Administrators.jspa
-
For more information on JIRA, see:
   http://www.atlassian.com/software/jira


---------------------------------------------------------------------
To unsubscribe, e-mail: commons-dev-unsubscribe@jakarta.apache.org
For additional commands, e-mail: commons-dev-help@jakarta.apache.org