dm.zdoc

dm.zdoc is een kleine Python wrapper rond pydoc om het bruikbaar voor Zope maken.
Opmerking: Python versies onder 2.6 ontberen goede ondersteuning voor namespace pakketten in pydoc. Terwijl Zope zelf niet gebruiken namespace pakketten voor versie 2.12 (die Python 2.6 gebruikt), belangrijke Zope toepassingen (zoals Plone) doen gebruiken namespace pakketten. In deze gevallen de documentatie van pydoc (en bij uitbreiding zdoc) onvolledig.
Gebruik
zdoc kan worden gebruikt via het script dmzdoc, via de module in- of geïntegreerd in een lopende Zope instantie.
In de eerste twee gevallen kan het nodig zijn om de Zope omgevingsvariabelen INSTANCE_HOME en SOFTWARE_HOME om zdoc vertellen waar de Zope bronnen kan worden gevonden ingesteld.
Gebruik via dmzdoc
Het script dmzdoc wordt geïnstalleerd wanneer u setuptools geïnstalleerd.
Anders moet je het zelf installeren. Het heeft de volgende inhoud:
import dm.zdoc; dm.zdoc.cli ()
dmzdoc heeft precies dezelfde opties en parameters als pydoc, gedocumenteerd in pydoc.
Gebruik via module import
De module dm.zdoc definieert dezelfde objecten als pydoc, gedocumenteerd in pydoc.
Geïntegreerd in een lopende Zope bijvoorbeeld
Voor dit gebruik, moet u de module installeren in uw Zope installatie en activeren haar configure.zcml op Zope opstarten. Dit zal de "Zope Root Folder" het uitzicht@@zdoc waarin de documentatie op dezelfde manier als de pydoc http server presenteert geven.
LET OP: Het ontmaskeren van de documentatie van een Zope bijvoorbeeld op deze manier biedt zinvolle inzichten en hackers waardevolle aanwijzingen voor aanslagen kon geven. Waarschijnlijk zal je deze installeert alleen in ontwikkeling gevallen met beperkte toegang

Wat is nieuw in deze release:.

• Ondersteuning voor de & quot; geïntegreerd in een runnging Zope bijvoorbeeld & quot; use case

Eisen

• Python