AvolitesLtd / TitanManual

Official Documentation for the Avolites Titan software
http://manual.avolites.com/
9 stars 11 forks source link

Split "Front Panel Buttons" page into specific pages for contents #312

Open p--b opened 3 years ago

p--b commented 3 years ago

Link to the page in the manual: https://manual.avolites.com/docs/en/titan-basics/front-panel-buttons/#key-macro-buttons

Why it should be changed: This page currently contains information on three relatively unrelated topics; macros, keyboard shortcuts and the lock screen. If a user is searching for information on one of these topics, it is currently difficult to find the correct page in the manual.

The topic ought to be split into three (or more) pages; Macros, Keyboard Shortcuts and Locking the Console.

congoblue commented 3 years ago

This whole section "Titan basics" is problematic due to the way the Titan software has developed over time.

I have tried not to create a lot of separate pages with short individual content since that makes the left hand menu large and more difficult to navigate. I think it would be better to group these topics with other related content rather than having separate pages, the question is what section should they be in? (And what would be a better way of arranging this whole section?)

p--b commented 3 years ago

I know what you mean about the navigation - I think on the flipside, search works significantly better when there's a page with the title that relates to what you're thinking of, and linking someone to the correct content is much easier if there's a single page that references what you want- e.g. see https://help2.malighting.com/Page/grandMA2/macro/en/3.9 for comparison.

Agreed in general on Titan basics - perhaps splitting it into a couple of top-level topics - Touchscreen UI / Managing Showfiles / Macros?

congoblue commented 3 years ago

Well we could reformat it to be split into smaller pages like that - at the moment the structure is really just an import of the original PDF, which was designed to be a printed document. Also the searching on that had manually placed tags in the important sections which made searching work better. I agree that the search does not work very well, you often get a number of results and it is difficult to tell which is the important one - there is an open issue to provide context to the search results.

For giving people links you can link directly to any section by adding the section title e.g. https://manual.avolites.com/docs/en/titan-basics/front-panel-buttons/#keyboard-shortcuts

It would be a fairly major task to restructure it - I can look at it if everyone thinks it would be a good idea.