Bug: Logos Help Commands need an update

Dave Hooton

Command Box commands need to be updated in Logos Help and Verbum Help e.g.

• Add Note/Create Note - no longer applicable
• Go to/Look up  - the in parameter is not recognized (uses preferred resource)
• many key words (ones that should be typed) are in italics  e.g.
• Go to passage [in resource] [in new tab | in new window]  ==> Go to passage [in resource] [in new tab | in new window]
  where  passage and resource are the only parameters that the user supplies. The other words have to be typed, even if they are a parameter.
• show passage guide on mk4.1–9  should be open passage guide on mk4.1–9 for consistency with other documents & guides  (show is mainly for tools). 

Dave Hooton

Bump for Command box doco.

Philana R. Crouch

Hi Dave,

I'll add this to my list of things to work on with the Help File.

Philana R. Crouch

• Go to/Look up  - the in parameter is not recognized (uses preferred resource)

This is a bug and I've created a a case.

• many key words (ones that should be typed) are in italics  e.g.
• Go to passage [in resource] [in new tab | in new window]  ==> Go to passage [in resource] [in new tab | in new window]
  where  passage and resource are the only parameters that the user supplies. The other words have to be typed, even if they are a parameter.

What are you expecting here? Under the heading Command Reference it says the following:

  •      Italic Text is a parameter the user supplies.
  •      [Optional clauses and parameters] are enclosed in brackets.


So Italics are parameters the user needs to supply.

Dave Hooton

https://community.logos.com/discussion/comment/1161274#Comment_1161274

• many key words (ones that should be typed) are in italics  e.g.
• Go to passage [in resource] [in new tab | in new window]  ==> Go to passage [in resource] [in new tab | in new window]
  where  passage and resource are the only parameters that the user supplies. The other words have to be typed, even if they are a parameter.

What are you expecting here?

To differentiate what has to be typed (mandatory) for the command to work e.g. in new tab has to be typed as is, but the user has to supply values for passage and resource

Philana R. Crouch

https://community.logos.com/discussion/comment/1161334#Comment_1161334

• many key words (ones that should be typed) are in italics  e.g.
• Go to passage [in resource] [in new tab | in new window]  ==> Go to passage [in resource] [in new tab | in new window]
  where  passage and resource are the only parameters that the user supplies. The other words have to be typed, even if they are a parameter.

What are you expecting here?

To differentiate what has to be typed (mandatory) for the command to work e.g. in new tab has to be typed as is, but the user has to supply values for passage and resource

Yes, but the style is italics within brackets. This would be an options clause that is included. The "in new window" is an example, but it's consistent with the key.

Philana R. Crouch

https://community.logos.com/discussion/comment/1161334#Comment_1161334

To differentiate what has to be typed (mandatory) for the command to work e.g. in new tab has to be typed as is, but the user has to supply values for passage and resource

Hi David,

I understand you are asking for additional formatting. I will look at doing this, however, it will not be in the next update that I hope to ship soon since it will take some time to reformat most of the commands.

Dave Hooton

https://community.logos.com/discussion/comment/1161407#Comment_1161407

Thanks, Philana

Philana R. Crouch

Go to/Look up  - the in parameter is not recognized (uses preferred resource)

This has been fixed in 9.7.