mirror of
https://github.com/BookStackApp/BookStack.git
synced 2026-02-05 00:29:48 +03:00
Request - Global variables that load in-line with documentation text #659
Reference in New Issue
Block a user
Delete Branch "%!s()"
Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?
Originally created by @ghost on GitHub (May 2, 2018).
For Feature Requests
Desired Feature:
Example:
Page Content when editing:
"Be sure to verify that the current version of Software X is @software_x_current_version@ before adding the server to production."
Database Content:
id | name | value
1 | software_x_current_version | 11.0.8
Displayed content:
"Be sure to verify that the current version of Software X is 11.0.8 before adding the server to production."
This would work inline with text rather than having to reference an entire bookmarked section. This would also be great because teams can automate updates to specified tables to have current documentation of items without having to manually update pieces.
@mendiromania commented on GitHub (May 2, 2018):
👍
@SonGokussj4 commented on GitHub (Sep 8, 2022):
This would be so cool...
Right now I'm creating new documentation about the path where we have our scripts saved.
So now it's
/mnt/current/path/scriptsbut in the future it can be/server2/final/scriptsso I would need to re-edit all pages/chapters where I use this variable.Something like
@SCRIPTPATH@/scriptswould be awesome.@homer2320776 commented on GitHub (Sep 16, 2022):
+1 for this
@Obinoben commented on GitHub (Sep 16, 2022):
+1
It would be nice to include default variable placeholders like the revision number of the page because we need to display it on our procedures. Some like @current_page_revision@ ;)
@ssddanbrown commented on GitHub (Sep 17, 2022):
Just to confirm, if not aware, there is a page include system which often be used for these scenarios:
https://www.bookstackapp.com/docs/user/reusing-page-content/
@SonGokussj4 commented on GitHub (Sep 20, 2022):
Yes, I know about that and tried to use that. It could help by creating some "variables" page within "global" book or something like that and then on each line specify "variable", which would be then linked in different pages.
But as I tried things some weeks ago, I believe there was a problem with that - it inserts the block into a new book. Not in the middle of text for example.
So the foundations are there. But some specific tab in settings, where you specify book-wise or site-wise variables that can be inserted anywhere (and they would be respecting formatting), would be great :-)
@bhsmither commented on GitHub (Sep 20, 2022):
My experiments (that had a different problem) showed that
<p id="bkmrk-this-year">2022</p>which allowed for inline placement
Copyright {{@99#bkmrk-this-year}}, Foo Corp.<br>All rights reserved.resulting in
It was a single experiment. I first tried
<span>tags, expecting the result should be inline because a<p>tag is a block-level element. My conclusion is that it doesn't matter (from one experiment) what tag is used.@ssddanbrown commented on GitHub (Sep 21, 2022):
Yeah, I built the include system with in-line content in mind.
In most cases BookStack will use the child content of the referenced tag (Inner HTML) unless the tag is one of a few (Tables, Lists, maybe others) where that would cause issues, in which case the entire tag content (Outer HTML) will be used.
@terion-name commented on GitHub (Nov 1, 2022):
upping this. very useful feature
@ShowMeIT commented on GitHub (Mar 9, 2023):
+1 would be a useful feature.
@leichti commented on GitHub (Jul 4, 2024):
+1 from my side. Would be extremely nice for my use case as well.