#  $Id: GenHeaderRegistry.rep,v 1.6 2004/10/20 15:09:49 graham Exp $
#
#  Copyright (c) 2004, G. KLYNE.  All rights reserved.
#  See end of this file for licence information.
#--------+---------+---------+---------+---------+---------+---------+---------+
#
# Message header registry generator: report description
#
# Uses to create an RDF-based description, subsequently used by N3Report 
# query and report generation software to generate registry data files.
#
#--------+---------+---------+---------+---------+---------+---------+---------+

##  Changes:
##
##  hrep:HdrDetailPattern: allow doc section on header specification
##
##  hrep:HdrProtoPattern:  include hdr:xref value for target document reference
##  (NOTE:  RFC2XML target documents must be defined in including document source)
##
##  hrep:HdrDetailPattern: include hdr:xref and hdr:label values for creating
##  target document description and reference.
##  (NOTE:  RFC2XML target documents must be defined in including document source)
##
##  hrep:XmlEntry1: change output format so that 
##  (a) protocol name cites reference, if defined;
##  (b) don't include protocol document URI.

@prefix rdf:  <http://www.w3.org/1999/02/22-rdf-syntax-ns#> .
@prefix rdfs: <http://www.w3.org/2000/01/rdf-schema#> .
@prefix foaf: <http://xmlns.com/foaf/0.1/> .
@prefix hdr:  <http://id.ninebynine.org/wip/2002/IETF/MsgHdr/> .
@prefix hrep: <http://id.ninebynine.org/wip/2002/IETF/MsgHdr/Report/> .

#### top-level report structure ####

@report hrep:GenHeaders
    IFDEF ?htmlname DO hrep:HtmlReport END
    IFDEF ?xmlname  DO hrep:XmlReport  END
END

@report hrep:HtmlReport
    OPEN  "t" (?path "/" ?htmlname )
    WRITE "t" hrep:TableHead
    FOREACH hrep:HdrProtoPattern
        WRITE "t" hrep:TableItem
        IFDEF ?entries
            IFMATCH hrep:HdrDetailPattern
                OPEN "e" (?path "/" ?pname "/" ?name ".html")
                DO hrep:HtmlEntry
                CLOSE "e"
            ELSE
                WRITE "t" hrep:NoDetail
            END
        END
    ELSE
        WRITE "t" hrep:TableEmpty
    END
    WRITE "t" hrep:TableFoot
    CLOSE "t"
END

@report hrep:HtmlEntry
    WRITE "e" hrep:HdrEntry1
    FOREACH hrep:HdrControllerPattern
        WRITE "e" hrep:HdrEntryAuthor
    SEPARATOR
        WRITE "e" hrep:HdrEntryAuthorSep
    ELSE
        FOREACH hrep:HdrAuthorPattern
            WRITE "e" hrep:HdrEntryAuthor
        SEPARATOR
            WRITE "e" hrep:HdrEntryAuthorSep
        END
    END
    WRITE "e" hrep:HdrEntry3
END

@report hrep:XmlReport
    OPEN  "x" (?path "/" ?xmlname )
    WRITE "x" hrep:XmlTableHead

    FOREACH hrep:HdrProtoPattern
        WRITE "x" hrep:XmlTableItem
    ELSE
        WRITE "x" hrep:XmlTableEmpty
    END

    WRITE "x" hrep:XmlTableFoot

    FOREACH hrep:HdrProtoPattern
        DEBUG ("Processing " ?name)
        IFMATCH hrep:HdrDetailPattern
            DO hrep:XmlEntry
        END
    END

    CLOSE "x"
END

@report hrep:XmlEntry
    WRITE "x" hrep:XmlEntry1
    FOREACH hrep:HdrControllerPattern
        WRITE "x" hrep:XmlEntryAuthor
    SEPARATOR
        WRITE "x" hrep:XmlEntryAuthorSep
    ELSE
        FOREACH hrep:HdrAuthorPattern
            WRITE "x" hrep:XmlEntryAuthor
        SEPARATOR
            WRITE "x" hrep:XmlEntryAuthorSep
        END
    END
    WRITE "x" hrep:XmlEntry3
END
            
#### query patterns ####

