#477 "default members of the model.respLike class"

closed-fixed
5
2012-12-29
2012-12-03
No

In section 3.11.2.2 (#COBICOR), the Guidelines say:

The elements author, editor, and respStmt are the default members of the model.respLike class

I think "default" here means something like "basic", and so I propose revising to use that word.

(I find "default" to be a dangerous term in technical documentation in general and especially in the TEI Guidelines. After all, the members of model.respLike are all equal in the eyes of the ODDs.)

Discussion

  • Sebastian Rahtz

    Sebastian Rahtz - 2012-12-23

    Be warned that the same phrase is used at least 3 times in CO, and at least once in HD (I did a quick grep), so don't change just this one. I do agree that in this case the word "default" is misleading in this case, but it's not clear to me that "basic" is that much better. I wonder if the other occurrences of "default" should just be omitted (they look as if they are complete list), and in this case "commonly-used" might be useful?

     
  • James Cummings

    James Cummings - 2012-12-26
    • assigned_to: nobody --> kshawkin
     
  • James Cummings

    James Cummings - 2012-12-26

    Assigning to Kshawkin - but double-check wording in other locations and run by council.

     
  • Kevin Hawkins

    Kevin Hawkins - 2012-12-29

    Good point, Sebastian. Looking at those others, I see now that "default members" of a class is used to mean "members until someone makes a customization". The problem, then, was that we had added members to model.respLike at some point but forgotten to add those members of the prose discussion. Now fixed at revision 11282.

     
  • Kevin Hawkins

    Kevin Hawkins - 2012-12-29
    • status: open --> closed-fixed