search

lxqt / screengrab

Crossplatform tool for fast making screenshots.
https://lxqt.github.io
GNU General Public License v2.0
74 stars 43 forks source link

Documentation is outdated #230

Open stefonarch opened 3 years ago

stefonarch commented 3 years ago

Didn't noticed even that it exists in html → Help F1 from menu.

Expected Behavior

Should be up to date.

Current Behavior

Smells.

Possible Solution

Remove version History (to another place?) and check the rest. In weblate translators could improve the [en] Text.

tsujan commented 3 years ago

I'm not sure if it's needed anymore. The GUI is self-explanatory and, if it isn't, we could add good tooltips or even "What's This". The rest is about command-line, which should be in "--help".

Since no other LXQt component has an HTML doc inside its code, I suggest we remove it and enhance the GUI if needed.

BTW, the "Thanks" tab of the About dialog is quite outdated too.

stefonarch commented 3 years ago

I suggest we remove it and enhance the GUI if needed.

I'm ok with that. Without weblate I didn't even notice the mere existence, it showed up too in the file dialog when importing .yaml files.

tsujan commented 3 years ago

When I find the time, I'll check the GUI and add the missing info (if any) to it in a PR. That will be needed even if others don't agree with the removal of the HTML doc but I think it'll render the doc redundant.

Will tell you here when I start to do it.

yan12125 commented 3 years ago

Oops, didn't notice this before merging #229

I think it is better to keep non-English parts. They can be served as a partially translated version of README. They should be made discoverable (e.g., put on https://lxqt-project.org), though.

stefonarch commented 3 years ago

Oops, didn't notice this before merging #229

The pt_BR.html file has the same error, but anyway I will not import this doc in weblate for now.

tsujan commented 3 years ago

OK, I took a look at the GUI. IMO, except for the explanation of date and time abbreviations, which can be found in Qt doc and other places, the HTML help is useless. Who reads it to know that the "new" icon is for taking a new screenshot or the "save" icon is for saving?!

stefonarch commented 3 years ago

For date and time there could be a link to those Qt docs or a popup with the content from the html doc. This could be even translatable, maybe recycling the one in worldclock.

I agree for removing the docs, all the rest is self-explaining.

tsujan commented 3 years ago

I wanted to add a "WhatsThis" for it (click the "WhatsThis" button and then click on a GUI element to see a permanent popup that includes info) but wasn't sure if it's needed.