Skip to content
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

Updated Notes View Help #1592

Merged
merged 1 commit into from Dec 10, 2021
Merged

Updated Notes View Help #1592

merged 1 commit into from Dec 10, 2021

Conversation

antares1470
Copy link
Collaborator

Prerequisites

  • Reviewed the checklist

  • Reviewed feedback from the "Sonar Cloud" bot. Note that you have to wait
    for the "CI / Unit Tests") to complete first. Failed Unit tests can be
    debugged by adding the label "verbose logging" to the GitHub PR.

Description of the Change

The Notes View help was a little out of date so I've made the minor changes needed to update it

Alternate Designs

Why Should This Be In Core?

Updating doco

Benefits

Up to date help

Possible Drawbacks

Verification Process

Applicable Issues

@sonarcloud
Copy link

sonarcloud bot commented Dec 10, 2021

Kudos, SonarCloud Quality Gate passed!    Quality Gate passed

Bug A 0 Bugs
Vulnerability A 0 Vulnerabilities
Security Hotspot A 0 Security Hotspots
Code Smell A 0 Code Smells

No Coverage information No Coverage information
No Duplication information No Duplication information

@antares1470 antares1470 merged commit ed2be92 into master Dec 10, 2021
@antares1470 antares1470 deleted the bugfix/notes-view-help branch December 10, 2021 02:35
arcturus2 added a commit that referenced this pull request Mar 3, 2022
* Module code cleanup (#1575)

* AnalyticSchema cleanup

* AttributeEditor cleanup

* Functionality cleanup

* GraphFile cleanup

* AlgorithmPlugins cleanup

* AnalyticView cleanup

* ArrangementPlugins cleanup

* fix review comments

* code review changes

* remove early exit case for loading help documents in release versions (#1587)

* remove early exit for release versions

* Update GeneratorNGTest.java

* Add verbose test logging by PR label (#1588)

* add verbose logging by label

* Update run-tests.sh

* remove extraneous quote and logging

* Adding logging of verbosity

* Update PULL_REQUEST_TEMPLATE.md

* Unit tests for IconData and UriIconData (#1560)

* Unit tests for IconData and UriIconData

The equals method in IconData was also refactored.

* Fix code smells

* Cover more test conditions

* Revert code smell fixes

Caused 2 unit tests to fail

* Add requested changes

* Add further test case

* Covered further test cases

* Fix code smell

* Add requested changes

Removed setter only used for testing and refactored code work without it.

* Sonar clean up (#1591)

* Remove nested Switch blocks

* Fixed exceptions to be either logged or rethrown but not both

* Open curly brace locate at the end of a line

* Remove local variables which were declared and then immediately returned or thrown

* Fix static base class members to not be accessed via derived types

* Remove duplicated string literals.

* Replace replaceAll() with replace()

* Adding finals

* updated notes view help (#1592)

* Update VisualGraphOpener.java (#1598)

* Add text to respresent that a quality category is changed from the default (#1596)

* Update QualityControlViewPane.java

* Update whatsnew.txt

* Update WelcomeViewPane.java (#1595)

* added missing attribute check to table view (#1603)

* Fix importer inconsistencies and bug fixes (#1602)

* Fix the importer inconsistencies and satus message

* Fix the database importer status message and add Changelog entry

* Fix the row filter style when files are added later

* Convert to a ternary statement

* Remove redundant parameter and brief refactor to fix sonar issues.

* Change fonts to align with KTruss (#1597)

* Add nightly build script to CI (#1593)

* Create nightly-build.yml

* change cron time

* run monday to friday

* verbose logging on label fix (#1594)

* add verbose logging by label

* Update run-tests.sh

* remove extraneous quote and logging

* Adding logging of verbosity

* Update PULL_REQUEST_TEMPLATE.md

* revalidate before setting verbosity

* Update build-and-scan.yml

* Update build-and-scan.yml

* Update build-and-scan.yml

* Update build-and-scan.yml

* Update build-and-scan.yml

* Update build-and-scan.yml

* Update build-and-scan.yml

* Update build-and-scan.yml

* Update build-and-scan.yml

* Update build-and-scan.yml

* change runtests

* Update build-and-scan.yml

* Update build-and-scan.yml

* Update build-and-scan.yml

* Update build-and-scan.yml

* Update build-and-scan.yml

* Update build-and-scan.yml

* Update build-and-scan.yml

* Update build-and-scan.yml

* Update build-and-scan.yml

* Update build-and-scan.yml

* Update build-and-scan.yml

* Update build-and-scan.yml

* Update build-and-scan.yml

* Prevent exception of divide by zero in k-truss (#1604)

* prevent exception of divide by zero

* review if condition evaluation

* Unit testing JsonUtilities (#1556)

* Start of unit testing

* Additional tests capturing some gets. Also fixed a bug in getDoubleFiled that was incorrectly calling getLongfield resulting in truncation.

* Added Boolean tests

* Testing all iterators.

* Further testing

* Testing of getText value methods ... some minor rework to unit under test. More comments to be added.

* Test constructor

* Try commit without constructor, looks like other sonar ticket adding as well

* Code review comments

Code review comments

* Code review comments

* Update width of Property Value text on Histogram  (#1614)

* Update width of property value text

* Added finals

* Map view various fixes (#1609)

* add validation to asserts

* review if condition logic

* added unit tests for Response class (#1612)

* added unit tests for multipart (#1611)

* Add selected count to histogram display (#1605)

* add selected count to histogram display

* add tests and whatsnew entry

* fix test case

* File Importer - Only allow importing of multiple files with same column structure (#1606)

* Only allow importing of multiple files with same column structure in Delimited File Importer

* Review fixes, add unit tests, update what's new entry and help page.

* Add unit tests

* Review fixes

* Review fixes

(cherry picked from commit 5748efd49e61b77503836a0d723d52f7cbbd4852)

* added unit tests for UtilitiesHelpProvider (#1613)

* Visual Schema Attribute Description unit tests (#1620)

* added unit tests for half of the visual schema attribute descriptions

* added unit tests for the other half of the visual schema attribute descriptions

* GaussianBlur unit tests (#1615)

* started adding unit tests for GaussianBlur

* updated GaussianBlur unit tests

* minor change

* deleted unused classes DecoratorUtilities and LabelUtilities (#1632)

* Added DateTime Information to Logs (#1631)

* Added time info to logs

* Added date information to logs

* added unit tests for BlazeUtilities (#1625)

* updated IconManager tests to resolve issues (#1640)

* ExtendedBuffer Unit Tests & Source code bug fixes/adding of comments (#1619)

* Initial unit test commit, plus documentation of file under test

* Update ExtendedBufferNGTest.java

* Extra coverage and commenting

* Fixed bug in inputBuffer read.

* add final outputbuffer.write call

* Added code to validate array offsets

* Added unit test name output to help diagnose PR test issue

* Deliberately break test to diagnose PR test failures

* comment out range checks

* added back part of output buffer test.

* Added back output exception trigger

* The issue seems to be the exception code... comment out, and confirm

* further investigation of why triggered exceptio if breaking github pipeline

* testing pipeline ..

* further testing

* Update ExtendedBufferNGTest.java

* Update ExtendedBufferNGTest.java

* Update ExtendedBufferNGTest.java

* Update ExtendedBufferNGTest.java

* Update ExtendedBufferNGTest.java

* Update ExtendedBufferNGTest.java

* Update ExtendedBufferNGTest.java

* Update ExtendedBufferNGTest.java

* Review comments addressed

* added unit tests for VisualConcept (#1634)

* Visual schema interaction unit tests (#1642)

* started adding unit tests for visual schema interaction classes

* finished writing unit tests for visual schema interaction classes

* fixed an issue with excel importing numeric cells (#1636)

* fixed a potential issue with how types were added to parameter lists (#1635)

* fix spelling (#1645)

* Fixed Property Value Text Size in Histogram (#1644)

* Fixed property value in Histogram

* Fixed requested changes

* Enable renaming of Step Tabs in Data Access View (#1610)

* Enable renaming of Step Tabs in Data Access View

* Fix failing unit tests

* Remove double text on tab caption

* Remove unwanted functionality of renaming other tabs when closing a tab, more unit tests

* Change the tab names keeping the default text

* Fix the code smell

* Add the default Step text at the left of the user caption and make the edit field appear when clicked on it also

* Fix tests and refactoring

* Add what's new entry

* Remove the unwanted label text

* Fixed the month to reflect actual completion

* Remove unnecessary header

* Warn user when comparing graphs of the same name (#1618)

* add a check to exit and warn the user

* Revert "add a check to exit and warn the user"

This reverts commit 963df95.

* add controller but not functioning

* remove update parameter code

* remove commented code

* Update whatsnew.txt

* Find View JavaFX rewrite with extra functionality (#1489)

* find view UI structure

This commit contains most the basic UI class structure for the Find View, basic find and replace tabs.

* attributes check drop down saves users input, remove unnecessary classes

The drop down menu containing attributes now properly saves the users previous checks. Overcomplicated class structure for buttons has now been deleted.  Added a BasicFindReplaceParameters class to store search parameters for find functionality.

* added right click on inAttributes drop box to select/deselect all

* Altered UI layout, Added getters in BasicFindReplaceParameters, enables view only when a graph is present

* Added code to loop through graph elements and add matching elements to a list

* builds a list of matching found graph elements for multiple open graphs

* Fixed Meta Attribute, Improved calculation speed, can now properly go next and prev

* Find Next, Prev, All works as intended on one graph with no know issues

* Find can search all open graphs, cycle through next/prev properly and can handle empty returns

* cleaning code

* Added Replace All functionality, added ctrl f to open view

* relocated classes into more appropriate packages

* added replace next functionality. replaces the first found element

* Implemented remove from currently selected

* added find in current selection functionality for basic find

* Fixed find in current selection find next issue

* added structural modification counter, stops crash with index out of bounds

* add finals and code cleanup

* Update FindViewController.java

* removed comments

* Added current selection drop box, reconfigured structureChanges

* Altered basic find and replace views UI

* hotfix swapped current selection indexs

* Fixed Replace in selected find next issue

* Fixed issue where searching for an attribute on a graph that didn't contain it would crash

* Fixed attribute list messing up on graph swap

* Fixed attribute list messing up on first graph open / first component open

* Fixed issue where replacing an attribute on a graph that didn't contain it would crash

* Wrote FindStateIOProvider stopping IO error on save

* Wrote 9 tests for FindViewController

Tests include: getDefault, init, populateAttributes, updateBasicFindParameters, replaceBasicFindParameters, retrieveMatchingElements, replaceMatchingElements, getCurrentBasicFindParameters, getCurrentBasicReplaceParameters

* wrote tests for BasicFindPlugin and GraphAttributePlugin

* reconfigured basicFindPlugin test, Wrote replacePluginTest, removed exact match from replaceTab, fixed bug in replcePlugin

* auto select ignore in current selection drop down

* wrote resetStatePlugin Tests

* Added tests for basicFindTab, removed dead code in controller, altered code in basicFindTab

* Wrote ReplaceTab tests, fixed a test in the controller, altered code in replace tab to assist tests

* Fixed javaFX error with platform runlater, adjusted test to match changes, removed unused code,

* Wrote top component tests, comment out unused code (might be used later)

* Window now opens as float in the top right corner of users primary window

* Fixed some code smells

* FIXED position and size of floating windows now only locates and resizes the find view

* hotfix for basic find index out of bounds. commented out failing tests for sonar to pass

* fixed merge issues with core help merge

* added @before and @after class for tests

* Spying top component in unit tests

* removed new top component from find top component test

* fixed majority of minor code smells

* Fixing code smells and adding comments

* reduced basicFindPlugin cognitive complexity

* removing a code smell

* Find view tab pane unit tests

* Antares requested PR changes

* Find view pane tests

* Added FindResult Tests

* removed todo comments

* Wrote tests for old find view FindResults fixed resetStatePlugin null pointer bug

* reorder buttons and removed dead code

* added ex parameter to log statments

* Advanced Find View UI

* Requested Changes

* Now capable of reading all advanced find search criteria

* Advanced find tab now has proper searching functionality

Added advanced searching capabilities, update attributes list when a attribute is added, attributes now are in alphabetical order, fixed use list bug, fixed string criteria panel UI error, icons categories now sort alphabetically, icon selector takes you to currently selected icon on opening,  can now select constellation colours like attribute editor.

* requested changes and date time bug fix

* Fixed ColourCriteriaPane Null pointer Error

* Fixed UpdateUI test to be AdvancedFindTab compatible

* AdvancedFindTab UnitTests

* Advanced Search Plugin Tests, DateTime bug fix

* Revert "Merge branch 'feature/find-view-rewrite' into feature/advanced-find"

This reverts commit b22324b, reversing
changes made to 8c84d47.

* Commented out failing test

* Commented out another configuration failing test

* Uncommented test that was working and commented out another

* Added AdvancedSearchParamters test

* Testing Potential CI issue By commenting out auto save code

* First wave of fixing code smells

* Second round of code smells

* Added float and boolean criteriaPanel Tests

* Fixed AdvancedSearchPlugin Tests and covered more lines

* Added StringCriteriaPanel and ColourCriteriaPanel tests

* restored autosavestartup

* first pass, reverting file changes in master that had been reverted

* second pass, reverting file changes in master that had been reverted

* third pass, reverting file changes in master that had been reverted

* final pass, reverting file changes in master that had been reverted

* commented out unit tests for testing purposes

* fixed a unit test class

* fixed a unit test class

* slowly uncommenting unit test class

* slowly uncommenting unit test class

* slowly uncommenting unit test class

* uncommented out unit test class

* added debugging

* removing a lingering graph file

* minor changes for debugging

* removed file after autosave unit test complete, hopefully resolved lingering unit test issue in CI

* comment out unit test

* added some extra cleanup to autosave unit test

* code cleanup

Co-authored-by: aldebaran30701 <58677759+aldebaran30701@users.noreply.github.com>
Co-authored-by: antares1470 <62311243+antares1470@users.noreply.github.com>

* added missing whatsnew entry (#1649)

* XmlUtilities unit testing (#1590)

* Initial start to XmlUtilities unit testing

* Added tests for getNodes and getNodesNS

* Added tests

* Added test for getNodeValueNS

* Address how getNodeValueNS actually works.

* Initial getNodeAttr test

* Added tests for getNodeAttr

Added tests for getNodeAttr

* Some fixes to URL map functiuon, which wasn't opening file at url but instead trying to parse the URL path.

* Fixed URL map method that takes a tag to grab file rather than try parse url string

* Added table tests. Needed to convert URL string to actual URL

* Removed map/table File variants.

* Added some write tests

* Added write from input stream

* Added read tests

* removed binary characters

* Created test files. Cleaned up test code.

* Update XmlUtilitiesNGTest.java

* Address review comments

* removed unused imports

* Update XmlUtilities.java

* Show response message when the requests fails for image MIME type requests. (#1648)

* New Find View Null Pointer Check  (#1657)

* Added null check

* Requested changes

* Fixing File Importer Source and Destination options when loading a template (#1655)

* Fix File Importer Source and Destination options when loading a template

(cherry picked from commit a30cd08a2df518859be52d9a01d6968a6610d910)

* Remove code smell

* DAV Favourites option not working (#1651)

* DAV Favourites option not working

* Fix unit test failure

* Fix to unit test

Co-authored-by: aldebaran30701 <58677759+aldebaran30701@users.noreply.github.com>
Co-authored-by: sol695510 <58677774+sol695510@users.noreply.github.com>
Co-authored-by: Auriga2 <64826928+Auriga2@users.noreply.github.com>
Co-authored-by: antares1470 <62311243+antares1470@users.noreply.github.com>
Co-authored-by: serpens2406 <58677108+serpens24@users.noreply.github.com>
Co-authored-by: Delphinus8821 <73083035+Delphinus8821@users.noreply.github.com>
Co-authored-by: Atlas139mkm <88649439+Atlas139mkm@users.noreply.github.com>
Co-authored-by: mimosa2 <54261086+mimosa2@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants