Fórum
Doc inconsistency with IDE
Gus Heck, modificado 12 Anos atrás.
Doc inconsistency with IDE
Junior Member Postagens: 39 Data de Entrada: 16/11/11 Postagens Recentes
On the ext dev page of the development guide (http://www.liferay.com/documentation/liferay-portal/6.1/development/-/ai/developing-an-ext-plug-4), it says:
[indent]"Before attempting to deploy an Ext plugin, it's necessary to edit the build.{username}.properties file in the root folder of your Plugins SDK." [/indent]
When I go to the file on disk it already exists and at the top it says:
Evidently I could remove the comment, and make the changes, but I assume that this prevents these variables from being managed in eclipse thereafter? Is it intrisic to ext development that one (presumably) breaks this IDE functionality? Or are the docs just out of date? Is there a way to set these values in the IDE?
[indent]"Before attempting to deploy an Ext plugin, it's necessary to edit the build.{username}.properties file in the root folder of your Plugins SDK." [/indent]
When I go to the file on disk it already exists and at the top it says:
#Managed by Liferay IDE (remove this comment to prevent future updates)
Evidently I could remove the comment, and make the changes, but I assume that this prevents these variables from being managed in eclipse thereafter? Is it intrisic to ext development that one (presumably) breaks this IDE functionality? Or are the docs just out of date? Is there a way to set these values in the IDE?
David H Nebinger, modificado 12 Anos atrás.
RE: Doc inconsistency with IDE
Liferay Legend Postagens: 14915 Data de Entrada: 02/09/06 Postagens Recentes
It's not an inconsistency, they're both technically true.
If not using the Liferay IDE and/or Liferay Developer Studio, you do have to edit build.{username}.properties so when Ant runs it knows where to put things.
When using the Liferay IDE and/or Liferay Developer Studio, these guys have a wizard to configure where your bundle is and it manages the build.{username}.properties for you so the IDE is in sync w/ where everything ends up.
The link you're looking at assumes that you are not using the Liferay IDE and LDS, so it's walking you through the steps you would need to do if you were manually doing the builds.
If not using the Liferay IDE and/or Liferay Developer Studio, you do have to edit build.{username}.properties so when Ant runs it knows where to put things.
When using the Liferay IDE and/or Liferay Developer Studio, these guys have a wizard to configure where your bundle is and it manages the build.{username}.properties for you so the IDE is in sync w/ where everything ends up.
The link you're looking at assumes that you are not using the Liferay IDE and LDS, so it's walking you through the steps you would need to do if you were manually doing the builds.
Gus Heck, modificado 12 Anos atrás.
RE: Doc inconsistency with IDE
Junior Member Postagens: 39 Data de Entrada: 16/11/11 Postagens RecentesDavid H Nebinger:
It's not an inconsistency, they're both technically true.
If not using the Liferay IDE and/or Liferay Developer Studio, you do have to edit build.{username}.properties so when Ant runs it knows where to put things.
When using the Liferay IDE and/or Liferay Developer Studio, these guys have a wizard to configure where your bundle is and it manages the build.{username}.properties for you so the IDE is in sync w/ where everything ends up.
The link you're looking at assumes that you are not using the Liferay IDE and LDS, so it's walking you through the steps you would need to do if you were manually doing the builds.
I would like to believe you, but only one of the three properties was actually in the file after setting up the ext in the IDE wizard. If this assumption is being made, it should be made explicit in the docs otherwise it's just confusing.
David H Nebinger, modificado 12 Anos atrás.
RE: Doc inconsistency with IDE
Liferay Legend Postagens: 14915 Data de Entrada: 02/09/06 Postagens Recentes
Except the doc you were looking at was just for developing and had nothing to do w/ the IDE. Since it wasn't being used in the doco, there was no reason to have an exclusion for something that hasn't been mentioned before. If a user is reading it and all of a sudden they see a line like "Don't do this if you're using the IDE", that will prove to be more confusing since the IDE hadn't been mentioned previously.
When you are adapting documentation to fit your own environment, you're expected to make certain adaptations on your own because the doco will never cover all possibilities. If you were following the instructions verbatim, you would have had no problem and would have sailed right through.
When you are adapting documentation to fit your own environment, you're expected to make certain adaptations on your own because the doco will never cover all possibilities. If you were following the instructions verbatim, you would have had no problem and would have sailed right through.
Gus Heck, modificado 12 Anos atrás.
RE: Doc inconsistency with IDE
Junior Member Postagens: 39 Data de Entrada: 16/11/11 Postagens RecentesDavid H Nebinger:
Except the doc you were looking at was just for developing and had nothing to do w/ the IDE.
I thought the IDE/studio was the recommended way to develop for liferay? Or are you recommending that we not use it? Is there separate docs for developing with the ide somewhere? If there's no docs for the IDE how helpful is that? It's not like the IDE is a minor variation or a 3rd party add-in, it's actually a rather large (and complex) feature.
In any case, that theoretical discussion about what should/shouldn't be documented aside, my point was that inspection of the file seems to indicate that the IDE is not inserting the required properties. That looks like a possible bug, or possibly the docs are out of date and the properties are not required anymore. If however the IDE manages those properties somewhere else, that's either possibly a design issue (what happens if both locations are populated?), and definitely something that should be documented if it is intentional (IMHO).
David H Nebinger, modificado 12 Anos atrás.
RE: Doc inconsistency with IDE
Liferay Legend Postagens: 14915 Data de Entrada: 02/09/06 Postagens Recentes
Come on, you're mixing things up here...
The Liferay IDE is the recommended development tool as it makes your life easier, but it is not required to do Liferay development. You could just as easily develop using Net Beans or even vi/emacs if your heart desires. The documentation link you were looking at explains how to use the SDK to develop plugins in general, and did not cover any specific development tools.
When you're in the Liferay IDE, it takes control over many of the aspects of using the SDK in order to hide the details. If you use the IDE, you don't have to worry about editing the build.{username}.properties file, etc., because the IDE takes care of it.
I believe there is online help for the IDE within Eclipse, including I believe a step by step guide for creating plugins within the IDE.
Since you're using the IDE, it was kind enough to insert a message into the build.{username}.properties file telling you the info is now managed by the IDE. If you choose to ignore that and set values on your own according to a doc that is designed to introduce you to the SDK and not the IDE, then do it. It shouldn't break anything per se, but it could result in your copying plugins to the wrong deploy directory because it's not the same one that Eclipse is still configured to use.
Now I'm sorry that you think the doco should say something like "don't do this if using the IDE", etc., but as an experienced technical writer I can tell you that documentation should be scoped to a specific purpose and anything outside of the scope should be excluded.
The Liferay IDE is the recommended development tool as it makes your life easier, but it is not required to do Liferay development. You could just as easily develop using Net Beans or even vi/emacs if your heart desires. The documentation link you were looking at explains how to use the SDK to develop plugins in general, and did not cover any specific development tools.
When you're in the Liferay IDE, it takes control over many of the aspects of using the SDK in order to hide the details. If you use the IDE, you don't have to worry about editing the build.{username}.properties file, etc., because the IDE takes care of it.
I believe there is online help for the IDE within Eclipse, including I believe a step by step guide for creating plugins within the IDE.
Since you're using the IDE, it was kind enough to insert a message into the build.{username}.properties file telling you the info is now managed by the IDE. If you choose to ignore that and set values on your own according to a doc that is designed to introduce you to the SDK and not the IDE, then do it. It shouldn't break anything per se, but it could result in your copying plugins to the wrong deploy directory because it's not the same one that Eclipse is still configured to use.
Now I'm sorry that you think the doco should say something like "don't do this if using the IDE", etc., but as an experienced technical writer I can tell you that documentation should be scoped to a specific purpose and anything outside of the scope should be excluded.
Gus Heck, modificado 12 Anos atrás.
RE: Doc inconsistency with IDE
Junior Member Postagens: 39 Data de Entrada: 16/11/11 Postagens Recentes
Ok, I'd like to eschew further debate about the theory of what should be documented where. I got to this page without reading the middle of page 6 (the caveat is there, but not easy to find) and so it wasn't clear to me that the documentation didn't apply to use of the IDE. Sorry, but I just don't read any documentation cover to cover ever, and I suspect most developers are like me.
The question that I tried to get to is whether or not there is a bug/problem or alternate location for the configuration that didn't show up in the properties file when I used the IDE. I'll revert that file let the IDE manage it, and see if things deploy or not. If I have problems, I'll file a bug since nobody seems to actually know the answer to the question of whether or not the IDE *should* have written those properties to the file. I was once told that the IDE is relies on the ant scripts, so I'm a bit worried about this...
The question that I tried to get to is whether or not there is a bug/problem or alternate location for the configuration that didn't show up in the properties file when I used the IDE. I'll revert that file let the IDE manage it, and see if things deploy or not. If I have problems, I'll file a bug since nobody seems to actually know the answer to the question of whether or not the IDE *should* have written those properties to the file. I was once told that the IDE is relies on the ant scripts, so I'm a bit worried about this...
David H Nebinger, modificado 12 Anos atrás.
RE: Doc inconsistency with IDE
Liferay Legend Postagens: 14915 Data de Entrada: 02/09/06 Postagens Recentes
The IDE does not write the values to the file, but it should still handle deployments correctly (certainly has been for me for the years I've been using it).
Gus Heck, modificado 12 Anos atrás.
RE: Doc inconsistency with IDE
Junior Member Postagens: 39 Data de Entrada: 16/11/11 Postagens Recentes
Including ext plugins?
David H Nebinger, modificado 12 Anos atrás.
RE: Doc inconsistency with IDE
Liferay Legend Postagens: 14915 Data de Entrada: 02/09/06 Postagens Recentes
Yep.