typograph-editor-documentation
    Preparing search index...

    Interface collaboration_editing

    Who may edit right now. Without edit_together (TYP-918) one window holds the pen and the others comment or look until it is put down; with edit_together (TYP-919) every window that may edit edits, and writer says which one saves for everyone. A window on the pen in the same room (an embed without edit_together) still holds the others: by names it, and they wait until it is put down.

    you — this window holds it. by — the window that does, when it is not this one; same_person when that is the user's own other window. taken_over — this window was editing and lost the pen to one that started earlier, which happens only when two windows started at the same moment or met after a lost connection: changes made here since may be overwritten. catching_up — this window has the pen and is loading the latest saved version first (collaboration_options.catch_up); editing follows when that is done. catch_up_failed — that load failed: the window keeps the pen but stays withheld, because editing the version on screen would overwrite the saved one, until the host calls retry_catch_up() or the window is closed.

    interface collaboration_editing {
        by: {
            avatar_url: string;
            color: string;
            name: string;
            same_person: boolean;
            user_id: string;
        };
        catch_up_failed: boolean;
        catching_up: boolean;
        taken_over: boolean;
        writer: boolean;
        you: boolean;
    }
    Index
    by: {
        avatar_url: string;
        color: string;
        name: string;
        same_person: boolean;
        user_id: string;
    }
    catch_up_failed: boolean
    catching_up: boolean
    taken_over: boolean
    writer: boolean

    This window saves for everyone. With edit_together that is one of the windows that may edit, the same one in every window; without it, the window that holds the pen.

    you: boolean