Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Ability to Synchronize Text Blocks Between Documents #5421

Open
1 task done
AGARES2101 opened this issue Jan 17, 2025 · 1 comment
Open
1 task done

Ability to Synchronize Text Blocks Between Documents #5421

AGARES2101 opened this issue Jan 17, 2025 · 1 comment

Comments

@AGARES2101
Copy link

Describe the feature you'd like

Implement the functionality of synchronizing text blocks between documents in BookStack.
This will allow such text blocks to be edited simultaneously on multiple pages, improving usability and reducing the likelihood of duplication or inconsistency of data.

Feature Description:

Selecting a Synchronizable Text Block:

The user can select any text block on a page and designate it to be synchronized with other pages.
Creating a Synchronizable Block:

When text is selected, the user can create a "linked area."
This area is assigned a unique identifier that can be used on other pages.
Inserting a Synchronizable Block on Other Pages:

The user can insert a previously created synchronizable block on any other page.
Insertion is performed via an interface that allows selecting an existing block by its name or identifier.
Editing a Synchronizable Block:

Changes made to a synchronizable block on one page are automatically updated on all other pages where the block is used.
Synchronization Management Interface:

A management panel for linked blocks that allows:
Viewing a list of all linked blocks available in the system.
Managing links, deleting blocks, or updating their content.
Change History:

All changes to a synchronizable block are saved in the page's change history.
Example Use Case:

The administrator creates a page with a text about the company's security policy.
Some sections of this text need to be used in other documents.
By selecting the text, the administrator creates a synchronizable block called "Security Policy."
This block is inserted into pages for other departments (e.g., IT, HR).
If the administrator edits the block on one of the pages, the changes are automatically reflected on all linked pages.
Expected Outcome:
The functionality of synchronizable text blocks will improve the ease of working with documents in BookStack, simplify the updating of information, and reduce data duplication.

Example of this functionality in Notion:
https://www.youtube.com/watch?v=AUyQ19Kk4kU

Describe the benefits this would bring to existing BookStack users

Benefits for Existing BookStack Users:

Reduction in Time Spent Updating Information:

Users will be able to update text blocks simultaneously across multiple pages, eliminating the need to manually make changes to each document. This is especially useful for shared content like policies, instructions, or general information.
Elimination of Duplication and Inconsistencies:

By synchronizing text blocks, users can avoid errors caused by outdated or conflicting information across different pages.
Simplified Collaboration:

Linked text blocks make it easier for teams or departments to collaborate, ensuring everyone has access to up-to-date information without the need for manual updates.
Enhanced Content Management Convenience:

A management panel for synchronized blocks will allow users to easily track and manage all linked blocks, providing full control over content.
Change History for Transparency:

Storing all changes in a history log enables users to track who made changes and when, which is valuable for quality control and auditing.
Flexibility in Content Reuse:

Users can easily reuse existing text blocks in new documents, speeding up page creation and reducing the likelihood of errors.
Measurable Benefits:

Reduction in time spent updating data by 50-70% through automatic synchronized editing.
Elimination of content inconsistencies, ensuring 100% centralized accuracy.
Increase in user productivity when creating and managing documents by 30-50%.
This feature addresses key user needs by improving accuracy, speed, and efficiency in document management workflows.

Can the goal of this request already be achieved via other means?

No.

Currently, BookStack does not have a built-in feature for synchronizing text blocks between pages. To achieve this goal, users must manually copy and paste text into multiple documents, which:

Increases the likelihood of errors and duplication.
Requires additional effort to update information when it changes.
Creates a risk of inconsistent information across different parts of the documentation.
While external tools (e.g., the BookStack API) can be used to automate updates, this requires significant technical expertise and is not a convenient solution for most users. Integrating the synchronized text block functionality into the BookStack interface would eliminate these limitations and provide a simpler, more efficient way to manage recurring information.

Have you searched for an existing open/closed issue?

  • I have searched for existing issues and none cover my fundamental request

How long have you been using BookStack?

3 months to 1 year

Additional context

Additional Context:

To better understand the proposed feature, consider how similar functionality is implemented in other tools. For example, the ability to synchronize text blocks in Notion allows users to create "Synced Blocks" that can be edited simultaneously across all pages where they are used. Video demonstration of this functionality in Notion:
https://www.youtube.com/watch?v=AUyQ19Kk4kU.

Use Case Example:

Scenario: A documentation administrator creates a text block with the company’s corporate policy, which is used in guidelines for several departments.
Current Problems:
Without synchronization, the administrator has to manually update the information on every page when changes are made.
This makes information management challenging and increases the likelihood of errors.
Synchronized Blocks as a Solution:
The administrator creates a synchronized block, inserts it into the necessary pages, and changes made in one location are automatically reflected in others.
Potential Use Cases:

Company policies.
Shared contact information.
Frequently used instructions or examples.
User Benefits:

Improved efficiency.
Elimination of duplicate information.
Better data management and consistency.

@ssddanbrown
Copy link
Member

Thanks for the request @AGARES2101, but we already have include tags: https://www.bookstackapp.com/docs/user/reusing-page-content/

The functionality of which overlaps quite a bit with this request, so it's unlikely I'd look maintain another more complex similar mechanism alongside that.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Development

No branches or pull requests

2 participants