userguide icon indicating copy to clipboard operation
userguide copied to clipboard

Mac OS X installer

Open georgebina opened this issue 11 years ago • 2 comments

Hi Mark,

There is no installer for Mac OS X, we provide only a zip distribution. This is different from the all platforms distribution because it is tuned for Mac OS X and removes other platform specific scripts. Starting with version 16.0 we also made available an zip archive that contains a Java 8 JRE, the default archive does not contain a JRE and uses Java 6 that is still available on Mac. I think we should remove the executableInstallMac key and replace its use with the archiveInstallMac key.

georgebina avatar Jul 25 '14 07:07 georgebina

Hi George,

There is the oxygen.app inside the oxygen.zip file, which you run during the install. I have defined both executableInstllMac (oxygen.app) and archiveInstallMac (oxygen.zip).

That said, as I noted in the checkin notice, there are still cases where you can’t use the key. If the purpose of defining the key is to make sure that you only have to change it in one place, we are not achieving that end. There are also other references in the content to executable and archives that are not keyed, so currently we have this policy for one executable and not for others. Overall, I think this is going to turn out to be more of a maintenance headache than if we put the executable names in plain text.

Also, in trying to achieve this, I have had to remove markup from around the install name, so we are losing some semantics here.

True, the alternative is to have a set of alternatives inline with conditions applied to each one, but they allow for the inclusion of the markup and we can insert them with conrefs without setting up an expectation that there is a single global place to reliably change all executable names.

Trying to insert a lot of variables into content often runs into the problem of too many cases and too many exceptions, which often leaves you with incomplete use of variables across the content set. This makes maintenance (and authoring) more difficult, not less, because you have to search for both variables and plain text to make a change. In these cases, keeping it simple is often better than introducing more abstraction.

Let me know what you think.

Mark

From: George Bina [mailto:[email protected]] Sent: Friday, July 25, 2014 3:18 AM To: oxygenxml/userguide Subject: [userguide] Mac OS X installer (#10)

Hi Mark,

There is no installer for Mac OS X, we provide only a zip distribution. This is different from the all platforms distribution because it is tuned for Mac OS X and removes other platform specific scripts. Starting with version 16.0 we also made available an zip archive that contains a Java 8 JRE, the default archive does not contain a JRE and uses Java 6 that is still available on Mac. I think we should remove the executableInstallMac key and replace its use with the archiveInstallMac key.

— Reply to this email directly or view it on GitHub https://github.com/oxygenxml/userguide/issues/10 . https://github.com/notifications/beacon/1695653__eyJzY29wZSI6Ik5ld3NpZXM6QmVhY29uIiwiZXhwaXJlcyI6MTcyMTg5MTg5MSwiZGF0YSI6eyJpZCI6Mzc5NDY3MjR9fQ==--b33734c9c45e5abef45d0bbe219ebe6d13038a66.gif

mbakeranalecta avatar Jul 25 '14 11:07 mbakeranalecta

Hi Mark,

Inside the zip there is a folder that contains multiple startup scripts or startup executables but these are different from an installation executable, they are used to start the application not to install it. The .app file is both an executable, in the sense that you can double click on it to start an application and a folder, you can use a contextual action to open its content in the OS X Finder application.

I agree that there may be an issue if we loose markup but we can use which should work fine.

In the specific case you mentioned in the commit comment we can have instead of profiling something like: /Contents/MacOS assuming executableMacOSX is defined as Oxygen.app for editor, etc.

It may be indeed too much overhead now to use keys so we can just replace these installer keys with conditional markup, possibly conrefed from a topic like DITA/topics/oxygenEntitiesDictionary.dita and we will refactor them later on to keys once we analyze also all the places these appear in the documentation.

Best Regards,

George

George Cristian Bina <oXygen/> XML Editor, Schema Editor and XSLT Editor/Debugger http://www.oxygenxml.com

On 7/25/14, 2:11 PM, Mark Baker wrote:

Hi George,

There is the oxygen.app inside the oxygen.zip file, which you run during the install. I have defined both executableInstllMac (oxygen.app) and archiveInstallMac (oxygen.zip).

That said, as I noted in the checkin notice, there are still cases where you can’t use the key. If the purpose of defining the key is to make sure that you only have to change it in one place, we are not achieving that end. There are also other references in the content to executable and archives that are not keyed, so currently we have this policy for one executable and not for others. Overall, I think this is going to turn out to be more of a maintenance headache than if we put the executable names in plain text.

Also, in trying to achieve this, I have had to remove markup from around the install name, so we are losing some semantics here.

True, the alternative is to have a set of alternatives inline with conditions applied to each one, but they allow for the inclusion of the markup and we can insert them with conrefs without setting up an expectation that there is a single global place to reliably change all executable names.

Trying to insert a lot of variables into content often runs into the problem of too many cases and too many exceptions, which often leaves you with incomplete use of variables across the content set. This makes maintenance (and authoring) more difficult, not less, because you have to search for both variables and plain text to make a change. In these cases, keeping it simple is often better than introducing more abstraction.

Let me know what you think.

Mark

From: George Bina [mailto:[email protected]] Sent: Friday, July 25, 2014 3:18 AM To: oxygenxml/userguide Subject: [userguide] Mac OS X installer (#10)

Hi Mark,

There is no installer for Mac OS X, we provide only a zip distribution. This is different from the all platforms distribution because it is tuned for Mac OS X and removes other platform specific scripts. Starting with version 16.0 we also made available an zip archive that contains a Java 8 JRE, the default archive does not contain a JRE and uses Java 6 that is still available on Mac. I think we should remove the executableInstallMac key and replace its use with the archiveInstallMac key.

— Reply to this email directly or view it on GitHub https://github.com/oxygenxml/userguide/issues/10 . https://github.com/notifications/beacon/1695653__eyJzY29wZSI6Ik5ld3NpZXM6QmVhY29uIiwiZXhwaXJlcyI6MTcyMTg5MTg5MSwiZGF0YSI6eyJpZCI6Mzc5NDY3MjR9fQ==--b33734c9c45e5abef45d0bbe219ebe6d13038a66.gif

— Reply to this email directly or view it on GitHub https://github.com/oxygenxml/userguide/issues/10#issuecomment-50136023.

georgebina avatar Jul 25 '14 11:07 georgebina