@fiduswriter/document 0.1.0-alpha.1

package/src/schema/document/structure.js

@@ -0,0 +1,452 @@
+export const doc = {
+    content: "title part*",
+    selectable: false,
+    allowGapCursor: false,
+    attrs: {
+        documentstyle: {
+            default: ""
+        },
+        tracked: {
+            default: false
+        },
+        citationstyle: {
+            // Default citation style
+            default: "apa"
+        },
+        citationstyles: {
+            // Available citation styles
+            default: [
+                "american-anthropological-association",
+                "apa",
+                "chicago-author-date",
+                "chicago-note-bibliography",
+                "harvard-cite-them-right", // previously harvard1
+                "modern-language-association", // previously mla
+                "nature",
+                "oxford-university-press-humsoc"
+            ]
+        },
+        language: {
+            // Default language
+            default: "en-US"
+        },
+        languages: {
+            // Available languages
+            default: [
+                "af-ZA",
+                "sq-AL",
+                "ar",
+                "ast",
+                "be",
+                "br",
+                "bg",
+                "ca",
+                "ca-ES-Valencia",
+                "zh-CN",
+                "da",
+                "nl",
+                "en-AU",
+                "en-CA",
+                "en-NZ",
+                "en-ZA",
+                "en-GB",
+                "en-US",
+                "eo",
+                "fr",
+                "gl",
+                "de-DE",
+                "de-AU",
+                "de-CH",
+                "el",
+                "he",
+                "is",
+                "it",
+                "ja",
+                "km",
+                "lt",
+                "ml",
+                "nb-NO",
+                "nn-NO",
+                "fa",
+                "pl",
+                "pt-BR",
+                "pt-PT",
+                "ro",
+                "ru",
+                "tr",
+                "sr-SP-Cy",
+                "sr-SP-Lt",
+                "sk",
+                "sl",
+                "es",
+                "sv",
+                "ta",
+                "tl",
+                "uk"
+            ]
+        },
+        papersize: {
+            // Default paper size
+            default: "A4"
+        },
+        papersizes: {
+            // Available paper sizes
+            default: ["A4", "US Letter"]
+        },
+        footnote_marks: {
+            default: ["strong", "em", "link"]
+        },
+        footnote_elements: {
+            default: [
+                "paragraph",
+                "heading1",
+                "heading2",
+                "heading3",
+                "heading4",
+                "heading5",
+                "heading6",
+                "figure",
+                "ordered_list",
+                "bullet_list",
+                "horizontal_rule",
+                "equation",
+                "citation",
+                "cross_reference",
+                "blockquote",
+                "table"
+            ]
+        },
+        bibliography_header: {
+            default: {}
+        },
+        template: {
+            default: ""
+        },
+        import_id: {
+            default: ""
+        },
+        copyright: {
+            default: {
+                holder: false,
+                year: false,
+                freeToRead: true,
+                licenses: []
+            }
+        },
+        code_categories: {
+            default: {
+                listing: {
+                    counter: 0,
+                    enabled: true
+                },
+                example: {
+                    counter: 0,
+                    enabled: true
+                },
+                snippet: {
+                    counter: 0,
+                    enabled: false
+                },
+                tutorial: {
+                    counter: 0,
+                    enabled: false
+                },
+                exercise: {
+                    counter: 0,
+                    enabled: false
+                },
+                exercise_solution: {
+                    counter: 0,
+                    enabled: false
+                }
+            }
+        },
+        code_languages: {
+            default: [
+                "javascript",
+                "python",
+                "java",
+                "cpp",
+                "c",
+                "csharp",
+                "php",
+                "ruby",
+                "go",
+                "rust",
+                "swift",
+                "kotlin",
+                "typescript",
+                "html",
+                "css",
+                "sql",
+                "bash",
+                "shell",
+                "r",
+                "matlab",
+                "scala",
+                "perl",
+                "lua",
+                "haskell",
+                "xml",
+                "json",
+                "yaml",
+                "markdown"
+            ]
+        },
+        id_types: {
+            default: []
+        }
+    },
+    parseDOM: [
+        {
+            tag: "div.doc",
+            getAttrs(dom) {
+                return {
+                    papersize: dom.dataset.papersize,
+                    citationstyle: dom.dataset.citationstyle,
+                    documentstyle: dom.dataset.documentstyle
+                }
+            }
+        }
+    ],
+    toDOM(node) {
+        return [
+            "div",
+            {
+                class: "doc",
+                "data-papersize": node.attrs.papersize,
+                "data-citationstyle": node.attrs.citationstyle,
+                "data-documentstyle": node.attrs.documentstyle
+            },
+            0
+        ]
+    }
+}
+
+const partSpec = (type, content, attrs = {}) => ({
+    content,
+    group: "part",
+    marks: "annotation track",
+    isolating: true,
+    attrs: Object.assign(
+        {
+            title: {
+                default: ""
+            },
+            id: {
+                default: ""
+            },
+            locking: {
+                default: false
+            },
+            language: {
+                default: false
+            },
+            optional: {
+                default: false
+            },
+            hidden: {
+                default: false
+            },
+            help: {
+                default: false
+            },
+            initial: {
+                default: false
+            },
+            deleted: {
+                // used when a part is present in a document but not part of the document template due to template changes
+                default: false
+            }
+        },
+        attrs
+    ),
+    parseDOM: [
+        {
+            tag: `div.doc-${type}`,
+            getAttrs(dom) {
+                return {
+                    hidden: dom.dataset.hidden === "true" ? true : false
+                }
+            }
+        }
+    ],
+    toDOM(node) {
+        const attrs = {
+            class: `doc-part doc-${type} ${node.attrs.id ? `doc-${node.attrs.id}` : "doc-no-id"}`
+        }
+        if (node.attrs.hidden) {
+            attrs["data-hidden"] = "true"
+        }
+        if (node.attrs.deleted) {
+            attrs.class += " doc-deleted"
+        }
+        return ["div", attrs, 0]
+    }
+})
+
+export const richtext_part = partSpec("richtext", "block+", {
+    elements: {
+        default: [
+            "paragraph",
+            "heading1",
+            "heading2",
+            "heading3",
+            "heading4",
+            "heading5",
+            "heading6",
+            "code_block",
+            "figure",
+            "ordered_list",
+            "bullet_list",
+            "horizontal_rule",
+            "equation",
+            "citation",
+            "cross_reference",
+            "blockquote",
+            "footnote",
+            "table"
+        ]
+    },
+    marks: {
+        default: ["strong", "em", "link", "anchor", "sup", "sub", "code"]
+    },
+    metadata: {
+        default: false
+    }
+})
+export const heading_part = partSpec("heading", "heading", {
+    elements: {
+        default: ["heading1"]
+    },
+    marks: {
+        default: ["strong", "em", "link", "anchor", "sup", "sub", "code"]
+    },
+    metadata: {
+        default: false
+    }
+})
+export const contributors_part = partSpec("contributors", "contributor*", {
+    item_title: {
+        default: "Contributor"
+    },
+    metadata: {
+        default: false
+    }
+})
+export const tags_part = partSpec("tags", "tag*", {
+    item_title: {
+        default: "Tag"
+    },
+    metadata: {
+        default: false
+    }
+})
+export const table_part = partSpec("table", "table", {
+    elements: {
+        default: [
+            "paragraph",
+            "heading1",
+            "heading2",
+            "heading3",
+            "heading4",
+            "heading5",
+            "heading6",
+            "code_block",
+            "figure",
+            "ordered_list",
+            "bullet_list",
+            "horizontal_rule",
+            "equation",
+            "citation",
+            "blockquote",
+            "footnote"
+        ]
+    },
+    marks: {
+        default: ["strong", "em", "link", "anchor", "sup", "sub", "code"]
+    }
+})
+
+export const table_of_contents = {
+    group: "part",
+    marks: "annotation track",
+    defining: true,
+    parseDOM: [
+        {
+            tag: "div.table-of-contents"
+        }
+    ],
+    attrs: {
+        title: {
+            default: "Table of Contents"
+        },
+        id: {
+            default: "toc"
+        },
+        optional: {
+            default: false
+        },
+        hidden: {
+            default: false
+        }
+    },
+    toDOM(node) {
+        const dom = document.createElement("div")
+        dom.classList.add("doc-part", "table-of-contents")
+        if (node.attrs.hidden) {
+            dom.dataset.hidden = "true"
+        }
+        dom.innerHTML = `<h1 class="toc">${node.attrs.title}</h1>`
+        return dom
+    }
+}
+
+export const separator_part = {
+    marks: "annotation track",
+    group: "part",
+    defining: true,
+    attrs: {
+        id: {
+            default: "separator"
+        }
+    },
+    parseDOM: [
+        {
+            tag: "hr.doc-separator_part"
+        }
+    ],
+    toDOM(node) {
+        const dom = document.createElement("hr")
+        dom.classList.add("doc-separator_part")
+        dom.classList.add(`doc-${node.attrs.id}`)
+        return dom
+    }
+}
+
+export const title = {
+    content: "text*",
+    marks: "annotation track",
+    group: "fixedpart",
+    defining: true,
+    isolating: true,
+    attrs: {
+        id: {
+            default: "title"
+        }
+    },
+    parseDOM: [
+        {
+            tag: "div.doc-title"
+        }
+    ],
+    toDOM(_node) {
+        return [
+            "div",
+            {
+                class: "doc-part doc-title"
+            },
+            0
+        ]
+    }
+}

