Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Mention of the ctrl modifier missing from many tooltips #3120

Closed
DorpsGek opened this issue Aug 14, 2009 · 3 comments
Closed

Mention of the ctrl modifier missing from many tooltips #3120

DorpsGek opened this issue Aug 14, 2009 · 3 comments
Labels
component: interface This is an interface issue flyspray This issue is imported from FlySpray (https://bugs.openttd.org/)

Comments

@DorpsGek
Copy link
Member

laurijh opened the ticket and wrote:

I went through the code of r17163 looking for _ctrl_pressed and confirmed the tooltip texts on the interface.

There are basically two categories where ctrl isn't mentioned; for the first one it obviously should be because it alters what happens when clicking that particular GUI element. In the second category the ctrl key is supposed to be used AFTER the button in question is pressed. In other words, adding mention of ctrl on these would describe the secondary action of such a button and in these cases it's not completely clear whether it should be mentioned at all.

In the list below I first mention the location of the GUI element whose functionality is modified by ctrl, then in parentheses the modified behaviour and then the strings which should be changed.

  1. Obviously missing texts
    - New Game in main menu (generate landscape without showing options): STR_INTRO_TOOLTIP_NEW_GAME
    - signal button in rail toolbar (autosignals/signal GUI): STR_RAIL_TOOLBAR_TOOLTIP_BUILD_RAILROAD_SIGNALS
    - vehicle list buttons (show advanced/simple list): STR_TOOLBAR_TOOLTIP_DISPLAY_LIST_OF_COMPANY_TRAINS, _ROAD_VEHICLES, _SHIPS and AIRCRAFT
    - increase/decrease vehicle service interval (5 days or 5 percent instead of 10): STR_VEHICLE_DETAILS_INCREASE_SERVICING_INTERVAL_TOOLTIP and STR_VEHICLE_DETAILS_DECREASE_SERVICING_INTERVAL_TOOLTIP
    - show vehicle orders (show timetable): STR_VEHICLE_VIEW    ORDERS_TOOLTIP
    - Go To button in vehicle orders (for stations: full load, for waypoints: go non-stop, for depots: only service)
    - centre main view on vehicle location (follow vehicle): STR_VEHICLE_VIEW    LOCATION_TOOLTIP
    - Location button for industries, depots, stations, buoys and waypoints as well as clicking a name on the list of towns, industries, subsidies and stations (create new viewport instead of changing main view): STR    VIEW_CENTER_TOOLTIP, STR_INDUSTRY_VIEW_LOCATION_TOOLTIP and STR_DEPOT_LOCATION_TOOLTIP, as well as STR_SUBSIDIES_TOOLTIP_CLICK_ON_SERVICE_TO_CENTER, STR_INDUSTRY_DIRECTORY_LIST_CAPTION, STR_TOWN_DIRECTORY_LIST_TOOLTIP and STR_STATION_LIST_TOOLTIP

  2. Ctrl is only applied on secondary action
    - build road (remove road): STR_ROAD_TOOLBAR_TOOLTIP_BUILD_ROAD_SECTION and STR_ROAD_TOOLBAR_TOOLTIP_BUILD_AUTOROAD
    - build railway (remove track): STR_RAIL_TOOLBAR_TOOLTIP_BUILD_RAILROAD_TRACK and STR_RAIL_TOOLBAR_TOOLTIP_BUILD_AUTORAIL
    - build station (join station): STR_RAIL_TOOLBAR_TOOLTIP_BUILD_RAILROAD_STATION, STR_ROAD_TOOLBAR_TOOLTIP_BUILD_BUS_STATION, STR_ROAD_TOOLBAR_TOOLTIP_BUILD_PASSENGER_TRAM_STATION, STR_ROAD_TOOLBAR_TOOLTIP_BUILD_CARGO_TRAM_STATION, STR_TOOLBAR_AIRCRAFT_BUILD_AIRPORT_TOOLTIP and STR_WATERWAYS_TOOLBAR_BUILD_DOCK_TOOLTIP
    - build waypoint (join waypoints): STR_RAIL_TOOLBAR_TOOLTIP_CONVERT_RAIL_TO_WAYPOINT
    - signal gui (semaphores/lights): STR_RAIL_TOOLBAR_TOOLTIP_BUILD_RAILROAD_SIGNALS

Reported version: trunk
Operating system: All

This issue was imported from FlySpray: https://bugs.openttd.org/task/3120
@DorpsGek
Copy link
Member Author

Zuu wrote:

I was just thinking if maybe the tooltips in OpenTTD should be changed to multi-line boxes something like the function info tooltips shown in many IDEs for programming.

------------
On click: Select bulldozer tool
On click with CTRL: Select the pink bulldozer

Using tool: Removes the type of construction that was selected when bulldozer was enabled
Using tool with Ctrl: Leave tracks when removing stations/waypoints.
------------

That way more documentation can be added without making it to hard to read. But I guess it will require that a style is set out for what to write where on top of actually coding the support for that type of tooltips.

This comment was imported from FlySpray: https://bugs.openttd.org/task/3120#comment6481

@DorpsGek
Copy link
Member Author

Rubidium wrote:

Still not done (since r17297):
- STR_RAIL_TOOLBAR_TOOLTIP_BUILD_RAILROAD_SIGNALS (autosignal, how to describe simply / toggle semaphore)
- STR_TOOLBAR_TOOLTIP_DISPLAY_LIST_OF_COMPANY_TRAINS, _ROAD_VEHICLES, _SHIPS and _AIRCRAFT (toggles based on settings)
- Go To button in vehicle orders (for stations: full load, for waypoints: go non-stop, for depots: only service); lots of different cases, not sure whether it's wise to add that to a single tooltip

This comment was imported from FlySpray: https://bugs.openttd.org/task/3120#comment6549

@DorpsGek
Copy link
Member Author

Rubidium closed the ticket.

Reason for closing: Fixed

In r17300

This comment was imported from FlySpray: https://bugs.openttd.org/task/3120

@DorpsGek DorpsGek added component: interface This is an interface issue flyspray This issue is imported from FlySpray (https://bugs.openttd.org/) bug labels Apr 7, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
component: interface This is an interface issue flyspray This issue is imported from FlySpray (https://bugs.openttd.org/)
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@DorpsGek