Skip to content

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

Merged
benfry merged 5 commits into
processing:masterfrom
joelmoniz:addReferences
Nov 18, 2014
Merged

Added References for installed tools and libraries, whenever available, to the Help menu.#2804
benfry merged 5 commits into
processing:masterfrom
joelmoniz:addReferences

Conversation

@joelmoniz

Copy link
Copy Markdown
Member

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

benfry commented Aug 19, 2014

Copy link
Copy Markdown
Contributor

Why would contributions with and without reference be separate?

@joelmoniz

Copy link
Copy Markdown
Member Author

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

benfry commented Aug 19, 2014

Copy link
Copy Markdown
Contributor

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

@joelmoniz

Copy link
Copy Markdown
Member Author

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

benfry commented Nov 14, 2014

Copy link
Copy Markdown
Contributor

A new class is a new type. ;-)

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

@joelmoniz

Copy link
Copy Markdown
Member Author

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

@benfry

benfry commented Nov 15, 2014

Copy link
Copy Markdown
Contributor

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

Copy link
Copy Markdown
Member Author

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

benfry commented Nov 15, 2014

Copy link
Copy Markdown
Contributor

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

Copy link
Copy Markdown
Member Author

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)
.

Removing LocalContribWithReference.java
@joelmoniz

Copy link
Copy Markdown
Member Author

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

@benfry

benfry commented Nov 17, 2014

Copy link
Copy Markdown
Contributor

@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

Copy link
Copy Markdown
Member Author

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
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

benfry commented Nov 18, 2014

Copy link
Copy Markdown
Contributor

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

@joelmoniz joelmoniz deleted the addReferences branch December 14, 2014 14:02
@github-actions

Copy link
Copy Markdown

This pull request has been automatically locked since there has not been any recent activity after it was closed. Please open a new issue for related bugs.

@github-actions github-actions Bot locked as resolved and limited conversation to collaborators Jun 15, 2021
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

add reference for contributed libraries to the Help menu

2 participants