# General header field info
@query hrep:HdrProtoPattern
    ( ?header
      ( rdf:type hdr:HeaderField
      & hdr:fieldName ?name
      & hdr:status ?status
      & [ hdr:label ?purpose ]
      & hdr:protocol ?p
        ( hdr:protocolName ?pname
        & hdr:specification ?ps 
          ( hdr:document ?psdocument
          & hdr:xref     ?psxref
          )
        )
      )
    )

# Detail header field info (augments basic header data)
# Note:  some optional sections below are for diagnostic purposes
@query hrep:HdrDetailPattern
    ( ?header
      ( [ hdr:section ?hssection ]
      & hdr:specification ?hs 
        ( hdr:document ?hsdocument
        & [ hdr:label   ?hslabel   ]
        & [ hdr:xref    ?hsxref    ]
        & [ hdr:section ?hssection ]
        )
      & [ hdr:comment ?info ]
      )
    )

# Controller/Author query patterns separate:
# may be repeated, with re-use of bound variables
#
# Currently transitioning from hdr:author to hdr:controller,
# with a view to using these as separate values.

@query hrep:HdrControllerPattern
    ( ?header hdr:controller @hrep:HdrPersonPattern )

@query hrep:HdrAuthorPattern
    ( ?header hdr:author     @hrep:HdrPersonPattern )

@query hrep:HdrPersonPattern
    ( ?person
      ( foaf:name ?aname
      & ( foaf:mbox     ?ambox
        | foaf:homepage ?ahomepage
        )
      & [ foaf:organization ?orgname ]
      & [ @hrep:HdrPostalPattern ]
      & [ foaf:workplaceTel ?wtel ]
      & [ foaf:workplaceFax ?wfax ]
      & [ foaf:workplaceHomepage ?wurl ]
      )
    )

@query hrep:HdrPostalPattern
    ( foaf:workplacePostal ?wp
      ( [ foaf:building ?wpbuilding ]
      & [ foaf:street1  ?wpstreet1  ]
      & [ foaf:street2  ?wpstreet2  ]
      & [ foaf:city     ?wpcity     ]
      & [ foaf:area     ?wparea     ]
      & [ foaf:postcode ?wppostcode ]
      & [ foaf:country  ?wpcountry  ]
      )
    )

#### HTML output templates ####

@text hrep:TableHead
    ( "<html>" NL
      "<head>" NL
      "<title>Table of header field registrations</title>" NL
      "</head>" NL
      "<body>" NL
      "<h1>Table of header field registrations</h1>" NL
      "<table border='1' cellspacing='2' cellpadding='0'>" NL
      "<tr>" NL
      "<td><h4>Header name</h4></td>" NL
      "<td><h4>Protocol</h4></td>" NL
      ### "<td><h4>Purpose</h4></td>" NL
      "</tr>" NL
    )

@text hrep:TableItem
    ( "<tr>" NL
      "<td><a href='" ?pname "/" ?name ".html'>" ?name "</a></td>" NL
      "<td><a href='" ?psdocument "'>" ?pname "</a></td>" NL
      "<td>" NL
      ( IFDEF ?purpose : ?purpose NL )
      "</td>" NL
      "</tr>" NL
    )

@text hrep:NoDetail
    ( "<tr><td colspan='3'>No detail found for header field "
      ?name "</td></tr>" NL
    )

@text hrep:TableFoot
    ( "</table>" NL
      "</body>" NL
      "</html>" NL
    )

@text hrep:TableEmpty
    ( "<tr><td colspan='3'>No header fields found</td></tr>" NL 
    )

@text hrep:HdrEntry1
    ( "<h3>Header field: " ?name "</h3>" NL
      (IFDEF ?purpose : "<p>" ?purpose "</p>" NL )
      "<dl>" NL
      "<dt>Applicable protocol: </dt><dd>" ?pname
        " (<a href='" ?psdocument "'>" ?psdocument "</a>" ")</dd>" NL
      "<dt>Status:</dt><dd>" ?status "</dd>" NL
      "<dt>Author/Change controller:</dt>" NL
      "<dd>" NL
    )

