AutoDoc Manual

Comprehensive Guide to Setting Up and Using AutoDoc

Overview

AutoDoc is a dynamic web service designed to generate customizable business and legal documents using templates and configuration files. It supports seamless integration with external websites for document rendering.

Key Features

• Dynamic document generation with Markdown templates.
• Integration with external websites via API.
• Customizable layouts and navigation options.
• Support for multilingual documents (e.g., English, Thai).
• Automatic link generation for all documents.

How It Works

1. Request a document through a clean URL (e.g., /doc/privacy_policy).
2. Use config.txt to configure variables and document links.
3. Render the requested document using a Markdown template and the AutoDoc web service.
4. Customize layouts and navigation for tailored user experiences.

Example Implementation

An example implementation of AutoDoc can be found at:

• Privacy Policy
• Terms of Service

The setup uses the following files:

• index.php: Handles document requests and communicates with AutoDoc.
• config.txt: Stores configuration variables and document mappings.
• .htaccess: Enables clean URLs for document access.

Configuration

config.txt Structure

# General Information
effective_date=March 1st, 2024
company_name=Example Company Ltd.
company_website=https://example.com
contact_email=support@example.com
company_address=1234 Example St., City, Country

# Navigation
enable_navigation=true
navigation_position=top
enable_side_menu=true

# Documents
[Documents]
privacy_policy=privacypolicy-application.md
terms_of_service=tos-application.md
refund_policy=refund-policy.md

Deployment Steps

1. Create a /doc/ folder on the target domain.
2. Upload index.php, config.txt, and .htaccess.
3. Customize config.txt to reflect business details and document mappings.
4. Test the setup by visiting URLs such as /doc/privacy_policy.

Technical Details

• Backend: PHP for rendering and API communication.
• Templates: Markdown for flexibility and readability.
• Frontend: HTML/CSS for customizable layouts.
• Web Server: Apache with .htaccess for clean URLs.

Future Enhancements

• Admin panel for managing templates and configurations.
• PDF export for downloadable documents.
• Version control for templates and configurations.

© 2024 Logic Everything. Powered by AutoDoc.