Magic Lantern Forum

General Discussion => Forum and Website => Topic started by: pedz on December 28, 2018, 04:26:35 PM

Title: ETTR documentation
Post by: pedz on December 28, 2018, 04:26:35 PM
I thought I'd put this here.

I'm going through the user guide (https://wiki.magiclantern.fm/userguide) and the camera help (https://wiki.magiclantern.fm/camera_help) and at the same time looking at my screen as well as the feature matrix (https://builds.magiclantern.fm/features.html).

I was slightly confused with the Auto ETTR section.  I didn't notice at first but there is a "see ettr.mo in Modules" line at the bottom of the section.  Perhaps the title could be changed or that line put at the top of the section?  I see there are two other places that do the same thing.

I'm happy to try and make the change but thought I'd check first.

Title: Re: ETTR documentation
Post by: Walter Schulz on December 28, 2018, 08:01:31 PM
Camera Help is under construction. Today it's mostly 1:1 copy of menu items plus corresponding entries displayed in bottom lines. Modules are the only items equipped with something worth to be called "help". When used inside camera. This help texts haven't made it into Camera Help. You will find a link to Bitbucket where the module's help text is located in Camera Help's modules section. (You may want to read this twice ....)

That's the reason why Camera Help's menu items generated by modules are messy right now (IMO) and I asked for input in Camera Help's module section:
Quote
For discussion: AFAIK modules tab is the only screen where help texts are included in code. And - besides activating and deactivating - additional help texts including submenu descriptions serve no purpose here. So: What are we actually doing here? Help texts and listings of submenu items are needed where the menu items are. Wrong?

Forum threads to read:
https://www.magiclantern.fm/forum/index.php?topic=20455.0
https://www.magiclantern.fm/forum/index.php?topic=22275.0

"User Guide" is outdated because it covers outdated v2.3 which actually had help entries for menu items.