package/src/schema/export.js

@@ -0,0 +1,21 @@
+import {docSchema} from "./document/index.js"
+
+export class SchemaExport {
+    constructor() {
+        this.schema = docSchema
+    }
+
+    init() {
+        const spec = {
+            nodes: {},
+            marks: {}
+        }
+        this.schema.spec.nodes.forEach(
+            (key, value) => (spec.nodes[key] = value)
+        )
+        this.schema.spec.marks.forEach(
+            (key, value) => (spec.marks[key] = value)
+        )
+        return JSON.stringify(spec)
+    }
+}

package/src/schema/footnotes.js

@@ -0,0 +1,126 @@
+import OrderedMap from "orderedmap"
+import {Schema} from "prosemirror-model"
+import {marks, nodes} from "prosemirror-schema-basic"
+import {tableNodes} from "prosemirror-tables"
+import {
+    anchor,
+    annotation_tag,
+    blockquote,
+    bullet_list,
+    citation,
+    comment,
+    cross_reference,
+    deletion,
+    equation,
+    figure,
+    figure_caption,
+    figure_equation,
+    format_change,
+    heading1,
+    heading2,
+    heading3,
+    heading4,
+    heading5,
+    heading6,
+    horizontal_rule,
+    image,
+    insertion,
+    link,
+    list_item,
+    ordered_list,
+    paragraph,
+    underline
+} from "./common/index.js"
+
+const footnotecontainer = {
+    group: "part",
+    selectable: false,
+    content: "(block|table_block)+",
+    marks: "annotation",
+    parseDOM: [{tag: "div.footnote-container"}],
+    toDOM(_node) {
+        return ["div", {class: "footnote-container"}, 0]
+    }
+}
+
+const doc = {
+    content: "part*",
+    selectable: false
+}
+
+const spec = {
+    nodes: OrderedMap.from({
+        doc,
+        footnotecontainer,
+        paragraph,
+        heading1,
+        heading2,
+        heading3,
+        heading4,
+        heading5,
+        heading6,
+        blockquote,
+        horizontal_rule,
+        figure,
+        image,
+        figure_equation,
+        figure_caption,
+        text: nodes.text,
+        hard_break: nodes.hard_break,
+        citation,
+        equation,
+        cross_reference,
+        ordered_list,
+        bullet_list,
+        list_item
+    }),
+    marks: OrderedMap.from({
+        em: marks.em,
+        strong: marks.strong,
+        link,
+        underline,
+        anchor,
+        comment,
+        annotation_tag,
+        deletion,
+        insertion,
+        format_change
+    })
+}
+
+spec.nodes = spec.nodes.append(
+    tableNodes({
+        tableGroup: "table_block",
+        cellContent: "block+"
+    })
+)
+
+spec.nodes = spec.nodes.update(
+    "table",
+    Object.assign({}, spec.nodes.get("table"), {
+        attrs: {
+            track: {default: []}
+        },
+        parseDOM: [
+            {
+                tag: "table",
+                getAttrs(dom) {
+                    return {
+                        track: dom.dataset.track
+                            ? JSON.parse(dom.dataset.track)
+                            : []
+                    }
+                }
+            }
+        ],
+        toDOM(node) {
+            const attrs = {}
+            if (node.attrs.track.length) {
+                attrs["data-track"] = JSON.stringify(node.attrs.track)
+            }
+            return ["table", attrs, ["tbody", 0]]
+        }
+    })
+)
+
+export const fnSchema = new Schema(spec)

package/src/schema/footnotes_convert.js

@@ -0,0 +1,31 @@
+import {DOMParser, DOMSerializer, Node} from "prosemirror-model"
+
+import {fnSchema} from "./footnotes.js"
+
+// Convert the footnote HTML stored with the marker to a PM node representation of the footnote.
+export const htmlToFnNode = content => {
+    const footnoteDOM = document.createElement("div")
+    footnoteDOM.classList.add("footnote-container")
+    footnoteDOM.innerHTML = content
+    const node = DOMParser.fromSchema(fnSchema).parse(footnoteDOM, {
+        preserveWhitespace: true,
+        topNode: false
+    })
+    const json = node.firstChild.toJSON().content
+
+    return json
+}
+
+export const fnNodeToPmNode = fnContents => {
+    const footnote = {
+        type: "footnotecontainer",
+        content: fnContents
+    }
+    return Node.fromJSON(fnSchema, footnote)
+}
+
+export const fnNodeToHtml = jsonString => {
+    const pmNode = fnNodeToPmNode(jsonString),
+        serializer = DOMSerializer.fromSchema(fnSchema)
+    return serializer.serializeNode(pmNode).innerHTML
+}