Uploaded image for project: 'SWORD'
  1. SWORD
  2. API-202

SWORD defaults for option filters - the difference between additive and subtractive filters

    Details

    • Type: Improvement
    • Status: Open (View Workflow)
    • Priority: Major
    • Resolution: Unresolved
    • Affects Version/s: 1.7.4
    • Fix Version/s: 1.8.0
    • Component/s: core, filters
    • Labels:
      None
    • Environment:

      #N/A

      Description

      There's a strange inconsistency in the way that SWORD handles some option filters in that it does not treat some subtractive filters properly in terms of defaults.

      The following are subtractive filters, and the default for each should be to show the module text without stripping any feature thereof.

      • UTF8ArabicPoints
      • UTF8ArabicShaping (undocumented except in diatheke)
      • UTF8Cantillation
      • UTF8HebrewPoints
      • UTF8GreekAccents

      Most other filters are additive, so the default should be not to display the extra feature in the module.

      Even for diatheke, the default should be to output the module text without stripping anything. The CL options for each of these subtractive filters should be redefined such that they must be specified to exclude these from the output rather than to include them.

      Above all, there needs to be consistency.

      And as this is an issue regarding defaults, it seems also that the way SWORD currently handles OSISVariants and ThMLVariants is inverted.

      e.g. If in Xiphos, the user selects Primary reading, the Secondary reading is displayed, and vice versa. This needs fixing along with the requirement to support more than two variants.

        Attachments

          Activity

          Hide
          dfh David Haslam added a comment -

          Any progress on this by SWORD developers?

          Show
          dfh David Haslam added a comment - Any progress on this by SWORD developers?
          Hide
          scribe Troy A Griffitts added a comment -

          What brings you to the conclusion: the default for each should be to show the module text without stripping any feature thereof

          Also, what makes you think any filter is "additive".  Generally with few exceptions, all filters strip something from the text.

           

          Show
          scribe Troy A Griffitts added a comment - What brings you to the conclusion: the  default  for each should be to show the module text without stripping any feature thereof Also, what makes you think any filter is "additive".  Generally with few exceptions, all filters strip something from the text.  
          Hide
          dfh David Haslam added a comment -

          It’s how the filter seems to behave in relation to diatheke command line parameters that led me to create this issue.

          If the module text has features such as diacritics, then the default should be to output the text WITH them.

          Show
          dfh David Haslam added a comment - It’s how the filter seems to behave in relation to diatheke command line parameters that led me to create this issue. If the module text has features such as diacritics, then the default should be to output the text WITH them.
          Hide
          scribe Troy A Griffitts added a comment -

          I'm not sure that's true for all module features.  Do you think modules with Strong's numbers should by default show them?

          Having a quick look at your mentioned features and their default values

          • UTF8ArabicPoints on
          • UTF8ArabicShaping (not an option filter)
          • UTF8Cantillation off
          • UTF8HebrewPoints on
          • UTF8GreekAccents on

          You could argue that Cantillation should be on by default.  I could see that.  I would have to investigate the history log of this feature and see if there is a recorded reason why it is off by default.

          Show
          scribe Troy A Griffitts added a comment - I'm not sure that's true for all module features.  Do you think modules with Strong's numbers should by default show them? Having a quick look at your mentioned features and their default values UTF8ArabicPoints  on UTF8ArabicShaping  (not an option filter) UTF8Cantillation  off UTF8HebrewPoints on UTF8GreekAccents on You could argue that Cantillation should be on by default.  I could see that.  I would have to investigate the history log of this feature and see if there is a recorded reason why it is off by default.
          Hide
          dfh David Haslam added a comment -

          No - the default for Strong’s and Notes etc should be to hide them.

          On the other hand, anything intrinsic to the module text (e.g. all diacritics) should default to show them.

          Agree ?

          Show
          dfh David Haslam added a comment - No - the default for Strong’s and Notes etc should be to hide them. On the other hand, anything intrinsic to the module text (e.g. all diacritics) should default to show them. Agree ?

            People

            • Assignee:
              scribe Troy A Griffitts
              Reporter:
              dfh David Haslam
            • Votes:
              0 Vote for this issue
              Watchers:
              2 Start watching this issue

              Dates

              • Created:
                Updated: