forked from LiveCarta/BookConverter
21 lines
1.2 KiB
Markdown
21 lines
1.2 KiB
Markdown
# About
|
|
|
|
This repository contains code related to docx/epub files conversion to livecarta inner format.
|
|
|
|
Livecarta book format is tree structure, where nodes are chapters.
|
|
Livecarta chapter is title + html code. Livecarta html code follows some restrictions:
|
|
|
|
- On structure. It should be not nested, the less nested tags, the better.
|
|
- It is only allowed that the <p> contains <span>, <span> contains <span>.
|
|
- The structure tags that are used: `span, p, blockquote, ul, ol, li, table`.
|
|
- List of all valid tags: `iframe, a, span, blockquote, i, s, u, ul, ol, li, strong, p, img, caption, thead, tbody, td, th, tr, table, sup.`
|
|
- Styles are added as _inline_, i.e. attribute `style` in html tag.
|
|
- Each tag has its own restrictions on attributes and style. See doc/style_config
|
|
|
|
|
|
# Top level project structure
|
|
|
|
- `consumer.py` - code which is responsible for receiving messages from rabbitMQ
|
|
- class `Access` - contains API code which is responsible for interaction with server.
|
|
- class `Solver` - contains code responsible for pipeline of solving the task: receiving book file, conversion, status updating, sending result back to server.
|
|
- `livecarta_config.py `- constants that depend on LiveCarta |