New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Added References for installed tools and libraries, whenever available, to the Help menu. #2804

Merged
merged 5 commits into from Nov 18, 2014

Conversation

Projects
None yet
2 participants
@joelmoniz
Copy link
Member

joelmoniz commented Aug 19, 2014

The most notable change is the addition of a new class: LocalContribWithReference, to avoid repetition of code, as well as to make adding References to fututre contribution types (like modes, for example), much easier.

EDIT: Sorry. Forgot to say: This fixes #943.

@benfry

This comment has been minimized.

Copy link
Member

benfry commented Aug 19, 2014

Why would contributions with and without reference be separate?

@joelmoniz

This comment has been minimized.

Copy link
Member

joelmoniz commented Aug 19, 2014

Because those with reference need a few extra functions, mostly to handle showing the reference in the help menu at present, though the functionality could be extended over time.

@benfry

This comment has been minimized.

Copy link
Member

benfry commented Aug 19, 2014

But why add a new type, rather than just adding support to the current code to cover reference?

@joelmoniz

This comment has been minimized.

Copy link
Member

joelmoniz commented Aug 19, 2014

I didn't add a new type, just a new class which the library and tool contribution types extend in place of the LocalContribution class, and which, in turn, extends from the LocalContribution class, as per Florian's suggestion; primarily to avoid repetition of code in both the Library and Tool types (since the code is identical), and also to enable adding more features to contribution types that have references, later, if needed. Should I remove the class, and distribute the code across the Library and Tool classes instead?

@benfry

This comment has been minimized.

Copy link
Member

benfry commented Nov 14, 2014

A new class is a new type. ;-)

Is it necessary to have a subclass, or can this simply go in LocalContribution?

@joelmoniz

This comment has been minimized.

Copy link
Member

joelmoniz commented Nov 15, 2014

Sure, I agree. I'll remove the new class, add all changes to LocalContribution and resolve all merge conflicts.
Thanks.

@benfry

This comment has been minimized.

Copy link
Member

benfry commented Nov 15, 2014

Thanks! We're all together in Denver working on 3.0 this weekend, so if you have a chance to do it soon, that'd be great.

@joelmoniz

This comment has been minimized.

Copy link
Member

joelmoniz commented Nov 15, 2014

Sure thing! I'll have it in by tomorrow?

On Sat, Nov 15, 2014 at 10:26 PM, Ben Fry notifications@github.com wrote:

Thanks! We're all together in Denver working on 3.0 this weekend, so if
you have a chance to do it soon, that'd be great.


Reply to this email directly or view it on GitHub
#2804 (comment)
.

@benfry

This comment has been minimized.

Copy link
Member

benfry commented Nov 15, 2014

That'd be great, thanks.

Also, your recent check-in had your file encoded with a Unicode BOM (byte order mark) at the beginning for the file. Make sure those are turned off in your editor. All files should just be UTF-8, no BOM.

@joelmoniz

This comment has been minimized.

Copy link
Member

joelmoniz commented Nov 16, 2014

Oops. Sure thing. Thanks.

On Sun, Nov 16, 2014 at 2:35 AM, Ben Fry notifications@github.com wrote:

That'd be great, thanks.

Also, your recent check-in had your file encoded with a Unicode BOM (byte
order mark) at the beginning for the file. Make sure those are turned off
in your editor. All files should just be UTF-8, no BOM.


Reply to this email directly or view it on GitHub
#2804 (comment)
.

@joelmoniz joelmoniz force-pushed the joelmoniz:addReferences branch from 392054a to 449905b Nov 17, 2014

Tool and Lib References now show in Help menu
Removing LocalContribWithReference.java
@joelmoniz

This comment has been minimized.

Copy link
Member

joelmoniz commented Nov 17, 2014

@benfry : The LocalContribWithReference class has been removed, and all merge conflicts have been resolved. Sorry for the slight delay.

@benfry

This comment has been minimized.

Copy link
Member

benfry commented Nov 17, 2014

@joelmoniz regarding #2954 (comment), you said you've reverted the commit, though I'm still seeing this stuff here:

final String potentialFileList[] = {
      "reference/index.html", "reference/index.htm",
      "documentation/index.html", "documentation/index.htm", "docs/index.html",
      "docs/index.htm", "documentation.html", "documentation.htm",
      "reference.html", "reference.htm", "docs.html", "docs.htm", "readme.txt" };

(Or perhaps you're in the middle of finishing the PR?)

@joelmoniz joelmoniz force-pushed the joelmoniz:addReferences branch from ddc7bd0 to cc68c83 Nov 17, 2014

@joelmoniz

This comment has been minimized.

Copy link
Member

joelmoniz commented Nov 18, 2014

Sorry. When reverting, things didn't merge properly, and it also seems that a simple revert wouldn't suffice, since some of the later commits depend on functions declared in the commit that I had reverted (although things built and worked fine because of the improper revert). Everything should hopefully be alright now. Thanks.

benfry added a commit that referenced this pull request Nov 18, 2014

Merge pull request #2804 from joelmoniz/addReferences
Added References for installed tools and libraries, whenever available, to the Help menu.

@benfry benfry merged commit 65bed4f into processing:master Nov 18, 2014

@benfry

This comment has been minimized.

Copy link
Member

benfry commented Nov 18, 2014

Thanks! Much better (and half as much code!)

@joelmoniz joelmoniz deleted the joelmoniz:addReferences branch Dec 14, 2014

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment