LogixNG help phase 2 #9859

dsand47 · 2021-06-03T04:18:46Z

No description provided.

mergeable · 2021-06-03T04:19:03Z

Thanks for the PR. It includes changes to properties files, so the 'Needs L10N' label has been added"

mergeable · 2021-06-03T04:19:18Z

This PR includes files in the help hierarchy so the 'Documentation' label has been added. Other labels may also be applied."

codecov · 2021-06-03T04:57:28Z

Codecov Report

Merging #9859 (01b8f54) into master (6c67d93) will decrease coverage by 0.1%.
The diff coverage is 0.0%.

@@             Coverage Diff             @@
##             master    #9859     +/-   ##
===========================================
- Coverage      51.8%    51.8%   -0.0%     
- Complexity    64081    64110     +29     
===========================================
  Files          5098     5099      +1     
  Lines        445047   445235    +188     
  Branches      64285    64336     +51     
===========================================
+ Hits         230232   230253     +21     
- Misses       192076   192229    +153     
- Partials      22739    22753     +14

Impacted Files	Coverage Δ
...rc/jmri/jmrit/logixng/tools/swing/LogixNGMenu.java	`70.0% <ø> (ø)`
...rc/jmri/jmrit/logixng/tools/swing/TableEditor.java	`49.0% <0.0%> (-3.2%)`	⬇️
...jmrit/logixng/swing/AbstractSwingConfigurator.java	`7.7% <0.0%> (-67.3%)`	⬇️
...ixng/actions/swing/AbstractDigitalActionSwing.java	`33.4% <0.0%> (-66.6%)`	⬇️
...ressions/swing/AbstractDigitalExpressionSwing.java	`33.4% <0.0%> (-66.6%)`	⬇️
...ons/locations/schedules/ExportSchedulesAction.java	`50.0% <0.0%> (-50.0%)`	⬇️
...operations/trains/tools/ExportTimetableAction.java	`60.0% <0.0%> (-40.0%)`	⬇️
...erations/trains/tools/ExportTrainRosterAction.java	`60.0% <0.0%> (-40.0%)`	⬇️
...ixng/actions/swing/AbstractBooleanActionSwing.java	`80.0% <0.0%> (-20.0%)`	⬇️
.../jmrit/symbolicprog/tabbedframe/WatchingLabel.java	`38.5% <0.0%> (-15.3%)`	⬇️
... and 94 more

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 6c67d93...01b8f54. Read the comment docs.

coveralls · 2021-06-03T05:08:00Z

Coverage decreased (-0.02%) to 56.884% when pulling 01b8f54 on dsand47:das_logixng_help_phase_2 into 6c67d93 on JMRI:master.

dsand47 · 2021-06-05T14:29:55Z

This PR is ready for review and merge.

dsand47 · 2021-06-05T17:18:20Z

I have decided to include the module and table chapters in this PR.

help/en/html/tools/logixng/Tutorial/chapter9.shtml

danielb987 · 2021-06-06T02:33:51Z

help/en/html/tools/logixng/Tutorial/index.shtml

 <p>

 <p>
-<a href="chapter1.shtml">Chapter 1 - A simple LogixNG</a>
+<!-- <a href="chapter1.shtml">Chapter 1 - A simple LogixNG</a> -->
 <p>
 <a href="chapter2.html">Chapter 2 - The clipboard</a>


I guess this line should also be commented out? Chapter 2 about the clipboard is in the section "Standard features" above.

Most of the content in index.shtml will be removed in phase 3. The redundant content will be dropped and the useful content moved to the proper chapters or archived for future chapters.

danielb987 · 2021-06-06T02:42:20Z

help/en/html/tools/logixng/Tutorial/chapter10.shtml

+
+      <h2>Modules</h2>
+
+      <p>A module is a special ConditionalNG which is invoked from regular ConditionalNGs.


A module is a special ConditionalNG which is invoked from regular ConditionalNGs or modules.

@dsand47 It's probably rare to use a module to call a module, but it's possible. Even recursion is possible, that the module calls itself.

I have already used a module calling a module.

danielb987 · 2021-06-06T02:43:54Z

help/en/html/tools/logixng/Tutorial/chapter10.shtml

+      </div>
+
+      <p>This is a digital action socket.  This can be used to create an action only module or
+      complex modules withe any combination of expressions and actions, such as


complex modules withe any combination

Misspelling of withe.

That word is in the dictionary, but fixed anyway.

I apologize. English is not my native language.

There is no need to apologize. I was wondering why spell check did not catch it since I had never seen the word before.

danielb987 · 2021-06-06T02:48:13Z

help/en/html/tools/logixng/Tutorial/chapter10.shtml

+
+      <p>This is a digital action socket.  This can be used to create an action only module or
+      complex modules withe any combination of expressions and actions, such as
+      <strong>if then else</strong> structures.  These can have inputs and outputs.</p>


When I first read this sentense, I got the feeling that the sentense These can have inputs and outputs is related to a digital action socket module. I suggest that you put this sentence in it's own paragraph, since digital expressions can have inputs and outputs as well.

Can a digital expression return a value as well as true/false?

Yes. I might not have tested that, but in this regard there should be no difference between digital action modules and digital expression modules.

Think of Java. You could have a method:
boolean isValid(Object a, List<String> errors);

which checks if a is valid in some sense, and if not, returns false and adds the error messages in the list errors.

dsand47 · 2021-06-06T14:10:31Z

I have decided it is time to merge this.

It has a fix for the missing sidebars.

It has a partial chapter 11. The rest will be in phase 3 after we decide about the table cell indexing. Will it be zero based or one based, will the sys/user name row be removed.?

danielb987 · 2021-06-06T15:30:58Z

I have decided it is time to merge this.

I will merge it as soon as CI has passed.

It has a partial chapter 11. The rest will be in phase 3 after we decide about the table cell indexing. Will it be zero based or one based, will the sys/user name row be removed.?

I will keep it zero based but remove system and user names.

I'm currently adding a new action, ActionListenOnBeansTable. That action listens to the beans in a table column or row. By combining ActionListenOnBeansTable and TableForEach, you can solve the problem Don Weigt wrote about in the thread Masking off control panel hardware to enable or disable it.

dsand47 · 2021-06-06T16:04:14Z

Restart Windows CI, unrelated errors in Layout Editor components.

dsand47 · 2021-06-06T17:04:25Z

Restart Windows CI:

Error:    LayoutEditorToolsTest.setUp:614 � TestTimedOut test timed out after 10 seconds
11599

danielb987 · 2021-06-07T00:55:23Z

It has a partial chapter 11. The rest will be in phase 3 after we decide about the table cell indexing. Will it be zero based or one based, will the sys/user name row be removed.?

This is now done in PR #9873.

dsand47 added 2 commits June 2, 2021 21:11

Remove TimeDiagram

a543572

Add file chooser to table editor, update table help files

c02c8c1

mergeable bot assigned dsand47 Jun 3, 2021

mergeable bot added the Needs L10N Needs localization label Jun 3, 2021

mergeable bot added Documentation New PR Newly created PR that is less than 1 day old labels Jun 3, 2021

danielb987 added this to the 4.23.7 milestone Jun 3, 2021

dsand47 added 3 commits June 3, 2021 15:06

Add chapter 4, misc cleanup

4a51c7b

Add chapter 5 and 6

415c838

Create placeholders

0bda3af

mergeable bot removed the New PR Newly created PR that is less than 1 day old label Jun 4, 2021

dsand47 added 3 commits June 4, 2021 16:09

Chapter 9; misc changes

245b394

Chapter 7

4a5b9ae

Chapter 8

abd7576

dsand47 changed the title ~~WIP LogixNG help phase 2~~ LogixNG help phase 2 Jun 5, 2021

dsand47 changed the title ~~LogixNG help phase 2~~ WIP LogixNG help phase 2 Jun 5, 2021

Chapter 10

ec0377f

danielb987 previously approved these changes Jun 6, 2021

View reviewed changes

Fix missing sidebars

46d7336

dsand47 dismissed danielb987’s stale review via 46d7336 June 6, 2021 13:56

Add a partial chapter 11, other misc fixes

01b8f54

dsand47 changed the title ~~WIP LogixNG help phase 2~~ LogixNG help phase 2 Jun 6, 2021

danielb987 approved these changes Jun 6, 2021

View reviewed changes

danielb987 merged commit 8c5201e into JMRI:master Jun 6, 2021

dsand47 deleted the das_logixng_help_phase_2 branch June 6, 2021 19:46

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

LogixNG help phase 2 #9859

LogixNG help phase 2 #9859

dsand47 commented Jun 3, 2021

mergeable bot commented Jun 3, 2021

mergeable bot commented Jun 3, 2021

codecov bot commented Jun 3, 2021 •

edited

coveralls commented Jun 3, 2021 •

edited

dsand47 commented Jun 5, 2021

dsand47 commented Jun 5, 2021

danielb987 Jun 6, 2021

dsand47 Jun 6, 2021

danielb987 Jun 6, 2021

dsand47 Jun 6, 2021

danielb987 Jun 6, 2021

dsand47 Jun 6, 2021

danielb987 Jun 6, 2021

dsand47 Jun 6, 2021

danielb987 Jun 6, 2021

dsand47 Jun 6, 2021

danielb987 Jun 6, 2021

danielb987 Jun 6, 2021

dsand47 commented Jun 6, 2021

danielb987 commented Jun 6, 2021

dsand47 commented Jun 6, 2021

dsand47 commented Jun 6, 2021

danielb987 commented Jun 7, 2021


		<h2>Modules</h2>

		<p>A module is a special ConditionalNG which is invoked from regular ConditionalNGs.

LogixNG help phase 2 #9859

LogixNG help phase 2 #9859

Conversation

dsand47 commented Jun 3, 2021

mergeable bot commented Jun 3, 2021

mergeable bot commented Jun 3, 2021

codecov bot commented Jun 3, 2021 • edited

Codecov Report

coveralls commented Jun 3, 2021 • edited

dsand47 commented Jun 5, 2021

dsand47 commented Jun 5, 2021

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

dsand47 commented Jun 6, 2021

danielb987 commented Jun 6, 2021

dsand47 commented Jun 6, 2021

dsand47 commented Jun 6, 2021

danielb987 commented Jun 7, 2021

codecov bot commented Jun 3, 2021 •

edited

coveralls commented Jun 3, 2021 •

edited