Menu

#139 Update, format, correct, supplement examples in GL

9.6
accepted
nobody
guidelines (82)
5(medium)
2023-06-15
2020-01-22
No

There are pages in the GL where the examples are poorly formatted, or don't make sense on the page. In other cases, the examples are missing or don't cover enough permutations of attributes. We should hold a sprint to go through pages and plan what needs to be done and which pages need better or clearer examples. In advance of the sprint, please list any example lacks that you notice (page title, url, comment) to this ticket discussion.

Discussion

  • Elli Mylonas

    Elli Mylonas - 2020-01-22
    • labels: Guidelines --> guidelines
     
  • Pietro Maria Liuzzo

    • assigned_to: Pietro Maria Liuzzo
     
  • Emmanuelle Morlock

    https://www.stoa.org/epidoc/gl/latest/trans-diplomatic.html –> "see also" link missing

    https://www.stoa.org/epidoc/gl/latest/trans-textpart.html –> 3rd §: formatting pb 'with an type="textpart".'

    https://www.stoa.org/epidoc/gl/latest/trans-textpart.html –> "according to london: Section A": transformed html missing for second and third example block.

    https://www.stoa.org/epidoc/gl/latest/trans-linebreak.html
    -> to show the effect of a line break, the example shoud provide at least 2 lines (otherwise the rendering is not different is there is a line beginning tag or not.
    -> also update the notion of "line breaks" to "line beginings" (very common source of misunderstanding in training sessions). Of course a line begining <lb/> is a kind of a line break, but it's important to be explicit somewhere that the it represents be beginning of a line and not the end of the previous one...

    https://www.stoa.org/epidoc/gl/latest/trans-linebreakinword.html
    -> the two example options (panciera and london) produce the same rendering. May be more interesting to provide examples with parameters producing different renderings.

    https://www.stoa.org/epidoc/gl/latest/trans-linebreakdirection.html
    -> the interesting visual rendering is not inside the yellow example box, but on top of it (SEG wit arrow turned towards left. We should have here two explicit examples with arrows showing visually the relation between the @style attribute and the direction of the graphic arrow
    -> PHI 1357: unconsistent encoding/rendering for first line?

    (to be continued...)

     

    Last edit: BODARD Gabriel 2020-06-16
    • BODARD Gabriel

      BODARD Gabriel - 2020-06-16

      Diplomatic "see also" – it is not that there is a link missing, but that there are no elements given here to be linked to. We should put a test on the "see also" script so that it doesn't appear if empty.

      Linebreakinword – As noted elsewhere, the "Panciera" rendering is in fact wrong here (should be = not - at the end of line), and so should be renamed. It actually means "default" in the EpiDoc Stylesheets.

      Linebreakdirection – the issue is that neither of these Leiden-styles render text direction. If we want them to, that should be a separate ticket, I think. (In fact, maybe subsumed under FR 132?)

       
      • BODARD Gabriel

        BODARD Gabriel - 2020-06-16

        I now see that the "see also" division is triggered by a <divGen type="seealso"/> in the XML, so the solution to the Diplomatic page is to either (a) add a <specList> if there are elements we want cited in there or (b) delete the <divGen>.

         
        • BODARD Gabriel

          BODARD Gabriel - 2020-06-16

          I will delete (or rather comment out) the <divGen> for now. Commited at [r2767]

           

          Related

          Commit: [r2767]


          Last edit: BODARD Gabriel 2020-06-16
  • BODARD Gabriel

    BODARD Gabriel - 2020-06-16
    • status: unread --> accepted
     
  • Pietro Maria Liuzzo

    I have a plan to look at this as promised

     
  • Pietro Maria Liuzzo

    • Group: 9.2 --> future
     
  • BODARD Gabriel

    BODARD Gabriel - 2022-01-18
    • Group: future --> 9.4
     
  • Scott DiGiulio

    Scott DiGiulio - 2022-03-29
    • assigned_to: Pietro Maria Liuzzo --> nobody
     
  • BODARD Gabriel

    BODARD Gabriel - 2023-06-15
    • Group: 9.4 --> 9.6
     

Log in to post a comment.

Want the latest updates on software, tech news, and AI?
Get latest updates about software, tech news, and AI from SourceForge directly in your inbox once a month.