Currently Online

Latest Posts

Topic: Console Help layout

GwendalD
Avatar
Joined: 2017-05-01, 19:24
Posts: 3
Ranking
Just found this site
Posted at: 2017-05-01, 19:36

Hi !

I am new to the widelands community, and I try to help with few translation or correcting typo in french.

Looking at the Console Help, I first try widelands --help to see what's in. And... It's a bit ugly. Some sentence start with a space, some others don't. Some commentary go after the option name, some others in a new line. etc.

So, I am asking if we can do something more like this, in order to be homogeneous:

 --option1=value1
               Some description text, starting with 15 space.
 --option2=[value2|value3|value4]
               Second description text, possibly a long one which need a 
               breaking line to explain what it does. This standard respect the
               80 characters per line (more or less). Moreover, note the space
               before the `--option`.

What do you think of it? Is it a good idea?


Top Quote
kaputtnik
Avatar
Joined: 2013-02-18, 20:48
Posts: 1523
Ranking
One Elder of Players
Location: Germany
Posted at: 2017-05-01, 20:49

Hi GwendalD and welcome to our forums face-smile.png

In comparison to command line help from other programs i think the behavior is normal. Here's a output snipped of ls --help

  -L, --dereference          when showing file information for a symbolic 
                               link, show information for the file the link
                               references rather than for the link itself   
  -m                         fill width with a comma separated list of entries
  -n, --numeric-uid-gid      like -l, but list numeric user and group IDs
  -N, --literal              print entry names without quoting                    
  -o                         like -l, but do not list group information               
  -p, --indicator-style=slash                                                                 
                             append / indicator to directories 

But if you want to work on a more homogeneous output, i guess no one would be against it face-smile.png

Edited: 2017-05-01, 20:50
Top Quote
GwendalD
Avatar
Joined: 2017-05-01, 19:24
Posts: 3
Ranking
Just found this site
Posted at: 2017-05-01, 21:43

Ok. Indeed command --help in more often like you say. I was thinking in the man way.

Nevertheless, I suggest to have a standardized way of writing this help. I will see how to do so face-smile.png Thanks !


Top Quote
GunChleoc
Avatar
Joined: 2013-10-07, 15:56
Posts: 2623
Ranking
One Elder of Players
Location: RenderedRect
Posted at: 2017-05-01, 23:43

Best use an offline editor like Virtaal for this - it will show you the blank spaces properly. I'll make you proofreader so you can upload the fixed strings.


Busy indexing nil values

Top Quote
GwendalD
Avatar
Joined: 2017-05-01, 19:24
Posts: 3
Ranking
Just found this site
Posted at: 2017-05-02, 13:42

Thanks for the tool.

I have just uploaded my suggestion.


Top Quote