Minor webpage documentation clarification for HDRI

Questions and postings pertaining to the development of ImageMagick, feature enhancements, and ImageMagick internals. ImageMagick source code and algorithms are discussed here. Usage questions which are too arcane for the normal user list should also be posted here.
Locked
User avatar
Skygaze
Posts: 23
Joined: 2018-03-19T15:42:47-07:00
Authentication code: 1152
Contact:

Minor webpage documentation clarification for HDRI

Post by Skygaze »

Hi, I have some simple suggestions for the HDRI and Windows build pages - is this the right place to post them? Some things are obvious to experts, but not being one, I stumbled a bit. Perhaps I could help in a small way?
Regards,
Alister.

snibgo
Posts: 13034
Joined: 2010-01-23T23:01:33-07:00
Authentication code: 1151
Location: England, UK

Re: Minor webpage documentation clarification for HDRI

Post by snibgo »

Yes, please do. The official documentation is on github so you can pull or push requests or whatever it is, if you know how to (I don't).

Otherwise, put suggestions here, with the URLs of the web pages.
snibgo's IM pages: im.snibgo.com

User avatar
Skygaze
Posts: 23
Joined: 2018-03-19T15:42:47-07:00
Authentication code: 1152
Contact:

Re: Minor webpage documentation clarification for HDRI

Post by Skygaze »

I will try a pull request.
TTFN,
Alister.

User avatar
fmw42
Posts: 26383
Joined: 2007-07-02T17:14:51-07:00
Authentication code: 1152
Location: Sunnyvale, California, USA

Re: Minor webpage documentation clarification for HDRI

Post by fmw42 »

Perhaps you should share your thoughts/suggestions here first before editing the documentation.

User avatar
Skygaze
Posts: 23
Joined: 2018-03-19T15:42:47-07:00
Authentication code: 1152
Contact:

Re: Minor webpage documentation clarification for HDRI

Post by Skygaze »

I managed to create a pull for the first page before seeing your comment. This first one (shown below) is just a one-line change, and I will post the others here tomorrow before creating pulls. The others are of similar "clarification" nature. Very minor in the scheme of things but would have saved me 3 or 4 hours in avoiding dead ends.

My change on https://magick.imagemagick.org/script/h ... -range.php is:
old: "Under Windows, uncomment the MAGICKCORE_HDRI_SUPPORT definition in the magick-baseconfig.h configuration file and build"
new: "Under Windows, follow the instructions (straightforward for a non-programmer) in a one hour process to build and configure your own executables: <a href="https://imagemagick.org/script/install- ... p">Install from Windows Source</a>"

Justification:
Line 25: the instruction "uncomment the MAGICKCORE_HDRI_SUPPORT definition in the magick-baseconfig.h configuration file" is outdated, since that file does not exist in 7.0.9-22. The comment "(straightforward for a non-programmer)" might seem obvious to an expert, but because I had never done this before I was nervous and uncertain - I hope this comment will reassure non-experts. The link to https://imagemagick.org/script/install-source.php is useful since I could only find it with a search on github.

For reference:
The github link for updating www content sent me here: https://github.com/ImageMagick/Website. Click on find file and type in part of the page title; it should be enough to get you a list of the docs. It will also automatically fork the page for you when you click on edit.

User avatar
Skygaze
Posts: 23
Joined: 2018-03-19T15:42:47-07:00
Authentication code: 1152
Contact:

Re: Minor webpage documentation clarification for HDRI

Post by Skygaze »

For the install from windows source (https://magick.imagemagick.org/script/i ... hp#windows), I recommend the following changes, all in the spirit of encouraging the non-expert to not give up too soon (I almost did).

1) Directly under the section header "Install from Windows Source" I think it is appropriate to say something like:
"We recommend you first uninstall an existing ImageMagick, else you might be surprised that your magick/convert commands go to the old version."

2) Current: "Building ImageMagick source for Windows requires a modern version of Microsoft Visual Studio IDE"
Suggested: "Building ImageMagick source for Windows requires a modern version of Microsoft Visual Studio IDE (free)"

3) Current: "Clone the Github repo:" .... Alternatively download ImageMagick-windows.zip ....
Suggested: "Method 1: Clone the Github repo:" .... <p>Method 2: download ImageMagick-windows.zip ...

4) Before "Next, launch" suggest adding "Unzip in a folder that does not need Admin permissions, otherwise Visual Studio will not be able to build the solution." [Learned this the hard way]

5) Current: " and press Open"
Suggested: " and press Open configure.sln"
Rationale: I first chose "configure.vcxproj" because it looked like a project! And lost 45 minutes backtracking.

6) Remove the sentence containing "If you are using the Visual Studio 6.0 IDE...." since we are at V 16.

7) Before the line "For a more comprehensive test"
suggest adding "You may want to add the full path to VisualMagick\bin for your environment PATH variable, so you can call Magick/convert from any directory."

That's it! Like I said, gives the non-expert a clearer set of directions.

snibgo
Posts: 13034
Joined: 2010-01-23T23:01:33-07:00
Authentication code: 1151
Location: England, UK

Re: Minor webpage documentation clarification for HDRI

Post by snibgo »

Skygaze wrote:Suggested: "Building ImageMagick source for Windows requires a modern version of Microsoft Visual Studio IDE (free)"
I suggest changing "requires" to "can be done with". I've been building IM on Windows with GNU tools for years, without "requiring" MS VS.
snibgo's IM pages: im.snibgo.com

User avatar
Skygaze
Posts: 23
Joined: 2018-03-19T15:42:47-07:00
Authentication code: 1152
Contact:

Re: Minor webpage documentation clarification for HDRI

Post by Skygaze »

Seeing no more comments and having received a request on github to complete the doc edits, I have done so, included snibgo's suggested mod. For the time being, consider this thread ended.

Locked