@text hrep:HdrEntryAuthor
    ( ?aname
      (IFDEF ?ambox     : "  (<a href='" ?ambox     "'>" ?ambox     "</a>)" )
      (IFDEF ?ahomepage : "  (<a href='" ?ahomepage "'>" ?ahomepage "</a>)" )
      "<br>" NL
      (IFDEF ?orgname    : ?orgname    TRIMWS (DEFER : ",<br>" NL) )
      (IFDEF ?wpbuilding : ?wpbuilding TRIMWS (DEFER : ",<br>" NL) )
      (IFDEF ?wpstreet1  : ?wpstreet1  TRIMWS (DEFER : ", ") )
      (IFDEF ?wpstreet2  : ?wpstreet2  TRIMWS (DEFER : ", ") )
      (IFDEF ?wpcity     : (FLUSH : ",<br>" NL) ?wpcity TRIMWS (DEFER : ", ") )
      (IFDEF ?wparea     : ?wparea     TRIMWS (DEFER : ", ") )
      (IFDEF ?wppostcode : ?wppostcode TRIMWS (DEFER : ", ") )
      (IFDEF ?wpcountry  : ?wpcountry  TRIMWS (DEFER : ", ") )
      (FLUSH : ".<br>" NL)
      (IFDEF ?wtel  : "<i>Tel: " ?wtel "</i><br>" NL )
      (IFDEF ?wfax  : "<i>Fax: " ?wfax "</i><br>" NL )
      (IFDEF ?wurl  : "<i>URL: <a href='" ?wurl "'>" ?wurl "</a></i><br>" NL )
    )

@text hrep:HdrEntryAuthorSep
    ( TRIMWS )
    ## ( "<br>" NL )

@text hrep:HdrEntry3
    ( "</dd>" NL
      "<dt>Specification document(s):</dt>" NL
      "<dd><a href='" ?hsdocument "'>" ?hsdocument "</a>"
        (IFDEF ?hssection : " (" ?hssection ")" )
        "</dd>" NL
      (IFDEF ?info : "<dt>Related information:</dt>" NL
        "<dd>" ?info  "</dd>" NL )
      "</dl>" NL
    )

#### XML2RFC output templates ####

# Summary table

@text hrep:XmlTableHeadt
    ( "<texttable" 
        ## " anchor='" ?xmlname "'"
        ## "' title='" ?xmlname "'"
        ">" NL
      "<preamble></preamble>" NL
      "<ttcol align='left' width='30%'>Header name</ttcol>" NL
      "<ttcol align='left' width='10%'>Protocol</ttcol>" NL
      "<ttcol align='left' width='10%'>Status</ttcol>" NL
      "<ttcol align='left'></ttcol>" NL
    )

@text hrep:XmlTableItemt
    ( "<c>" ?name "</c><c>" ?pname "</c><c>" ?status "</c>" 
      ( IFDEF ?purpose : "<c>" ?purpose "</c>"
      )
      NL
    )

@text hrep:XmlTableFoott
    ( "<postamble></postamble></texttable>" NL NL
    )

@text hrep:XmlTableHead
    ( "<figure" 
        ## " anchor='" ?xmlname "'"
        ## "' title='" ?xmlname "'"
        ">" NL
      "<preamble></preamble><artwork><![CDATA[" NL
      "Header name                     Protocol  Status" NL
      "-----------                     --------  ------" NL
    )

@text hrep:XmlTableItem
    ( ?name (TABNL 32) ?pname (TABNL 42) ?status
#      ( IFDEF ?purpose :
#        (TABSP 30) (LEFT 30) (WRAP 64) ?purpose
#      )
      (LEFT 0) NL
    )

@text hrep:XmlTableFoot
    ( "]]></artwork><postamble></postamble></figure>" NL NL
    )

@text hrep:XmlTableEmpty
    ( "(No header fields found)" NL
    )

# Header field description

@text hrep:XmlEntry1
    ( "<section anchor='hdr." ?name 
        "' title='Header field: " ?name "'>" NL
      "<t><list style='hanging'>"
      (IFDEF ?purpose : 
        "<t hangText='Description:'><vspace/>" ?purpose "</t>" NL 
      )
      "<t hangText='Applicable protocol:'>"
        (IFDEF ?psxref : "<xref target='" ?psxref "'>" ?pname "</xref>"
                       | ?pname )
        "</t>" NL
      "<t hangText='Status:'>" ?status "</t>" NL
      "<t hangText='Author/change controller:'>"
    )

