README
¶
Documize Community Edition
v0.14.0
To discover Documize please visit https://documize.com
Documize® is a registered trade mark of Documize Inc.
This repository is copyright 2016 Documize Inc. legal@documize.com. All rights reserved.
This software (Documize Community Edition) is licensed under GNU AGPL v3 http://www.gnu.org/licenses/agpl-3.0.en.html
You can operate outside the AGPL restrictions by purchasing Documize Enterprise Edition and obtaining a commercial license by contacting sales@documize.com.
Documentation:
Directories
¶
| Path | Synopsis |
|---|---|
|
This package provides Documize as a single executable.
|
This package provides Documize as a single executable. |
|
api/convert
Package convert provides the gateway to document conversion native and plugin functionality, both in and out of the system.
|
Package convert provides the gateway to document conversion native and plugin functionality, both in and out of the system. |
|
api/convert/excerpt
Package excerpt provides basic functionality to create excerpts of text in English.
|
Package excerpt provides basic functionality to create excerpts of text in English. |
|
api/convert/html
Package html documizes html files.
|
Package html documizes html files. |
|
api/endpoint
Package endpoint provides API endpoints for Documize.
|
Package endpoint provides API endpoints for Documize. |
|
api/endpoint/models
Package models describes the communication format between JS snd Go.
|
Package models describes the communication format between JS snd Go. |
|
api/entity
Package entity provides types that mirror database tables.
|
Package entity provides types that mirror database tables. |
|
api/mail
Package mail sends transactional emails.
|
Package mail sends transactional emails. |
|
api/plugins
Package plugins manages the plug-in componenets of the Documize system.
|
Package plugins manages the plug-in componenets of the Documize system. |
|
api/request
Package request handles database requests for Documize, mostly from the endpoints package.
|
Package request handles database requests for Documize, mostly from the endpoints package. |
|
api/store
Package store provides the implementation for a file system based storage provider.
|
Package store provides the implementation for a file system based storage provider. |
|
api/util
Package util provides utility functions specific to the http-end-point component of Documize.
|
Package util provides utility functions specific to the http-end-point component of Documize. |
|
web
Package web contains the Documize static web data.
|
Package web contains the Documize static web data. |
|
Package main provides a simple Documize plugin for document conversions using libreoffice.
|
Package main provides a simple Documize plugin for document conversions using libreoffice. |
|
documize
command
|
|
|
wordsmith
|
|
|
api
Package api provides the defininitions of types used for communication between different components of the Documize system.
|
Package api provides the defininitions of types used for communication between different components of the Documize system. |
|
environment
Package environment allow environment variables to be obtained from either the environment or the command line.
|
Package environment allow environment variables to be obtained from either the environment or the command line. |
|
log
Package log provides centralized logging for the Documize application.
|
Package log provides centralized logging for the Documize application. |
|
utility
Package utility contains utility functions used by the whole Documize ecosystem.
|
Package utility contains utility functions used by the whole Documize ecosystem. |
|
wordlists
command
Package main creates ordered lists of english words and their stems, based on their frequency.
|
Package main creates ordered lists of english words and their stems, based on their frequency. |
|
wordlists/en-2012
Package words was auto-generated ! From base data at http://invokeit.wordpress.com/frequency-word-lists/ .
|
Package words was auto-generated ! From base data at http://invokeit.wordpress.com/frequency-word-lists/ . |
Click to show internal directories.
Click to hide internal directories.