Skip to content

documentag/docs

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

30 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

format plików archiwum zawierające dane:

schema/ - schema for commands
  pdf.xslt
  ocr.xslt            
  table.xslt
  right.xslt
    
data/ - data tables, history changes (commands) data inputs, e.g.: add icon, extracted ocr data
  history.xml      
  ops.xml
  files.xml
  rights.xml
  api.xml
  js.xml      

src/ - all uploded inputs from email, api
  file.pdf
  ocr.txt
  icon.svg
  icon.png
  markdown.md
  favicon.ico


index.html -   redndered format with xslt schema from xml data and included binary as name of file
    <meta> - describe the source file
    <body> - include all path to data, give the rights to update file

Why?

  • Utrzymanie, Maintenance
    • Aktualizacje
    • Zależności
    • Security
    • server
    • software
    • environment
  • Marketing, Zarządzanie, strategia
  • Administracja operations
  • integracja
    • api
    • webhooks
    • plugins
  • optymalizacja
    • latency
  • learn curve - krzywa uczenia

Użycie

  • documentag render for browser
  • documentag host for machine
  • recordns to host on FaaS platform
    • public
    • private

output formats

  • mhtml
  • zip

output services

Hereafter is a subset of the link, that contains in my opinion the most convenient ones.

Python

python -m http.server 8000

Ruby

ruby -run -ehttpd . -p8000

Node

npm install -g http-server
http-server -p 8000

Php

php -S 127.0.0.1:8000

bash

while true; do { echo -e "HTTP/1.1 200 OK\r\n$(date)\r\n\r\n<h1>hello world from $(hostname) on $(date)</h1>" |  nc -vl 8080; } done

Standards

An MHTML file is a web page archive format. It is meant to be stored and viewed but not to be edited directly.

However, you can easily extract the MHTML file to a regular HTML document (with linked files), edit it with your favorite HTML editor and then export it back to an MHTML archive (including the linked files).

you can open/save between HTML and MHTML files

features

  • encryption
  • serialization
  • archive
  • compress
  • minimize (css, js, html)

Tools

SingleFile - Chrome Web Store Save a complete page into a single HTML file SingleFile is an extension that helps you to save a complete page (with CSS, images, fonts, frames, etc.) as a single HTML file.

documentag

generowanie/konewrsja róznych typów dokumentów ze źródła git

dialogware

konwersja text to software

dialogsync

syncrhonizacja źródła kodu z dokumentacją markdown dialogsync: markdown <-> git sourcode

1. W dowolnej przeglądarce internetowej lokalnie

html

documentag -url_from_zip github.com/documentag/docs/archive/refs/heads/main.zip -render_to_html index.html

lub

markdown

documentag -url_from_zip github.com/documentag/docs/archive/refs/heads/main.zip -render_to_md index.md

lub

mhtml

documentag -url_from_zip github.com/documentag/docs/archive/refs/heads/main.zip -render_to_mhtml index.mhtml

open document

open index.html 

2. Na serwerze lub lokalnie w formie uslugi

systemd stop,start,status

tylko do doczytu, renderowania

documentag -url_from_zip github.com/documentag/docs/archive/refs/heads/main.zip -static_host localhost -static_port 80

z zapisem danych

documentag -url_from_zip github.com/documentag/docs/archive/refs/heads/main.zip -static_host localhost -static_port 80 -admin_host localhost -admin_port 8080

3. Poprzez konfigurację cdns na publicznej platformie FaaS

repozytorium git do odczytu

recordns provider ADD doc.domain.com CNAME git-static.faas.ovh
recordns provider ADD doc.domain.com TXT github.com/documentag/example.git

repozytorium git do zapisu

recordns provider ADD doc-admin.domain.com CNAME git-admin.faas.ovh
recordns provider ADD doc-admin.domain.com TXT github.com/documentag/example.git

lub z pliku archiwum zip

recordns provider ADD doc.domain.com CNAME zip-static.faas.ovh
recordns provider ADD doc.domain.com TXT github.com/documentag/docs/archive/refs/heads/main.zip

private user faas server with app and data definition and credentials from env variables

username.oneday.run - user of platform with local user on server with local docker and parameters from TXT

recordns ionos.de ADD doc.domain.com CNAME username.oneday.run
recordns ionos.de ADD _config_docker.doc.domain.com TXT dockerhub.com/documentag/docs
recordns ionos.de ADD _config_code.doc.domain.com TXT github.com/documentag/docs.git
recordns ionos.de ADD _config_data.doc.domain.com TXT github.com/documentag/docs/archive/refs/heads/main.zip

lub

recordns cloudflare.com ADD doc.domain.com CNAME username.oneday.run
recordns cloudflare.com ADD json.doc.domain.com TXT '{ "docker": "dockerhub.com/documentag/docs", "code": "github.com/documentag/docs.git", "data": "github.com/documentag/docs/archive/refs/heads/main.zip"}

lub

recordns provider ADD doc.domain.com CNAME username.oneday.run
recordns provider ADD config.doc.domain.com TXT github.com/documentag/doc-config.git

Formaty danych

  • w formacie archiwum ze strukturą jak wyżej
  • w formacie html z tymi metadanymi wewnątrz

TODO:

Przykład

  1. faktury z całego miesiąca

Email

function create_from_email()

  • python script
    • daterange
    • data type

Document format

  • treść email z załacznikami
    • xml
    • pdf

Init Data in Document

  • move attachements
  • png icon miniatura

Update Data

Buy

  • data/order
  • data/payment
  • data/booking

Sale to customer

  • data/order
  • data/payment
  • data/booking

API

function download_from_api()

  1. Auth data

    • key auth
  2. Request

    • curl request
    • datartange
  3. Init Data in document

  • treść email z załacznikami
    • xml
    • pdf
    • png icon miniatura
    • markdown

Releases

No releases published

Packages

No packages published

Languages