root/livinglogic.python.www/site/Python_xmlns.py @ 281:915d943732f5

Revision 281:915d943732f5, 32.3 KB (checked in by Walter Doerwald <walter@…>, 15 years ago)

Add Intro page.

Line 
1# -*- coding: iso-8859-1 -*-
2import sys, types, inspect
3
4from ll import url
5from ll.xist import xsc, sims, parsers
6from ll.xist.ns import html, chars, htmlspecials, specials, abbr, meta, doc, code, xml, text
7
8
9class Page(object):
10    """
11    A webpage in the sitemap tree.
12    This is an abstract class, that provides common
13    functionality for derived classes.
14   
15    All the methods that raise a NotImplemented error
16    must be implemented by derived classes.
17    """
18
19    def getName(self):
20        """
21        return the name of the page as a string.
22        This name must be unique within the context
23        of the siblings of the page.
24        """
25        raise NotImplementedError()
26
27    def getURL(self):
28        """
29        return a link to the page
30        """
31        raise NotImplementedError()
32
33    def getTitle(self):
34        """
35        return the title for the page
36        """
37        raise NotImplementedError()
38
39    def getLocalKeywords(self):
40        """
41        return a sequence of keywords local to this page.
42
43        A keyword may be anything that can be converted to an &xist;
44        node, like a string (8bit or Unicode) or an &xist entity.
45        """
46        raise NotImplementedError()
47
48    def getInheritableKeywords(self):
49        raise NotImplementedError()
50
51    def getKeywords(self):
52        keywords = list(self.getLocalKeywords())
53        page = self
54        while page is not None:
55            keywords[:0] = page.getInheritableKeywords()
56            page = page.getParent()
57        return keywords
58
59    def getLinkInfo(self):
60        raise NotImplementedError()
61
62    def getDescription(self):
63        raise NotImplementedError()
64
65    def getParent(self):
66        raise NotImplementedError()
67
68    def setParent(self):
69        raise NotImplementedError()
70
71    def getName(self):
72        raise NotImplementedError()
73
74    def getCrumb(self):
75        raise NotImplementedError()
76
77    def getChildByIndex(self, index):
78        raise NotImplementedError()
79
80    def getChildByName(self, index):
81        raise NotImplementedError()
82
83    def getFirstSibling(self):
84        parent = self.getParent()
85        if parent is None:
86            return None
87        else:
88            return parent.getChildByIndex(0)
89
90    def getPrevSibling(self):
91        parent = self.getParent()
92        if parent is None:
93            return None
94        else:
95            sibling = None
96            for child in parent.getChildren():
97                if child is self:
98                    break
99                sibling = child
100            return sibling
101
102    def getNextSibling(self):
103        parent = self.getParent()
104        if parent is None:
105            return None
106        else:
107            sibling = None
108            for child in parent.getChildren():
109                if child is self:
110                    sibling = self
111                elif sibling is not None:
112                    return child
113                else:
114                    sibling = None
115            return None
116
117    def getLastSibling(self):
118        parent = self.getParent()
119        if parent is None:
120            return None
121        else:
122            return parent.getChildByIndex(-1)
123
124    def __len__(self):
125        raise NotImplementedError()
126
127    def getChildren(self):
128        children = []
129        index = 0
130        while 1:
131            try:
132                children.append(self.getChildByIndex(index))
133            except IndexError:
134                break
135            index + 1
136        return children
137
138    def __getitem__(self, index):
139        if type(index) in (types.IntType, types.LongType):
140            return self.getChildByIndex(index)
141        elif type(index) in (types.StringType, types.UnicodeType):
142            if index=="":
143                index = []
144            else:
145                index = index.split("/")
146        if type(index) in (types.ListType, types.TupleType):
147            result = self
148            for i in index:
149                if type(i) in (types.IntType, types.LongType):
150                    result = result.getChildByIndex(i)
151                elif type(i) in (types.StringType, types.UnicodeType):
152                    result = result.getChildByName(i)
153                else:
154                    raise TypeError("illegal index type %r" % type(i))
155            return result
156        else:
157            raise TypeError("wrong type %s for index (must be int, long, string, unicode or tuple)" % type(index))
158
159    def getPath(self):
160        path = []
161        page = self
162        while page is not None:
163            path.insert(0, page)
164            page = page.getParent()
165        return path
166
167    def getPathString(self):
168        return "/".join([ page.getName() for page in self.getPath() if page.getParent()])
169
170    def getRoot(self):
171        """
172        return the root page (i.e. the one without a parent)
173        """
174        parent = self
175        while 1:
176            testparent = parent.getParent()
177            if testparent is None:
178                return parent
179            parent = testparent
180
181    def __repr__(self):
182        return '<%s object path="%s" at 0x%x>' % (self.__class__.__name__, self.getPathString(), id(self))
183
184    def getLinks(self):
185        return []
186
187
188class StaticPage(Page):
189    """
190    A webpage in the sitemap tree
191    """
192    def __init__(self, name, *children, **attrs):
193        self.__parent = None
194        self.__name = name
195        self.__crumb = None
196        self.__url = None
197        self.__title = None
198        self.__localkeywords = []
199        self.__inheritablekeywords = []
200        self.__description = None
201        self.__linkinfo = None
202        for (k, v) in attrs.items():
203            if k=="crumb":
204                self.__crumb = v
205            elif k=="url":
206                self.__url = v
207            elif k=="title":
208                self.__title = v
209            elif k=="localkeywords":
210                self.__localkeywords = v
211            elif k=="inheritablekeywords":
212                self.__inheritablekeywords = v
213            elif k=="description":
214                self.__description = v
215            elif k=="linkinfo":
216                self.__linkinfo = v
217            else:
218                raise ValueError("unknown keyword %s" % k)
219        for child in children:
220            child.setParent(self) # this creates a cycle
221        self.__children = list(children)
222
223    def getName(self):
224        return self.__name
225
226    def getURL(self):
227        return self.__url
228
229    def getTitle(self):
230        return self.__title
231
232    def getLocalKeywords(self):
233        return self.__localkeywords
234
235    def getInheritableKeywords(self):
236        return self.__inheritablekeywords
237
238    def getLinkInfo(self):
239        return self.__linkinfo
240
241    def getDescription(self):
242        return self.__description
243
244    def getCrumb(self):
245        return self.__crumb
246
247    def getParent(self):
248        return self.__parent
249
250    def setParent(self, parent):
251        self.__parent = parent
252
253    def getChildByIndex(self, index):
254        return self.__children[index]
255
256    def getChildByName(self, index):
257        for child in self.__children:
258            if child.getName() == index:
259                return child
260        raise KeyError("unknown child %r in page %r" % (index, self.getPathString()))
261
262    def getChildren(self):
263        return self.__children
264
265    def __len__(self):
266        return len(self.__children)
267
268    def getLinks(self):
269        links = super(StaticPage, self).getLinks()
270
271        url = self.getURL()
272        pos = url.rfind(".")
273        if pos>=0:
274            fourl = url[:pos+1] + "fo"
275            pdfurl = url[:pos+1] + "pdf"
276        else:
277            fourl = url + ".fo"
278            pdfurl = url + ".pdf"
279
280        return links + [
281            html.link(href=fourl, rel="alternate", type="text/xml", title="An XSL-FO version of this page"),
282            html.link(href=pdfurl, rel="alternate", type="application/pdf", title="A PDF version of this page"),
283        ]
284
285
286class XISTPage(StaticPage):
287    def getLinks(self):
288        links = super(XISTPage, self).getLinks()
289
290        url = self.getURL()
291        pos = url.rfind(".")
292        if pos>=0:
293            txturl = url[:pos+1] + "txt"
294            xmlurl = url[:pos+1] + "htmlxsc"
295        else:
296            txturl = url + ".txt"
297            xmlurl = url + ".htmlxsc"
298
299        return [
300            html.link(href=txturl, rel="alternate", type="text/plain", title="A plain text version of this page"),
301            html.link(href=xmlurl, rel="alternate", type="text/xml", title=("The ", abbr.xist(), " source of this page"))
302        ] + links
303
304
305class PythonSourcePage(XISTPage):
306    def getLinks(self):
307        links = super(PythonSourcePage, self).getLinks()
308        url = self.getURL()
309        if url.endswith(".html"):
310            url = url[:-5] + "_module.py"
311        else:
312            url = url + "_module.py"
313        return links + [html.link(href=url, rel="alternate", type="text/x-python", title="The Python module described in this page")]
314
315
316pages = XISTPage("Python",
317    PythonSourcePage("XIST",
318        XISTPage("Intro",
319            crumb="Intro",
320            linkinfo=("Quick introduction to ", abbr.xist()),
321            title=(abbr.xist(), " introduction"),
322            url="root:xist/Intro.html",
323            localkeywords=[]
324        ),
325        XISTPage("Howto",
326            crumb="Howto",
327            linkinfo=("Documentation for ", abbr.xist()),
328            title=(abbr.xist(), " documentation"),
329            url="root:xist/Howto.html",
330            localkeywords=[]
331        ),
332        PythonSourcePage("xsc",
333            crumb="xsc",
334            title=(abbr.xist(), ".xsc"),
335            linkinfo=("Module with the ", abbr.xist(), " core classes"),
336            url="root:xist/xsc/index.html"
337        ),
338        PythonSourcePage("ns",
339            PythonSourcePage("html",
340                crumb="html",
341                title=(abbr.xist(), ".ns.html"),
342                linkinfo=("Module implementing ", abbr.html(), " 4.01 (with additions)"),
343                url="root:xist/ns/html/index.html"
344            ),
345            PythonSourcePage("wml",
346                crumb="wml",
347                title=(abbr.xist(), ".ns.wml"),
348                linkinfo=("Module implementing ", abbr.wml(), " 1.3"),
349                url="root:xist/ns/wml/index.html"
350            ),
351            PythonSourcePage("ihtml",
352                crumb="ihtml",
353                title=(abbr.xist(), ".ns.ihtml"),
354                linkinfo=("Module implementing iMode compatible ", abbr.html()),
355                url="root:xist/ns/ihtml/index.html"
356            ),
357            PythonSourcePage("docbook",
358                crumb="docbook",
359                title=(abbr.xist(), ".ns.docbook"),
360                linkinfo="Module implementing DocBook 4.12",
361                url="root:xist/ns/docbook/index.html"
362            ),
363            PythonSourcePage("svg",
364                crumb="svg",
365                title=(abbr.xist(), ".ns.svg"),
366                linkinfo=("Module implementing ", abbr.svg(), " 1.0"),
367                url="root:xist/ns/svg/index.html"
368            ),
369            PythonSourcePage("abbr",
370                crumb="abbr",
371                title=(abbr.xist(), ".ns.abbr"),
372                linkinfo="Module containing many abbreviation entities",
373                url="root:xist/ns/abbr/index.html"
374            ),
375            PythonSourcePage("cond",
376                crumb="cond",
377                title=(abbr.xist(), ".ns.cond"),
378                linkinfo="Module implementing conditional elements (if, else, etc.)",
379                url="root:xist/ns/cond/index.html"
380            ),
381            PythonSourcePage("code",
382                crumb="code",
383                title=(abbr.xist(), ".ns.code"),
384                linkinfo=("Module for embedding Python code in ", abbr.xml()),
385                url="root:xist/ns/code/index.html"
386            ),
387            PythonSourcePage("form",
388                crumb="form",
389                title=(abbr.xist(), ".ns.form"),
390                linkinfo="Module implementing form related elements",
391                url="root:xist/ns/form/index.html"
392            ),
393            PythonSourcePage("php",
394                crumb="php",
395                title=(abbr.xist(), ".ns.ph"),
396                linkinfo=("Module for PHP processing instructions"),
397                url="root:xist/ns/php/index.html"
398            ),
399            PythonSourcePage("jsp",
400                crumb="jsp",
401                title=(abbr.xist(), ".ns.jsp"),
402                linkinfo=("Module for embedding ", abbr.jsp(), " code as processing instructions"),
403                url="root:xist/ns/jsp/index.html"
404            ),
405            PythonSourcePage("meta",
406                crumb="meta",
407                title=(abbr.xist(), ".ns.meta"),
408                linkinfo="Module containing meta information elements",
409                url="root:xist/ns/meta/index.html"
410            ),
411            PythonSourcePage("ruby",
412                crumb="ruby",
413                title=(abbr.xist(), ".ns.ruby"),
414                linkinfo="Module implementing the W3C ruby draft",
415                url="root:xist/ns/ruby/index.html"
416            ),
417            PythonSourcePage("specials",
418                crumb="specials",
419                title=(abbr.xist(), ".ns.specials"),
420                linkinfo="Module implementing some useful general elements",
421                url="root:xist/ns/specials/index.html"
422            ),
423            PythonSourcePage("htmlspecials",
424                crumb="htmlspecials",
425                title=(abbr.xist(), ".ns.htmlspecials"),
426                linkinfo=("Module implementing some common useful elements for ", abbr.html(), " generation"),
427                url="root:xist/ns/htmlspecials/index.html"
428            ),
429            PythonSourcePage("doc",
430                crumb="doc",
431                title=(abbr.xist(), ".ns.doc"),
432                linkinfo="Module for automated documentation generation",
433                url="root:xist/ns/doc/index.html"
434            ),
435            PythonSourcePage("css",
436                crumb="css",
437                title=(abbr.xist(), ".ns.css"),
438                linkinfo=("Module implementing ", abbr.css(), " as ", abbr.xml(), " elements"),
439                url="root:xist/ns/css/index.html"
440            ),
441            PythonSourcePage("cssspecials",
442                crumb="cssspecials",
443                title=(abbr.xist(), ".ns.cssspecials"),
444                linkinfo=("Module implementing some useful elements for ", abbr.css()),
445                url="root:xist/ns/cssspecials/index.html"
446            ),
447            PythonSourcePage("struts_html",
448                crumb="struts_html",
449                title=(abbr.xist(), ".ns.struts_html"),
450                linkinfo=("Module that implements the ", html.a("Struts", href="http://jakarta.apache.org/struts/"), " ", abbr.html(), " tags"),
451                url="root:xist/ns/struts_html/index.html"
452            ),
453            PythonSourcePage("struts_config",
454                crumb="struts_config",
455                title=(abbr.xist(), ".ns.struts_config"),
456                linkinfo=("Module that implements the namespace for ", html.a("Struts", href="http://jakarta.apache.org/struts/"), " configuration files"),
457                url="root:xist/ns/struts_config/index.html"
458            ),
459            crumb="ns",
460            title=(abbr.xist(), ".ns"),
461            linkinfo="Subpackage containing namespace modules",
462            url="root:xist/ns/index.html"
463        ),
464        PythonSourcePage("parsers",
465            crumb="parsers",
466            title=(abbr.xist(), ".parsers"),
467            linkinfo="Module with classes for parsing files",
468            url="root:xist/parsers/index.html"
469        ),
470        PythonSourcePage("converters",
471            crumb="converters",
472            title=(abbr.xist(), ".converters"),
473            linkinfo="Module with the converter class",
474            url="root:xist/converters/index.html"
475        ),
476        PythonSourcePage("presenters",
477            crumb="presenters",
478            title=(abbr.xist(), ".presenters"),
479            linkinfo="Module with classes for printing trees",
480            url="root:xist/presenters/index.html"
481        ),
482        PythonSourcePage("publishers",
483            crumb="publishers",
484            title=(abbr.xist(), ".publishers"),
485            linkinfo="Module with classes for publishing trees",
486            url="root:xist/publishers/index.html"
487        ),
488        PythonSourcePage("sims",
489            crumb="sims",
490            title=(abbr.xist(), ".sims"),
491            linkinfo="Simple schema validation",
492            url="root:xist/sims/index.html"
493        ),
494        PythonSourcePage("errors",
495            crumb="errors",
496            title=(abbr.xist(), ".errors"),
497            linkinfo="Module containing exception classes",
498            url="root:xist/errors/index.html"
499        ),
500        XISTPage("Download",
501            crumb="Download",
502            title=(abbr.xist(), " download"),
503            linkinfo="All versions for download",
504            url="root:xist/Download.html",
505            localkeywords=["download", "file", "archive"]
506        ),
507        XISTPage("History",
508            crumb="History",
509            title=(abbr.xist(), " history"),
510            linkinfo="The development history",
511            url="root:xist/History.html",
512            localkeywords=["history", "changes", "version"]
513        ),
514        XISTPage("Installation",
515            crumb="Installation",
516            title=(abbr.xist(), " installation"),
517            linkinfo="Requirements, installation and configuration",
518            url="root:xist/Installation.html",
519            localkeywords=["installation", "distutils"]
520        ),
521        XISTPage("Migration",
522            crumb="Migration",
523            linkinfo=("How to update your code to new versions of ", abbr.xist()),
524            title=(abbr.xist(), " migration and modernization guide"),
525            url="root:xist/Migration.html",
526            localkeywords=[]
527        ),
528        XISTPage("Mailinglists",
529            crumb="Mailing lists",
530            linkinfo="How to subscribe to the mailing lists",
531            title=(abbr.xist(), " mailing lists"),
532            url="root:xist/Mailinglists.html",
533            localkeywords=["mailing list", "list", "posting", "discussion", "announcement"]
534        ),
535        crumb=abbr.xist(),
536        title=abbr.xist(),
537        linkinfo=("An ", abbr.xml(), "-based extensible ", abbr.html(), " generator"),
538        url="root:xist/index.html",
539        inheritablekeywords=[abbr.xist(), abbr.xml(), "transformation", abbr.xsl(), "hsc"]
540    ),
541    PythonSourcePage("URL",
542        XISTPage("Howto",
543            crumb="Howto",
544            linkinfo=("Special features of ", abbr.url()),
545            title=(abbr.url(), " documentation"),
546            url="root:url/Howto.html",
547            localkeywords=[]
548        ),
549        XISTPage("Download",
550            crumb="Download",
551            title=(abbr.url(), " download"),
552            linkinfo="All versions for download",
553            url="root:url/Download.html",
554            localkeywords=["download", "file", "archive"]
555        ),
556        XISTPage("History",
557            crumb="History",
558            title="URL history",
559            linkinfo="The development history",
560            url="root:url/History.html",
561            localkeywords=["packages", "history", "changes", "version"]
562        ),
563        XISTPage("Installation",
564            crumb="Installation",
565            title="URL installation",
566            linkinfo="Requirements and installation",
567            url="root:url/Installation.html",
568            localkeywords=["installation", "distutils"]
569        ),
570        crumb="url",
571        title="url",
572        linkinfo=("Module implementing ", abbr.url(), "s"),
573        url="root:url/index.html"
574    ),
575    PythonSourcePage("Make",
576        XISTPage("Download",
577            crumb="Download",
578            title="Make download",
579            linkinfo="All versions for download",
580            url="root:make/Download.html",
581            localkeywords=["packages", "download", "file", "archive"]
582        ),
583        XISTPage("History",
584            crumb="History",
585            title="Make history",
586            linkinfo="The development history",
587            url="root:make/History.html",
588            localkeywords=["packages", "history", "changes", "version"]
589        ),
590        XISTPage("Installation",
591            crumb="Installation",
592            title="Make installation",
593            linkinfo="Requirements and installation",
594            url="root:make/Installation.html",
595            localkeywords=["installation", "distutils"]
596        ),
597        XISTPage("Migration",
598            crumb="Migration",
599            linkinfo="How to update your code to new versions of Make",
600            title="Make migration and modernization guide",
601            url="root:make/Migration.html",
602            localkeywords=[]
603        ),
604        crumb="Make",
605        title="Make",
606        linkinfo="object oriented make replacement",
607        url="root:make/index.html",
608        localkeywords=["make", "build", "dependencies", "development", "target"]
609    ),
610    PythonSourcePage("Color",
611        XISTPage("Download",
612            crumb="Download",
613            title="Color download",
614            linkinfo="All versions for download",
615            url="root:color/Download.html",
616            localkeywords=["packages", "download", "file", "archive"]
617        ),
618        XISTPage("History",
619            crumb="History",
620            title="Color history",
621            linkinfo="The development history",
622            url="root:color/History.html",
623            localkeywords=["packages", "history", "changes", "version"]
624        ),
625        XISTPage("Installation",
626            crumb="Installation",
627            title="Color installation",
628            linkinfo="Requirements and installation",
629            url="root:color/Installation.html",
630            localkeywords=["installation", "distutils"]
631        ),
632        crumb="Color",
633        title="Color",
634        linkinfo="handling RGB and other color models",
635        url="root:color/index.html",
636        localkeywords=["RGB", "red", "green", "blue", "HSV", "HSB", "HSL", "HLS", "hue", "saturation", "value", "brightness", "luminance"]
637    ),
638    PythonSourcePage("Sisyphus",
639        XISTPage("Download",
640            crumb="Download",
641            linkinfo="All versions for download",
642            title="Sisyphus download",
643            url="root:sisyphus/Download.html",
644            localkeywords=["download", "file", "archive"]
645        ),
646        XISTPage("History",
647            crumb="History",
648            title="Sisyphus history",
649            linkinfo="The development history",
650            url="root:sisyphus/History.html",
651            localkeywords=["history", "changes", "version"]
652        ),
653        crumb="Sisyphus",
654        title="Sisyphus",
655        linkinfo="Writing cron jobs with Python",
656        url="root:sisyphus/index.html",
657        inheritablekeywords=["packages", "Sisyphus", "cron", "job"]
658    ),
659    PythonSourcePage("ANSIStyle",
660        XISTPage("Download",
661            crumb="Download",
662            title="ANSIStyle download",
663            linkinfo="All versions for download",
664            url="root:ansistyle/Download.html",
665            localkeywords=["download", "file", "archive"]
666        ),
667        XISTPage("History",
668            crumb="History",
669            title="ANSIStyle history",
670            linkinfo="The development history",
671            url="root:ansistyle/History.html",
672            localkeywords=["history", "changes", "version"]
673        ),
674        XISTPage("Installation",
675            crumb="Installation",
676            title="ANSIStyle installation",
677            linkinfo="Requirements and installation",
678            url="root:ansistyle/Installation.html",
679            localkeywords=["installation", "distutils"]
680        ),
681        crumb="ANSIStyle",
682        linkinfo="ANSI colors for output streams and strings",
683        url="root:ansistyle/index.html",
684        inheritablekeywords=["packages", "ANSIStyle", abbr.ansi(), "escape", "color", "console"]
685    ),
686    PythonSourcePage("Toxic",
687        XISTPage("Download",
688            crumb="Download",
689            title="Toxic download",
690            linkinfo="All versions for download",
691            url="root:toxic/Download.html",
692            localkeywords=["packages", "download", "file", "archive"]
693        ),
694        XISTPage("History",
695            crumb="History",
696            title="Toxic history",
697            linkinfo="The development history",
698            url="root:toxic/History.html",
699            localkeywords=["packages", "history", "changes", "version"]
700        ),
701        XISTPage("Installation",
702            crumb="Installation",
703            title="Toxic installation",
704            linkinfo="Requirements and installation",
705            url="root:toxic/Installation.html",
706            localkeywords=["installation", "distutils"]
707        ),
708        crumb="Toxic",
709        title="Toxic",
710        linkinfo=("Generate Oracle functions from PL/SQL embedded in ", abbr.xml()),
711        url="root:toxic/index.html",
712        localkeywords=["Oracle", "user defined function", "PL/SQL", "XML", "HTML", "processing instruction", "PI", "embed"]
713    ),
714    PythonSourcePage("OraSQL",
715        XISTPage("Download",
716            crumb="Download",
717            title="OraSQL download",
718            linkinfo="All versions for download",
719            url="root:orasql/Download.html",
720            localkeywords=["packages", "download", "file", "archive"]
721        ),
722        XISTPage("History",
723            crumb="History",
724            title="OraSQL history",
725            linkinfo="The development history",
726            url="root:orasql/History.html",
727            localkeywords=["packages", "history", "changes", "version"]
728        ),
729        XISTPage("Installation",
730            crumb="Installation",
731            title="OraSQL installation",
732            linkinfo="Requirements and installation",
733            url="root:orasql/Installation.html",
734            localkeywords=["installation", "distutils"]
735        ),
736        crumb="OraSQL",
737        title="OraSQL",
738        linkinfo=("Utilities for working with cx_Oracle"),
739        url="root:orasql/index.html",
740        localkeywords=["Oracle", "cx_Oracle"]
741    ),
742    PythonSourcePage("SQL",
743        XISTPage("Download",
744            crumb="Download",
745            title="SQL download",
746            linkinfo="All versions for download",
747            url="root:sql/Download.html",
748            localkeywords=["packages", "download", "file", "archive"]
749        ),
750        XISTPage("History",
751            crumb="History",
752            title="SQL history",
753            linkinfo="The development history",
754            url="root:sql/History.html",
755            localkeywords=["packages", "history", "changes", "version"]
756        ),
757        XISTPage("Installation",
758            crumb="Installation",
759            title="SQL installation",
760            linkinfo="Requirements and installation",
761            url="root:sql/Installation.html",
762            localkeywords=["installation", "distutils"]
763        ),
764        crumb="SQL",
765        linkinfo=("Simplifies generating ", abbr.sql(), " queries"),
766        url="root:sql/index.html",
767        localkeywords=["packages", "SQL", "query"]
768    ),
769    XISTPage("CVS",
770        crumb=(abbr.cvs(), " access"),
771        title=(abbr.cvs(), " access"),
772        linkinfo=("Access to the ", abbr.cvs(), " repository via ViewCVS"),
773        url="root:cvs.html",
774        localkeywords=[abbr.cvs(), "development", "repository"]
775    ),
776    crumb="Python software",
777    title="Python software",
778    linkinfo="Python packages and modules by LivingLogic",
779    url="root:index.html",
780    inheritablekeywords=["Living", "Logic", "LivingLogic", "Bayreuth", "Python"],
781    localkeywords=["packages", abbr.xist(), "sql", "ansistyle", "sisyphus", "fileutils"]
782)
783
784
785class cat(xsc.Entity):
786    def convert(self, converter):
787        return html.span("CATsystems", class_="caps")
788
789
790class hsc(xsc.Entity):
791    def convert(self, converter):
792        return html.span("HSC", class_="caps")
793    def __unicode__(self):
794        return u"HSC"
795
796
797class pageref(xsc.Element):
798    model = sims.NoElements()
799    class Attrs(xsc.Element.Attrs):
800        class ref(xsc.TextAttr): pass
801
802    def convert(self, converter):
803        if "ref" in self.attrs:
804            page = pages[unicode(self["ref"].convert(converter))]
805        else:
806            page = pages
807        e = html.a(self.content, href=page.getURL(), title=page.getDescription())
808        return e.convert(converter)
809
810
811class download(xsc.Element):
812    model = sims.Empty()
813    class Attrs(xsc.Element.Attrs):
814        class href(xsc.TextAttr): pass
815        class type(xsc.TextAttr): pass
816
817    def convert(self, converter):
818        target = converter.target
819        name = url.URL(unicode(self["href"].convert(converter))).file
820        if "type" in self.attrs:
821            type = self["type"]
822        elif name.endswith(".tar.gz") or name.endswith(".tar.bz2") or name.endswith(".zip"):
823            type = "Source"
824        elif name.endswith(".exe"):
825            type = "Windows installer"
826        elif name.endswith(".src.rpm"):
827            type = "Source RPM"
828        elif name.endswith(".rpm"):
829            type = "Binary RPM"
830        else:
831            type = chars.nbsp()
832
833        if issubclass(target, doc):
834            e = target.item(
835                target.link(unicode(name), href=("http://ftp.livinglogic.de/", self["href"])),
836                " (",
837                type,
838                ", ",
839                specials.filesize(href=("http://ftp.livinglogic.de/", self["href"])),
840                " bytes)"
841            )
842        else:
843            e = html.tr(
844                html.td(html.a(unicode(name), href=("http://ftp.livinglogic.de/", self["href"]), title=("Download http://ftp.livinglogic.de/", self["href"])), class_="file"),
845                html.td(type, class_="type"),
846                html.td(specials.filesize(href=("http://ftp.livinglogic.de/", self["href"])), class_="size"),
847                class_="download"
848            )
849        return e.convert(converter)
850
851
852class downloads(xsc.Element):
853    model = sims.Elements(download)
854    class Attrs(xsc.Element.Attrs):
855        class version(xsc.TextAttr): pass
856        class date(xsc.TextAttr): pass
857
858    def convert(self, converter):
859        target = converter.target
860        if issubclass(target, doc):
861            e = target.section(
862                target.title("Version ", self["version"], " (released ", self["date"], ")"),
863                target.ulist(self.content)
864            )
865        else:
866            e = xsc.Frag(
867                html.tr(
868                    html.th(self["version"], class_="version"),
869                    html.th("Type", class_="type"),
870                    html.th("Size", class_="size")
871                ),
872                self.content
873            )
874            if "date" in self.attrs:
875                e[0][0].append(" ", html.span("(released ", self["date"], ")", class_="note"))
876        return e.convert(converter)
877
878
879class alldownloads(xsc.Element):
880    model = sims.Elements(downloads)
881
882    def convert(self, converter):
883        target = converter.target
884        if issubclass(target, doc):
885            e = self.content
886        else:
887            e = html.div(
888                htmlspecials.plaintable(
889                    self.content,
890                    class_="downloads"
891                ),
892                align="center"
893            )
894        return e.convert(converter)
895
896
897class content(xsc.Element):
898    model = sims.Elements(alldownloads, doc.block)
899    def convert(self, converter):
900        return self.content.convert(converter)
901
902
903class page(xsc.Element):
904    model = sims.Elements(content)
905    class Attrs(xsc.Element.Attrs):
906        class title(xsc.TextAttr): pass
907        class keywords(xsc.TextAttr): pass
908        class description(xsc.TextAttr): pass
909        class refresh(xsc.TextAttr): pass
910        class class_(xsc.TextAttr): xmlname = "class"
911        class path(xsc.TextAttr): pass
912
913    def __linkLine(self, page, type, pos, indent):
914        e = htmlspecials.plaintable()
915
916        # empty space to the left
917        width = max(0, 15*(indent-1))
918
919        e2 = html.tr(valign="top")
920        # empty space to the left of title strip
921        if width:
922            e2.append(html.td(htmlspecials.pixel(width=width), rowspan=2))
923
924        # lines
925        if indent>0:
926            if type=="child" and page is not page.getParent()[-1]:
927                e2.append(html.td(htmlspecials.autoimg(src="root:images/Links/Tree_Cont.gif", alt=""), class_="joiner"))
928            else:
929                e2.append(html.td(htmlspecials.autoimg(src="root:images/Links/Tree_End.gif", alt="")))
930
931        # title strip
932        name = page.getName()
933        if type=="here":
934            e2.append(html.td(html.div(name, class_="linktitle"), width=130, valign="bottom"))
935        else:
936            e2.append(html.td(html.a(html.span("(visited)", class_="visited", title="page has been visited"), name, href=page.getURL(), class_="linktitle"), width=130, valign="bottom"))
937
938        # next line
939        e.append(e2)
940
941        e2 = html.tr()
942        # lines
943        if indent>0:
944            if type=="child" and page is not page.getParent()[-1]:
945                e2.append(html.td(htmlspecials.pixel(width=15), class_="joiner"))
946            else:
947                e2.append(html.td(htmlspecials.pixel(width=15)))
948        if pos>=6:
949            name = "Link_6"
950        else:
951            name = "Link_%d%s" % (pos, "abcde"[indent])
952        e2.append(html.td(html.div(page.getLinkInfo(), class_="linkinfo")))
953        e.append(e2)
954        return e
955
956    def __links(self, context):
957        e = html.div(class_="links")
958        path = context.path.split("/")
959        curpage = pages
960        indent = 0
961        pos = 1
962        while curpage is not context.page:
963            e.append(self.__linkLine(curpage, "parent", pos, indent))
964            curpage = curpage.getChildByName(path[indent])
965            indent += 1
966            pos += 1
967        e.append(self.__linkLine(curpage, "here", pos, indent))
968        indent += 1
969        pos += 1
970        for curpage in curpage:
971            e.append(self.__linkLine(curpage, "child", pos, indent))
972            pos += 1
973        return e
974
975    def _crumbs(self, context):
976        e = xsc.Frag()
977        page = context.page
978        while page is not None:
979            if page is context.page:
980                e.insert(0, html.span(page.getCrumb(), class_="here"))
981            else:
982                e.insert(0, self.xmlns.pageref(page.getCrumb(), ref=page.getPathString()))
983            e.insert(0, chars.nbsp(), htmlspecials.autoimg(src="root:images/KruemmelPfeil.gif", alt=" > "), chars.nbsp())
984            page = page.getParent()
985        e.insert(0, html.a("Home", href="http://www.livinglogic.de/", hreflang="de", title="The company homepage (in german)"))
986        return e
987
988    def convert(self, converter):
989        converter[doc.pyref].base = "root:"
990        target = converter.target
991        context = converter[self]
992        context.path = unicode(self["path"].convert(converter))
993        context.page = pages[context.path]
994        # if the page does not have a "content" element, the whole page's content is considered as the page content
995        e_content = self.content.find(xsc.FindType(content))
996        if not len(e_content):
997            e_content = self.content
998        if issubclass(target, text):
999            e = target.html(
1000                target.head(
1001                    meta.contenttype(),
1002                    target.title(self["title"]),
1003                ),
1004                target.body(
1005                    e_content
1006                )
1007            )
1008        elif issubclass(target, doc):
1009            return e_content.convert(converter)
1010        elif not issubclass(target, html):
1011            raise ValueError("unknown conversion target %r" % target)
1012        else:
1013            c = htmlspecials.plaintable(
1014                html.tr(
1015                    html.td(htmlspecials.pixel(height=50)), # links
1016                    html.td( # content
1017                        html.a(
1018                            htmlspecials.autoimg(
1019                                src="root:images/LivingLogicKlein.gif",
1020                                border=0,
1021                                alt="[LivingLogic]",
1022                            ),
1023                            href="http://www.livinglogic.de/",
1024                            hreflang="de",
1025                            title="The company homepage (in german)"
1026                        ),
1027                        align="left",
1028                        valign="middle",
1029                        height=50
1030                    ),
1031                    class_="header" # this covers the background image
1032                ),
1033                html.tr(
1034                    html.td(colspan=2, class_="linie")
1035                ),
1036                html.tr(
1037                    html.td(htmlspecials.pixel()),
1038                    html.td(html.div(self._crumbs(context), class_="crumbs")),
1039                    valign="top"
1040                ),
1041                html.tr(
1042                    html.td(self.__links(context)),
1043                    html.td(html.div(e_content, class_="content")),
1044                    valign="top"
1045                ),
1046                width="100%"
1047            )
1048
1049            keywords = context.page.getKeywords()
1050            if len(keywords):
1051                keywords = meta.keywords(xsc.Frag(*keywords).withsep(", "))
1052            else:
1053                keywords = xsc.Null
1054            description = context.page.getDescription()
1055            if description is not None:
1056                description = meta.description(description)
1057            else:
1058                description = xsc.Null
1059            if "refresh" in self.attrs:
1060                refresh = html.meta(http_equiv="refresh", content=self["refresh"])
1061            else:
1062                refresh = xsc.Null
1063
1064            firstsibling = context.page.getFirstSibling()
1065            if firstsibling is not None:
1066                if firstsibling != context.page:
1067                    firstsibling = html.link(rel="first", title="First page in set", href=firstsibling.getURL())
1068                else:
1069                    firstsibling = None
1070
1071            prevsibling = context.page.getPrevSibling()
1072            if prevsibling is not None:
1073                if prevsibling != context.page:
1074                    prevsibling = html.link(rel="prev", title="Previous page", href=prevsibling.getURL())
1075                else:
1076                    prevsibling = None
1077
1078            nextsibling = context.page.getNextSibling()
1079            if nextsibling is not None:
1080                if nextsibling != context.page:
1081                    nextsibling = html.link(rel="next", title="Next page", href=nextsibling.getURL())
1082                else:
1083                    nextsibling = None
1084
1085            lastsibling = context.page.getLastSibling()
1086            if lastsibling is not None:
1087                if lastsibling != context.page:
1088                    lastsibling = html.link(rel="last", title="Last page in set", href=lastsibling.getURL())
1089                else:
1090                    lastsibling = None
1091
1092            parent = context.page.getParent()
1093            if parent is not None:
1094                parent = html.link(rel="up", href=parent.getURL())
1095
1096            top = context.page.getRoot()
1097            if top is not None:
1098                if top != context.page:
1099                    top = html.link(rel="top", href=top.getURL())
1100                else:
1101                    top = None
1102
1103            icbm = "49.9433; 11.5703"
1104
1105            e = target.html(
1106                target.head(
1107                    meta.contenttype(),
1108                    target.title(self["title"]),
1109                    meta.stylesheet(href="root:Main.css", media="screen, projection, tv"),
1110                    meta.stylesheet(href="root:Doc.css", media="screen, projection, tv"),
1111                    meta.stylesheet(href="root:MainPrint.css", media="print"),
1112                    meta.stylesheet(href="root:DocPrint.css", media="print"),
1113                    meta.author(name=u"Walter Dörwald", email="walter.doerwald@livinglogic.de"),
1114                    html.meta(name="icbm", content=icbm),
1115                    html.meta(name="geo.position", content=icbm),
1116                    html.meta(name="geo.placename", content="Bayreuth, Germany, Europe"),
1117                    html.meta(name="geo.region", content="DE-BY"),
1118                    html.meta(name="DC.title", content=self["title"]),
1119                    html.link(rel="icon", href="root:images/favicon.gif", type="image/gif"),
1120                    top,
1121                    parent,
1122                    firstsibling,
1123                    prevsibling,
1124                    nextsibling,
1125                    lastsibling,
1126                    context.page.getLinks(),
1127                    keywords,
1128                    description,
1129                    refresh
1130                ),
1131                target.body(
1132                    target.div(htmlspecials.autoimg(src=("root:images/Backdrops/Nautilus-", self["class_"], ".jpg"), alt=""), class_="backdrop"),
1133                    target.div(c, class_="page"),
1134                    class_=self["class_"]
1135                ),
1136                {(xml, "lang"): "en"},
1137                lang="en",
1138            )
1139            e = xsc.Frag(
1140                xml.XML10(),
1141                "\n",
1142                target.DocTypeXHTML10transitional(),
1143                "\n",
1144                e
1145            )
1146        return e.convert(converter)
1147
1148
1149class xmlns(xsc.Namespace):
1150    xmlname = "py"
1151    xmlurl = "http://xmlns.livinglogic.de/Python"
1152xmlns.makemod(vars())
1153
Note: See TracBrowser for help on using the browser.