Kepler: Issueshttps://projects.ecoinformatics.org/ecoinfo/https://projects.ecoinformatics.org/ecoinfo/ecoinfo/favicon.ico?14691340362012-08-18T08:14:59ZEcoinformatics Redmine
Redmine Bug #5690 (New): problems with updateActorDocshttps://projects.ecoinformatics.org/ecoinfo/issues/56902012-08-18T08:14:59ZDerik Barseghianbarseghian@nceas.ucsb.edu
<p>I ran into a few issues updating EcogridWriter documentation using:<br />./kepler.sh -updateActorDocs actors/resources/kar/CoreActors/EcogridWriter.xml</p>
<p>1) the actor LSID revision wasn't incremented (and the corresponding entry in CoreActor's manifest). Maybe simply a warning should be printed.<br />2) port documentation didn't show up in kepler, because the variable names for the ports were used, instead of the assigned names. Using the variable (default) names like this is probably the best though, since port names can be dynamically created, as can ports themselves. But the target should probably print out a warning that the developer should check/fix port doc by hand.<br />3) special chars were inserted for linebreaks (not that line breaks seem to get displayed anyways)</p>
<p>Bonus enhancement request:<br />4)It would be cool if the resulting xml were run through a 'pretty print'.</p> Bug #5559 (New): Curation Package User Manual PDFhttps://projects.ecoinformatics.org/ecoinfo/issues/55592011-12-01T01:16:31ZBob Morrismorris.bob@gmail.com
<p>The Kuration Package User Manual PDF would be easier to use if the pages carried page numbers.</p> Bug #5354 (New): Integrate Kepler Wiki Into Kepler Helphttps://projects.ecoinformatics.org/ecoinfo/issues/53542011-03-22T00:40:30ZDavid Welkerdavid.v.welker@gmail.com
<p>Sven has an idea. When running Kepler, there should be two types of help. One for users and one for developers. Both should be accessible from the Help menu, and should reference appropriate places on the Kepler wiki. This should be integrated with the current help information all of which should be organized in a logical manner.</p> Bug #5340 (New): Miss a dollar sing ($) when an actor references a parameter.https://projects.ecoinformatics.org/ecoinfo/issues/53402011-03-04T23:05:26ZJing Taotao@nceas.ucsb.edu
<p>On Figure 3.20 (page 66) of KeplerUserManual-2.1.0.doc, it shows how to reference a parameter OutputDir. It shows:</p>
<p>OutputDir+"ccov6190"</p>
<p>But it doesn't work in this way. It should be:</p>
<p>$OutputDir+"ccov6190"</p>
<p>A dollar sign is missed.</p> Bug #5327 (New): Need to fix documentation systemhttps://projects.ecoinformatics.org/ecoinfo/issues/53272011-02-25T23:38:36ZDavid Welkerdavid.v.welker@gmail.com
<p>Our current documentation system creates a lot of unnecessary work and has excessive overhead to produce updated documentation for even minor changes. As a result, documentation tends not to be updated incrementally as would be ideal. Also, at release time, dealing with the production of documentation consumes much more time than it should.</p>
<p>Basically, the approach we have now is that our documentation is separated into Word documents, one Word document per chapter. Already, this limits the ability of people to contribute to the documentation to those who have Microsoft Word or perhaps OpenOffice. Requiring users to have Microsoft Word already goes significantly against the spirit of an open source project in my view. While OpenOffice, in contrast, is open source, I am not sure if it is fully compatible or not. It probably is if all you are editing is text, but may have more difficulty with other sorts of document structures. Further, since the documents tend to be large, it often takes quite a bit of time to load, even though this is partially ameliorated by only storing a single chapter in a Word document. Finally, when it comes time to compile these documents for delivery, it is a tedious process to arrange the correct documents in the correct order without any unexpected issues. Also, I think an issue that has come up in this release that also appeared in this release is that the links in the generated PDF files did not work.</p>
<p>A better approach to documentation would:</p>
<p>First and foremost be able to compile all existing documentation with a single command. There is really no good reason to have so many steps for human intervention, and hence mistakes since it should be possible, in both theory and practice, to have a simple working PDF produced with a single command. Furthermore, there is really no good reason for us to tie our documentation to a proprietary product, like Microsoft Word. Especially since we are an open source project.</p>
<p>Second, we should be able to edit documentation without any software besides a web browser. By easing the overhead of updating documentation, we are much liker to have documentation that is updated more often, to be more accurate, and of a higher quality. I believe that there might be solutions out there that allow the editing of documentation by anyone from a web browser (something like Wikibooks might do the trick, but more research is necessary). If we found a way to allow the documentation to be edited from the browser, this would make it easier to update the documentation as we work and also in response to questions we get from the community. Also, it would allow more people to be able to easier contribute to the documentation, whether or not they have Microsoft Word, whether or not they know how to access our repositories to access the current documentation and whether or not they could figure out how our current documents are structured and whether or not they have write access to our SVN repository.</p>
<p>Perhaps getting documentation that is fully editable from any browser is unrealistic. It depends on the adequacy for our needs of open source projects (like Wikibooks) and also how much effort would be involved to take our current documentation from Microsoft Word format into the more open formats supported by these projects. But at the very least, we should strongly consider at least moving away from solutions that require access to proprietary software and which are error prone when converting from the format in which documents are written into their final form.</p> Bug #4909 (New): Actor documentation: updates ignored, duplicate info, how to refer to other acto...https://projects.ecoinformatics.org/ecoinfo/issues/49092010-03-29T21:15:59ZChristopher Brookscxh@eecs.berkeley.edu
<p>A few comments about the Kepler Actor Documentation system</p>
<p>1. If I update the .xml file for a Director, then preexisting models<br />do not get the updates. I think this is wrong. For example,<br />I added text to PNDirector.xml. If a user has a preexisting model<br />that uses PNDirector, then to see the new text, they would need<br />to drag in a new PNDirector.</p>
<p>2. The model files contain copies of the documentation. This is<br />related to point 1 above. This will be an issue for large systems<br />because parsing a large file with redundant info takes time and<br />possibly consumes lots of memory</p>
<p>3. In a documentation .xml file, how do I refer to another actor<br />or director? For example in<br />kepler/directors/resources/kar/CoreDirectors/PNDirector.xml<br />I want to refer to the Ramp actor so that if the user<br />clicks on the link, then they are shown the Ramp actor documentation<br />How do I do that?</p>
<p>4. In a documentation .xml file, how do I refer to a model?<br />For example, in<br />kepler/directors/resources/kar/CoreDirectors/PNDirector.xml<br />I want to refer to<br />ptolemy/domains/pn/demo/RemoveNilTokens/RemoveNilTokens.xml<br />How do I do that?</p> Bug #4908 (New): actor/director/attribute .xml file documentation needs to be updatedhttps://projects.ecoinformatics.org/ecoinfo/issues/49082010-03-29T21:05:36ZChristopher Brookscxh@eecs.berkeley.edu
<p>The kar files include documentation for actors, directors and attributes.</p>
<p>These files need to be checked against the corresponding Ptolemy<br />actors, directors and attributes and updated accordingly.</p>
<p>For example, the directors/resources/kar/CoreDirectors/PNDirector.xml<br />file did not include information from June, 2008 about how to stop<br />a PN model.</p>
<p>To fix this bug, all of the .kar files should be reviewed and compared<br />with the original class comments in the .java files.</p> Bug #4700 (In Progress): Reminder Update Wiki information to reflect Kepler 2.0 release.https://projects.ecoinformatics.org/ecoinfo/issues/47002010-01-27T22:40:59Zdebi staggsstaggs@nceas.ucsb.edu
<p>Update the information on the Wiki to include changes to Kepler in the 2.0 release. Remove any information in the Wiki that is now outdated or inaccurate.</p> Bug #4699 (In Progress): Reminder Bug Update FAQ to reflect Kepler 2.0 releasehttps://projects.ecoinformatics.org/ecoinfo/issues/46992010-01-27T22:39:11Zdebi staggsstaggs@nceas.ucsb.edu
<p>Update the FAQ with the 2.0 release features. Remove any statements in the FAQ that are outdated or no longer accurate.</p> Bug #4667 (In Progress): New documentation on modules and extension points for moduleshttps://projects.ecoinformatics.org/ecoinfo/issues/46672010-01-13T22:49:25ZChad Berkleyberkley@nceas.ucsb.edu
<p>Should include information on the config system, karentryhandlers, viewpanes,<br />adding icons to the config, etc. See the Initialize methods of wrm and provenance for more info.</p> Bug #4012 (New): update documentation to explain adding actor to library via KARhttps://projects.ecoinformatics.org/ecoinfo/issues/40122009-04-22T16:29:17ZMatt Jonesjones@nceas.ucsb.edu
<p>The current Hello World Tutorial stops the tutorial at using 'Instantiate Component' to place an actor on the canvas. <br /> <a class="external" href="https://kepler-project.org/developers/teams/build/developing-a-hello-world-actor-using-the-kepler-build-system-and-eclipse">https://kepler-project.org/developers/teams/build/developing-a-hello-world-actor-using-the-kepler-build-system-and-eclipse</a><br />Most users want to also add their actor to their library pane. This is described in Sections 10.3 and 10.4 of the User Manual:<br /> <a class="external" href="https://code.kepler-project.org/code/kepler-docs/trunk/outreach/documentation/shipping/UserManual.pdf">https://code.kepler-project.org/code/kepler-docs/trunk/outreach/documentation/shipping/UserManual.pdf</a></p>
<p>The Hello World tutorial should be extended with an additional step that shows how to create a KAR file and import it into Kepler's Library. The User Manual should also be checked to be sure that the instructions are still correct.</p> Bug #3774 (New): Hello World demo causes UI to become unresponsive and require restarthttps://projects.ecoinformatics.org/ecoinfo/issues/37742009-01-23T19:59:31ZDavid Groulxgroulx@nceas.ucsb.edu
<p>The basic network described in getting-started-guide.pd, pg 30 causes the UI to freeze up. This network consists of a String Constant connected to a Display actor with an SDF director. The only default parameter changed was the value of the String Constant. See specified URL for the workflow file I am using.</p>
<p>uname -a:<br />Darwin dhcp87.nceas.ucsb.edu 9.6.0 Darwin Kernel Version 9.6.0: Mon Nov 24 17:37:00 PST 2008; root:xnu-1228.9.59~1/RELEASE_I386 i386</p>
<p>java -version:<br />java version "1.5.0_16" <br />Java(TM) 2 Runtime Environment, Standard Edition (build 1.5.0_16-b06-284)<br />Java HotSpot(TM) Client VM (build 1.5.0_16-133, mixed mode, sharing)</p>
<p>svn info:<br />URL: <a class="external" href="https://code.kepler-project.org/code/kepler/trunk/modules/build-area">https://code.kepler-project.org/code/kepler/trunk/modules/build-area</a><br />Repository Root: <a class="external" href="https://code.kepler-project.org/code/kepler">https://code.kepler-project.org/code/kepler</a><br />Repository UUID: edc41a2b-3e5c-0410-9d3f-8540a70682f1<br />Revision: 16428<br />Node Kind: directory<br />Schedule: normal<br />Last Changed Author: welker<br />Last Changed Rev: 16426<br />Last Changed Date: 2009-01-22 14:33:48 -0800 (Thu, 22 Jan 2009)</p> Bug #3392 (New): Need scrollbars in Documentation > Customize Documentation windowhttps://projects.ecoinformatics.org/ecoinfo/issues/33922008-06-12T18:36:49ZKirsten Menger-Andersonkma500@hotmail.com
<p>When a workflow has many parameters, the customize documentation screen does not generate a scroll bar so that people can scroll down and enter values for parameters that don't appear on the screen; it's also impossible to commit customized documentation, since the UI buttons are pushed offscreen, too.</p>
<p>An example of this problem can be found when trying to customize documentation for the SimHofi workflow:<br /> <a class="external" href="https://code.ecoinformatics.org/code/reap/trunk/usecases/terrestrial/workflows/HosseiniSimulationWorkflow/simhofi.xml">https://code.ecoinformatics.org/code/reap/trunk/usecases/terrestrial/workflows/HosseiniSimulationWorkflow/simhofi.xml</a></p>
<p>Right-click the Workflow canvas and select Customize Documentation.</p> Bug #2265 (New): Simple Kepler features movie to be displayed at the 1st time installationhttps://projects.ecoinformatics.org/ecoinfo/issues/22652005-11-11T00:07:42ZIlkay Altintasaltintas@sdsc.edu
<p>Build up of a small movie or a slide show that walks to user through the basic<br />features of Kepler. The suggestion is to open this with the application the<br />first time a user installs Kepler as an optional movie and make it reachable<br />through a menu item at other times.</p> Bug #2140 (New): need dataset extraction WF for documentation/example purposeshttps://projects.ecoinformatics.org/ecoinfo/issues/21402005-07-05T21:20:47ZChad Berkleyberkley@nceas.ucsb.edu
<p>We need a simple dataset extraction workflow for documentation/example purposes.<br /> This goes along with the helloworld and R workflows. This was decided at the<br />june 05 kepler meeting.</p>