#! /usr/bin/env python
'''
Support stuff for snapper.py, providing lots of W3C style support.
The division may not be as clean as we would like
'''
__version__ = "$Revision: 1.3 $"
import os
import os.path
from debugtools import debug
class Defaults:
def _compute_h1Title(self, props):
try:
return props["titlePrefix"]+props["shortTitle"]
except KeyError:
return props["shortTitle"]
def _compute_htmlTitle(self, props):
try:
return props["titlePrefix"]+" "+props["shortTitle"]
except KeyError:
return props["shortTitle"]
def _default_doctype(self):
return doctypes[self.maxdoctypecode]
def _compute_maxdoctypecode(self, props):
if props.ed_only:
return "ED"
else:
return props.doctypecode
#def _compute__dateCode(self, props):
# return props._dateCode
#@property
#def commentsDue(self):
# return self.snapshot.commentsDue
@property
def hasPrevious(self):
return hasattr(self, 'pdateCode') or hasattr(self.snapshot, 'pdateCode')
@property
def pdateCode(self):
return self.snapshot.pdateCode
@property
def _dateName(self):
return self.snapshot._dateName
def _compute_directory(self, props):
return props.versioncode
def _compute_versioncode(self, props):
return (props.maxdoctypecode+"-"+
props.groupShortname+"-"+
props.shortname+"-"+
props.dateCode)
def _default_pversioncode(self):
assert self.hasPrevious
return (self.maxdoctypecode+"-"+
self.snapshot.group.shortname+"-"+
self.shortname+"-"+
self.pdateCode)
@property
def versionPrefixURL(self):
# can't easily do relative URLs, because we tell the
# users these URLs...
if self.maxdoctypecode == 'ED':
return self.snapshot.group.draftsURL
if self.maxdoctypecode == 'WD':
return "http://www.w3.org/TR/2008/"
raise RuntimeError, 'dont know how to make version URL'
@property
def thisVersion(self):
return self.versionPrefixURL+self.versioncode+"/"
def _default_previousVersion(self):
return self.versionPrefixURL+self["pversioncode"]+"/"
@property
def latestURL(self):
if self.maxdoctypecode == 'ED':
prefix = self.versionPrefixURL
if self.maxdoctypecode == 'WD':
prefix = "http://www.w3.org/TR/" # not quite the same!
return prefix+self.snapshot.group.shortname+"-"+self.shortname+"/"
@property
def wikiPageURL(self):
return self.snapshot.group.wikiURL+self.wikiPageName
@property
def inLineCredit(self):
if self.authors:
return ", ".join([person.name for person in self.authors])
if len(self.editors) == 1:
ed = "editor"
else:
ed = "eds"
return ", ".join([person.name for person in self.editors]) + ", " + ed
def _default_css(self):
result = """
"""
for stylesheet in self.stylesheets:
result+=('''\n'''
% stylesheet)
result += """\n""" % self
return result
@property
def credits(self):
result = u"
"
for tag in ('Author', 'Editor', 'Contributor'):
attr = tag.lower()+"s"
people = getattr(self, attr)
if people:
if people > 1:
result += u"
%ss:
" % tag
else:
result += u"
%s:
" % tag
for person in people:
result += u"
"+person.line+u"
\n"
result += u"
"
return result
@property
def formats(self):
return '''
This document is also available in these non-normative formats: PDF version.
'''
@property
def referenceText(self):
"""Return standard text that one can use in a References
section to refer to this version of this document
"""
result = u"""%(refTitle)s %(inLineCredit)s. W3C %(doctype)s, %(_dateName)s, %(thisVersion)s. Latest version available at %(latestURL)s.""" % self
return result
@property
def numDocs(self):
return len(self.snapshot.pages)
@property
def allDocs(self):
result = "\n"
for page in self.snapshot.pages:
if page is self:
thisOne = "(this document)"
else:
thisOne = ""
result += u"""
\n"
result += "\n"
return result
@property
def sotdSOD(self):
if len(self.snapshot.pages) < 2:
return ""
result = """
Set of Documents
This document is being published as one of a set of %(numDocs)s documents:
%(allDocs)s
"""%self
return result
@property
def pleaseCommentText(self):
if self.pleaseComment is not None:
return self.pleaseComment
else:
return """
Please Comment By %(commentsDue)s
The %(name)s seeks
public feedback on %(commentOn)s. Please send your
comments to %(commentsList)s@w3.org (public archive). If possible, please offer
specific changes to the text that would address your
concern. You may also wish to check the Wiki
Version of this document for internal-review comments and changes being
drafted which may address your concerns.
This section describes the status of this document at the time of its publication. Other documents may supersede this document. A list of current W3C publications and the latest revision of this technical report can be found in the W3C technical reports index at http://www.w3.org/TR/.
Publication as a Working Draft does not imply endorsement by the W3C Membership. This is a draft document and may be updated, replaced or obsoleted by other documents at any time. It is inappropriate to cite this document as other than work in progress.