Menu

#567 Version of Element C for TEI Simple

AMBER
open
nobody
None
5(default)
2015-08-12
2015-08-12
No

For the TEI Simple project it would be nice to have a version of the current Appendix C in the Guidelines that lists only the elements etc. that are valid in TEI Simple. I assume this is a relatively straightforward process, though I don't know how to do it. If somebody could do it or teach me how to do it I would be very grateful. I noticed that both jtei and TEI Lite have parts of Appendix C--i.e. the description of an element with examples but lack the summary table, which over the years I have found enormously useful.

Related

Feature Requests: #567

Discussion

  • Hugh A. Cayless

    Hugh A. Cayless - 2015-08-12

    It would be nice to be able to generate this kind of documentation of any ODD. Probably without the TEI Guidelines branding. This is presumably a Stylesheets FR though. I'll leave this open for a bit in case anyone else has comments, and then open a GitHub issue and close it. There may be a straightforward method for doing this already, in which case we just need a bit of documentation. The ability to generate "API Doc" for your own customized ODD would be a nice feature.

     
  • Martin Holmes

    Martin Holmes - 2015-08-12

    We could use this as an opportunity to investigate and document the relationship between the Guidelines rendering process and the processing of regular ODDs.

     
    • Sebastian Rahtz

      Sebastian Rahtz - 2015-08-12

      I am puzzled
      This is standard behaviour of odd to html, surely?

      Sent from my iPhone

      On 12 Aug 2015, at 16:42, Martin Holmes martindholmes@users.sf.net<mailto:martindholmes@users.sf.net> wrote:

      We could use this as an opportunity to investigate and document the relationship between the Guidelines rendering process and the processing of regular ODDs.


      [feature-requests:#567]http://sourceforge.net/p/tei/feature-requests/567/ Version of Element C for TEI Simple

      Status: open
      Group: AMBER
      Created: Wed Aug 12, 2015 01:04 PM UTC by Martin Mueller
      Last Updated: Wed Aug 12, 2015 03:38 PM UTC
      Owner: nobody

      For the TEI Simple project it would be nice to have a version of the current Appendix C in the Guidelines that lists only the elements etc. that are valid in TEI Simple. I assume this is a relatively straightforward process, though I don't know how to do it. If somebody could do it or teach me how to do it I would be very grateful. I noticed that both jtei and TEI Lite have parts of Appendix C--i.e. the description of an element with examples but lack the summary table, which over the years I have found enormously useful.


      Sent from sourceforge.nethttp://sourceforge.net because you indicated interest in https://sourceforge.net/p/tei/feature-requests/567/

      To unsubscribe from further messages, please visit https://sourceforge.net/auth/subscriptions/

       

      Related

      Feature Requests: #567

      • Hugh A. Cayless

        Hugh A. Cayless - 2015-08-12

        Very likely. I don't know the half of what your brilliant stylesheets do :-)

        Sent from my phone.

        On Aug 12, 2015, at 13:28, Sebastian Rahtz rahtz@users.sf.net wrote:

        I am puzzled
        This is standard behaviour of odd to html, surely?

        Sent from my iPhone

        On 12 Aug 2015, at 16:42, Martin Holmes martindholmes@users.sf.netmartindholmes@users.sf.net wrote:

        We could use this as an opportunity to investigate and document the relationship between the Guidelines rendering process and the processing of regular ODDs.

        [feature-requests:#567]http://sourceforge.net/p/tei/feature-requests/567/ Version of Element C for TEI Simple

        Status: open
        Group: AMBER
        Created: Wed Aug 12, 2015 01:04 PM UTC by Martin Mueller
        Last Updated: Wed Aug 12, 2015 03:38 PM UTC
        Owner: nobody

        For the TEI Simple project it would be nice to have a version of the current Appendix C in the Guidelines that lists only the elements etc. that are valid in TEI Simple. I assume this is a relatively straightforward process, though I don't know how to do it. If somebody could do it or teach me how to do it I would be very grateful. I noticed that both jtei and TEI Lite have parts of Appendix C--i.e. the description of an element with examples but lack the summary table, which over the years I have found enormously useful.

        Sent from sourceforge.nethttp://sourceforge.net because you indicated interest in https://sourceforge.net/p/tei/feature-requests/567/

        To unsubscribe from further messages, please visit https://sourceforge.net/auth/subscriptions/

        [feature-requests:#567] Version of Element C for TEI Simple

        Status: open
        Group: AMBER
        Created: Wed Aug 12, 2015 01:04 PM UTC by Martin Mueller
        Last Updated: Wed Aug 12, 2015 03:42 PM UTC
        Owner: nobody

        For the TEI Simple project it would be nice to have a version of the current Appendix C in the Guidelines that lists only the elements etc. that are valid in TEI Simple. I assume this is a relatively straightforward process, though I don't know how to do it. If somebody could do it or teach me how to do it I would be very grateful. I noticed that both jtei and TEI Lite have parts of Appendix C--i.e. the description of an element with examples but lack the summary table, which over the years I have found enormously useful.

        Sent from sourceforge.net because you indicated interest in https://sourceforge.net/p/tei/feature-requests/567/

        To unsubscribe from further messages, please visit https://sourceforge.net/auth/subscriptions/

         

        Related

        Feature Requests: #567

  • Martin Holmes

    Martin Holmes - 2015-08-12

    I don't think you get this page by default, do you?

    http://www.tei-c.org/release/doc/tei-p5-doc/en/html/REF-ELEMENTS.html

     
    • Sebastian Rahtz

      Sebastian Rahtz - 2015-08-12

      No but that seems a trivial addition....

      Sent from my iPhone

      On 12 Aug 2015, at 18:52, Martin Holmes martindholmes@users.sf.net<mailto:martindholmes@users.sf.net> wrote:

      I don't think you get this page by default, do you?

      http://www.tei-c.org/release/doc/tei-p5-doc/en/html/REF-ELEMENTS.html


      [feature-requests:#567]http://sourceforge.net/p/tei/feature-requests/567/ Version of Element C for TEI Simple

      Status: open
      Group: AMBER
      Created: Wed Aug 12, 2015 01:04 PM UTC by Martin Mueller
      Last Updated: Wed Aug 12, 2015 03:42 PM UTC
      Owner: nobody

      For the TEI Simple project it would be nice to have a version of the current Appendix C in the Guidelines that lists only the elements etc. that are valid in TEI Simple. I assume this is a relatively straightforward process, though I don't know how to do it. If somebody could do it or teach me how to do it I would be very grateful. I noticed that both jtei and TEI Lite have parts of Appendix C--i.e. the description of an element with examples but lack the summary table, which over the years I have found enormously useful.


      Sent from sourceforge.nethttp://sourceforge.net because you indicated interest in https://sourceforge.net/p/tei/feature-requests/567/

      To unsubscribe from further messages, please visit https://sourceforge.net/auth/subscriptions/

       

      Related

      Feature Requests: #567

      • Martin Mueller

        Martin Mueller - 2015-08-13

        So there is a simple fix that could be applied equally to TEI-Lite, jtei, and TEI-Simple and would result in a look and feel that is identical with the presentation of all elements. I think that's desirable. It simplifies the Gradus ad Parnassum. I like Clementi's title, though I've never been able to play any of his etudes at speed.

        MM

        Martin Mueller
        Professor emeritus of English and Classics
        Northwestern University

        From: Sebastian Rahtz rahtz@users.sf.net<mailto:rahtz@users.sf.net>
        Reply-To: "[tei:feature-requests]" 567@feature-requests.tei.p.re.sf.net<mailto:567@feature-requests.tei.p.re.sf.net>
        Date: Wednesday, August 12, 2015 2:03 PM
        To: "[tei:feature-requests]" 567@feature-requests.tei.p.re.sf.net<mailto:567@feature-requests.tei.p.re.sf.net>
        Subject: [tei:feature-requests] Re: #567 Version of Element C for TEI Simple

        No but that seems a trivial addition....

        Sent from my iPhone

        On 12 Aug 2015, at 18:52, Martin Holmes martindholmes@users.sf.netmartindholmes@users.sf.net<mailto:martindholmes@users.sf.net<mailto:martindholmes@users.sf.net> wrote:

        I don't think you get this page by default, do you?

        http://www.tei-c.org/release/doc/tei-p5-doc/en/html/REF-ELEMENTS.html


        [feature-requests:#567]http://sourceforge.net/p/tei/feature-requests/567/http://sourceforge.net/p/tei/feature-requests/567/ Version of Element C for TEI Simple

        Status: open
        Group: AMBER
        Created: Wed Aug 12, 2015 01:04 PM UTC by Martin Mueller
        Last Updated: Wed Aug 12, 2015 03:42 PM UTC
        Owner: nobody

        For the TEI Simple project it would be nice to have a version of the current Appendix C in the Guidelines that lists only the elements etc. that are valid in TEI Simple. I assume this is a relatively straightforward process, though I don't know how to do it. If somebody could do it or teach me how to do it I would be very grateful. I noticed that both jtei and TEI Lite have parts of Appendix C--i.e. the description of an element with examples but lack the summary table, which over the years I have found enormously useful.


        Sent from sourceforge.nethttp://sourceforge.net because you indicated interest in https://sourceforge.net/p/tei/feature-requests/567/

        To unsubscribe from further messages, please visit https://sourceforge.net/auth/subscriptions/


        [feature-requests:#567]http://sourceforge.net/p/tei/feature-requests/567/ Version of Element C for TEI Simple

        Status: open
        Group: AMBER
        Created: Wed Aug 12, 2015 01:04 PM UTC by Martin Mueller
        Last Updated: Wed Aug 12, 2015 06:43 PM UTC
        Owner: nobody

        For the TEI Simple project it would be nice to have a version of the current Appendix C in the Guidelines that lists only the elements etc. that are valid in TEI Simple. I assume this is a relatively straightforward process, though I don't know how to do it. If somebody could do it or teach me how to do it I would be very grateful. I noticed that both jtei and TEI Lite have parts of Appendix C--i.e. the description of an element with examples but lack the summary table, which over the years I have found enormously useful.


        Sent from sourceforge.net because you indicated interest in https://sourceforge.net/p/tei/feature-requests/567/

        To unsubscribe from further messages, please visit https://sourceforge.net/auth/subscriptions/

         

        Related

        Feature Requests: #567

      • Lou Burnard

        Lou Burnard - 2015-08-13

        By default (e.g. using the ODD-XHTML conversion built into oxygen) you
        get a table of contents which includes a link to a description for each
        element defined in the customization, but not a separate table.

        For BNC, and I think some others, there used to be a way of generating
        two appendixes: one containing full element descriptions for each
        element modified in the customization, and the other containing a table
        of links to the standard P5 description for each element referenced (but
        unmodified) by the customization. I wonder if that is what Martin is
        looking for?

        On 12/08/15 20:03, Sebastian Rahtz wrote:

        No but that seems a trivial addition....

        Sent from my iPhone

        On 12 Aug 2015, at 18:52, Martin Holmes martindholmes@users.sf.net<mailto:martindholmes@users.sf.net> wrote:

        I don't think you get this page by default, do you?

        http://www.tei-c.org/release/doc/tei-p5-doc/en/html/REF-ELEMENTS.html


        [feature-requests:#567]http://sourceforge.net/p/tei/feature-requests/567/ Version of Element C for TEI Simple

        Status: open
        Group: AMBER
        Created: Wed Aug 12, 2015 01:04 PM UTC by Martin Mueller
        Last Updated: Wed Aug 12, 2015 03:42 PM UTC
        Owner: nobody

        For the TEI Simple project it would be nice to have a version of the current Appendix C in the Guidelines that lists only the elements etc. that are valid in TEI Simple. I assume this is a relatively straightforward process, though I don't know how to do it. If somebody could do it or teach me how to do it I would be very grateful. I noticed that both jtei and TEI Lite have parts of Appendix C--i.e. the description of an element with examples but lack the summary table, which over the years I have found enormously useful.


        Sent from sourceforge.nethttp://sourceforge.net because you indicated interest in https://sourceforge.net/p/tei/feature-requests/567/

        To unsubscribe from further messages, please visit https://sourceforge.net/auth/subscriptions/


        [feature-requests:#567] Version of Element C for TEI Simple

        Status: open
        Group: AMBER
        Created: Wed Aug 12, 2015 01:04 PM UTC by Martin Mueller
        Last Updated: Wed Aug 12, 2015 06:43 PM UTC
        Owner: nobody

        For the TEI Simple project it would be nice to have a version of the current Appendix C in the Guidelines that lists only the elements etc. that are valid in TEI Simple. I assume this is a relatively straightforward process, though I don't know how to do it. If somebody could do it or teach me how to do it I would be very grateful. I noticed that both jtei and TEI Lite have parts of Appendix C--i.e. the description of an element with examples but lack the summary table, which over the years I have found enormously useful.


        Sent from sourceforge.net because you indicated interest in https://sourceforge.net/p/tei/feature-requests/567/

        To unsubscribe from further messages, please visit https://sourceforge.net/auth/subscriptions/

         

        Related

        Feature Requests: #567

  • James Cummings

    James Cummings - 2015-08-12

    I don't think you get a separate (or internal) equivalent to the REF-ELEMENTS.html page, which is what MartinM is suggesting should be available for any customisation. Improving the output for the odd to html so that there was a parameter to burst out the reference material into separate files (e.g. ref-p.html) and link to that from an equivalent of REF-ELEMENTS.html, which was linked to from the main output of the ODD (e.g. the local encoding documentation) would be a potential improvement.

    Specifically MartinM wants the list of elements by alphabet and by module with the little bit of javascript that helps you pick them. His use case is in trying to understand TEI Simple.

    All the logic to do so already exists in the Guidelines producing stylesheets, so it seems like it wouldn't be too difficult.

    If it already does exist, I've not found what parameter would enable it.

    -James

     
    • Sebastian Rahtz

      Sebastian Rahtz - 2015-08-13

      Conveptually simple. And the code exists

      But remember the default is to produce a single file - making multiple files adds complications
      Sebastian
      Sent from my iPhone

      On 12 Aug 2015, at 19:43, James Cummings jcummings@users.sf.net<mailto:jcummings@users.sf.net> wrote:

      I don't think you get a separate (or internal) equivalent to the REF-ELEMENTS.html page, which is what MartinM is suggesting should be available for any customisation. Improving the output for the odd to html so that there was a parameter to burst out the reference material into separate files (e.g. ref-p.html) and link to that from an equivalent of REF-ELEMENTS.html, which was linked to from the main output of the ODD (e.g. the local encoding documentation) would be a potential improvement.

      Specifically MartinM wants the list of elements by alphabet and by module with the little bit of javascript that helps you pick them. His use case is in trying to understand TEI Simple.

      All the logic to do so already exists in the Guidelines producing stylesheets, so it seems like it wouldn't be too difficult.

      If it already does exist, I've not found what parameter would enable it.

      -James


      [feature-requests:#567]http://sourceforge.net/p/tei/feature-requests/567/ Version of Element C for TEI Simple

      Status: open
      Group: AMBER
      Created: Wed Aug 12, 2015 01:04 PM UTC by Martin Mueller
      Last Updated: Wed Aug 12, 2015 05:52 PM UTC
      Owner: nobody

      For the TEI Simple project it would be nice to have a version of the current Appendix C in the Guidelines that lists only the elements etc. that are valid in TEI Simple. I assume this is a relatively straightforward process, though I don't know how to do it. If somebody could do it or teach me how to do it I would be very grateful. I noticed that both jtei and TEI Lite have parts of Appendix C--i.e. the description of an element with examples but lack the summary table, which over the years I have found enormously useful.


      Sent from sourceforge.nethttp://sourceforge.net because you indicated interest in https://sourceforge.net/p/tei/feature-requests/567/

      To unsubscribe from further messages, please visit https://sourceforge.net/auth/subscriptions/

       

      Related

      Feature Requests: #567