@text hrep:XmlEntryAuthor
    ( NL "<vspace/>" ?aname
      ( IFDEF ?ambox     : "  (" ?ambox     ")" )
      ( IFDEF ?ahomepage : "  (" ?ahomepage ")" )
      NL
      ( IFDEF ?orgname    : "<vspace/>" ?orgname NL )
    )

### Not used:
@text hrep:FullXmlEntryAuthor
    ( NL "<vspace/>" ?aname
      ( IFDEF ?ambox     : "  (" ?ambox     ")" )
      ( IFDEF ?ahomepage : "  (" ?ahomepage ")" )
      NL "<vspace/>"
      ( IFDEF ?orgname    : ?orgname    TRIMWS ( DEFER : ",<vspace/>" NL ) )
      ( IFDEF ?wpbuilding : ?wpbuilding TRIMWS ( DEFER : ",<vspace/>" NL ) )
      ( IFDEF ?wpstreet1  : ?wpstreet1  TRIMWS ( DEFER : ", ") )
      ( IFDEF ?wpstreet2  : ?wpstreet2  TRIMWS ( DEFER : ", ") )
      ( IFDEF ?wpcity     :
        ( FLUSH : "," NL "<vspace/>" ) ?wpcity TRIMWS ( DEFER : ", ") 
      )
      ( IFDEF ?wppostcode : ?wppostcode TRIMWS ( DEFER : ", ") )
      ( IFDEF ?wpcountry  : ?wpcountry  TRIMWS ( DEFER : ", ") )
      ( FLUSH : ".<vspace/>" NL )
      ( IFDEF ?wtel       : "Tel: " ?wtel "<vspace/>" NL )
      ( IFDEF ?wfax       : "Fax: " ?wfax "<vspace/>" NL )
      ( IFDEF ?wurl       : 
        "URL: <eref target='" ?wurl "'>" ?wurl "</eref>" "<vspace/>" NL
      )
    )

@text hrep:XmlEntryAuthorSep
    ( TRIMWS )
    ## ( "<vspace blankLines='0'/>" NL )

@text hrep:XmlEntry3
    ( "</t>" NL
      "<t hangText='Specification document(s):'> <vspace/>" NL
      (IFDEF ?hsxref : "<xref target='" ?hsxref "'>" ?hslabel "</xref>"
                     | ?hslabel )
      ( IFDEF ?hssection : " (" ?hssection ")" )
      "</t>" NL
      ( IFDEF ?info : "<t hangText='Related information:'><vspace/>" NL
        ?info "</t>" NL
      ) 
      "</list></t></section>"  NL 
    )

#--------+---------+---------+---------+---------+---------+---------+---------+
# 
#   Copyright (c) 2004, G. KLYNE.  All rights reserved.
# 
#   This is free software; you can redistribute it and/or modify
#   it under the terms of the GNU General Public License as published by
#   the Free Software Foundation; either version 2 of the License, or
#   (at your option) any later version.
# 
#   This software is distributed in the hope that it will be useful,
#   but WITHOUT ANY WARRANTY; without even the implied warranty of
#   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
#   GNU General Public License for more details.
# 
#   You should have received a copy of the GNU General Public License
#   along with this software; if not, write to:
#     The Free Software Foundation, Inc.,
#     59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
#   or view the web page at:
#     http://www.gnu.org/copyleft/gpl.html
# 
#--------+---------+---------+---------+---------+---------+---------+---------+
#  $Source: /file/cvsdev/HdrRegistry/Attic/GenHeaderRegistry.rep,v $
#  $Author: graham $
#  $Revision: 1.6 $
#  $Log: GenHeaderRegistry.rep,v $
#  Revision 1.6  2004/10/20 15:09:49  graham
#  Revised format of header field summary table
#
#  Revision 1.5  2004/08/11 11:14:05  graham
#  Sync.
#
#  Revision 1.4  2004/04/16 12:15:16  graham
#  Remove software copy from Web CVS
#
#  Revision 1.3  2004/04/13 15:13:53  graham
#  Fix up problems with Author/Controller handling.
#  Remove Origin header field, and add Accept-Language.
#
#  Revision 1.2  2004/04/07 15:03:59  graham
#  Update report format for XML2RFC output
#  Update header field definitions
#  Add Charles Lindsey's Netnews header definitions
#
#  Revision 1.1  2004/03/26 21:25:09  graham
#  New and modified files for message header field document
#  generation using the generic N3GenReport module.