Skip to content

Make page variables no longer cascade into inner files#693

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.

Sign up for GitHub

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

Merged
yamgent merged 3 commits into from
Feb 18, 2019
Merged

Make page variables no longer cascade into inner files #693

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
8112377
Fix page variable cascading
jamos-tay Feb 14, 2019
766ee05
Update documentation
jamos-tay Feb 14, 2019
d078526
Explicit include page variable test
jamos-tay Feb 14, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/userGuide/syntax/variables.mbdf
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -99,7 +99,7 @@ You can specify a default value for a variable, which is displayed when the vari
<code>My name is {<span></span>{ full_name }}. This is {<span></span>{ full_name }}'s site.</code>
</div>

Note: These variables will also be applied to [`<include>` files]({{ baseUrl }}/userGuide/reusingContents.html#the-include-tag). If the same variable is defined in a chain of pages (e.g. `a.md` includes `b.md` includes `c.md`...), variables defined in the top-most page will take precedence. Global variables (`_markbind/variables.md`) will take precedence over any page variables.
Note: These variables will not be applied to [`<include>` files]({{ baseUrl }}/userGuide/reusingContents.html#the-include-tag). Additionally, global variables (`_markbind/variables.md`) will take precedence over any page variables. *See also: [Specifying Variables in an `<include>`]({{ baseUrl }}/userGuide/reusingContents.html#specifying-variables-in-an-include)*.


### Variables: Tips and Tricks
Expand Down
19 changes: 10 additions & 9 deletions src/lib/markbind/src/parser.js
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -127,11 +127,11 @@ function extractIncludeVariables(includeElement, contextVariables) {
* @param filename for error printing
* @param data to extract variables from
* @param userDefinedVariables global variables
* @param contextVariables variables defined by parent pages
* @param includedVariables variables from parent include
*/
function extractPageVariables(fileName, data, userDefinedVariables, contextVariables) {
function extractPageVariables(fileName, data, userDefinedVariables, includedVariables) {
const $ = cheerio.load(data);
const pageVariables = { ...contextVariables };
const pageVariables = { };
$('variable').each(function () {
const variableElement = $(this);
const variableName = variableElement.attr('name');
Expand All@@ -143,7 +143,7 @@ function extractPageVariables(fileName, data, userDefinedVariables, contextVaria
if (!pageVariables[variableName]) {
pageVariables[variableName]
= nunjucks.renderString(md.renderInline(variableElement.html()),
{ ...pageVariables, ...userDefinedVariables });
{ ...pageVariables, ...userDefinedVariables, ...includedVariables });
}
});
return pageVariables;
Expand DownExpand Up@@ -268,13 +268,15 @@ Parser.prototype._preprocess = function (node, context, config) {
const userDefinedVariables = config.userDefinedVariablesMap[path.resolve(parent, relative)];

// Extract included variables from the PARENT file
let allVariables = extractIncludeVariables(element, context.variables);
const includeVariables = extractIncludeVariables(element, context.variables);

// Extract page variables from the CHILD file
allVariables = extractPageVariables(element.attribs.src, fileContent, userDefinedVariables, allVariables);
const pageVariables = extractPageVariables(element.attribs.src, fileContent,
userDefinedVariables, includeVariables);

// Render inner file content
fileContent = nunjucks.renderString(fileContent, { ...allVariables, ...userDefinedVariables });
fileContent = nunjucks.renderString(fileContent,
{ ...pageVariables, ...includeVariables, ...userDefinedVariables });

// Delete variable attributes in include
Object.keys(element.attribs).forEach((attribute) => {
Expand DownExpand Up@@ -343,7 +345,7 @@ Parser.prototype._preprocess = function (node, context, config) {
childContext.cwf = filePath;
childContext.source = isIncludeSrcMd ? 'md' : 'html';
childContext.callStack.push(context.cwf);
childContext.variables = allVariables;
childContext.variables = includeVariables;

if (element.children && element.children.length > 0) {
if (childContext.callStack.length > CyclicReferenceError.MAX_RECURSIVE_DEPTH) {
Expand DownExpand Up@@ -503,7 +505,6 @@ Parser.prototype.includeFile = function (file, config) {
const userDefinedVariables = config.userDefinedVariablesMap[path.resolve(parent, relative)];
const pageVariables = extractPageVariables(path.basename(file), data, userDefinedVariables, {});
const fileContent = nunjucks.renderString(data, { ...pageVariables, ...userDefinedVariables });
context.variables = pageVariables;
const fileExt = utils.getExt(file);
if (utils.isMarkdownFileExt(fileExt)) {
context.source = 'md';
Expand Down
17 changes: 10 additions & 7 deletions test/functional/test_site/expected/index.html
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -41,10 +41,11 @@
<a class="nav-link py-1" href="#page-variable-referencing-page-variable">Page Variable referencing Page Variable&#x200E;</a>
<a class="nav-link py-1" href="#global-variable-overriding-page-variable">Global Variable overriding Page Variable&#x200E;</a>
<a class="nav-link py-1" href="#test-page-variable-and-included-variable-integrations">Test Page Variable and Included Variable Integrations&#x200E;</a>
<a class="nav-link py-1" href="#outer-page-variable-overriding-inner-page-variable">Outer Page Variable Overriding Inner Page Variable&#x200E;</a>
<a class="nav-link py-1" href="#explicitly-included-page-variable">Explicitly Included Page Variable&#x200E;</a>
<a class="nav-link py-1" href="#inner-page-variable-should-not-be-overridden-by-outer-page-variable">Inner Page Variable Should Not Be Overridden by Outer Page Variable&#x200E;</a>
<a class="nav-link py-1" href="#outer-page-variable-should-not-leak-into-inner-pages">Outer Page Variable Should Not Leak Into Inner Pages&#x200E;</a>
<a class="nav-link py-1" href="#included-variable-overriding-page-variable">Included Variable Overriding Page Variable&#x200E;</a>
<a class="nav-link py-1" href="#page-variable-referencing-included-variable">Page Variable Referencing Included Variable&#x200E;</a>
<a class="nav-link py-1" href="#page-variable-referencing-outer-page-variable">Page Variable Referencing Outer Page Variable&#x200E;</a>
<a class="nav-link py-1" href="#heading-with-multiple-keywords">Heading with multiple keywords&#x200E;</a>
<a class="nav-link py-1" href="#heading-with-keyword-in-panel">Heading with keyword in panel&#x200E;</a>
<a class="nav-link py-1" href="#panel-with-heading-with-keyword">Panel with heading with keyword&#x200E;</a>
Expand DownExpand Up@@ -282,19 +283,21 @@ <h1 id="global-variable-overriding-page-variable">Global Variable overriding Pag
<div></div>
Global Variable Overriding Page Variable
<h1 id="test-page-variable-and-included-variable-integrations">Test Page Variable and Included Variable Integrations<a class="fa fa-anchor" href="#test-page-variable-and-included-variable-integrations"></a></h1>
<div></div>
<div>
<h1 id="outer-page-variable-overriding-inner-page-variable">Outer Page Variable Overriding Inner Page Variable<a class="fa fa-anchor" href="#outer-page-variable-overriding-inner-page-variable"></a></h1>
<h1 id="explicitly-included-page-variable">Explicitly Included Page Variable<a class="fa fa-anchor" href="#explicitly-included-page-variable"></a></h1>
<p>Explicitly Included Page Variable</p>
<h1 id="inner-page-variable-should-not-be-overridden-by-outer-page-variable">Inner Page Variable Should Not Be Overridden by Outer Page Variable<a class="fa fa-anchor" href="#inner-page-variable-should-not-be-overridden-by-outer-page-variable"></a></h1>
<div></div>
Page Variable
Inner Page Variable Should Not Be Overridden by Outer Page Variable
<h1 id="outer-page-variable-should-not-leak-into-inner-pages">Outer Page Variable Should Not Leak Into Inner Pages<a class="fa fa-anchor" href="#outer-page-variable-should-not-leak-into-inner-pages"></a></h1>
<p>Outer Page Variable Should Not Leak Into Inner Pages</p>
<h1 id="included-variable-overriding-page-variable">Included Variable Overriding Page Variable<a class="fa fa-anchor" href="#included-variable-overriding-page-variable"></a></h1>
<div></div>
Included Variable Overriding Page Variable
<h1 id="page-variable-referencing-included-variable">Page Variable Referencing Included Variable<a class="fa fa-anchor" href="#page-variable-referencing-included-variable"></a></h1>
<div></div>
Page Variable Referencing Included Variable
<h1 id="page-variable-referencing-outer-page-variable">Page Variable Referencing Outer Page Variable<a class="fa fa-anchor" href="#page-variable-referencing-outer-page-variable"></a></h1>
<div></div>
Page Variable Referencing Outer Page Variable
</div>
<h1 id="heading-with-multiple-keywords">Heading with multiple keywords<a class="fa fa-anchor" href="#heading-with-multiple-keywords"></a></h1>
<p><span class="keyword">keyword 1</span>
Expand Down
5 changes: 3 additions & 2 deletions test/functional/test_site/expected/siteData.json
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -45,10 +45,11 @@
"page-variable-referencing-page-variable": "Page Variable referencing Page Variable",
"global-variable-overriding-page-variable": "Global Variable overriding Page Variable",
"test-page-variable-and-included-variable-integrations": "Test Page Variable and Included Variable Integrations",
"outer-page-variable-overriding-inner-page-variable": "Outer Page Variable Overriding Inner Page Variable",
"explicitly-included-page-variable": "Explicitly Included Page Variable",
"inner-page-variable-should-not-be-overridden-by-outer-page-variable": "Inner Page Variable Should Not Be Overridden by Outer Page Variable",
"outer-page-variable-should-not-leak-into-inner-pages": "Outer Page Variable Should Not Leak Into Inner Pages",
"included-variable-overriding-page-variable": "Included Variable Overriding Page Variable",
"page-variable-referencing-included-variable": "Page Variable Referencing Included Variable",
"page-variable-referencing-outer-page-variable": "Page Variable Referencing Outer Page Variable",
"heading-with-multiple-keywords": "Heading with multiple keywords | keyword 1, keyword 2",
"heading-with-keyword-in-panel": "Heading with keyword in panel | panel keyword",
"expanded-panel-without-heading-with-keyword": "Expanded panel without heading with keyword",
Expand Down
2 changes: 2 additions & 0 deletions test/functional/test_site/index.md
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -47,7 +47,9 @@ head: myCustomHead.md, myCustomHead2.md
{{ page_global_variable_overriding_page_variable }}

# Test Page Variable and Included Variable Integrations
<variable name="explicitly_included_page_variable">Explicitly Included Page Variable</variable>
<include src="testPageVariablesInInclude.md">
<span id="explicitly_included_page_variable">{{ explicitly_included_page_variable }}</span>
<span id="included_variable">Included Variable</span>
<span id="included_variable_overriding_page_variable">Included Variable Overriding Page Variable</span>
</include>
Expand Down
14 changes: 8 additions & 6 deletions test/functional/test_site/testPageVariablesInInclude.md
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,17 @@
# Outer Page Variable Overriding Inner Page Variable
<variable name="page_variable">Inner Page Variable Overridden by Outer Page Variable</variable>
# Explicitly Included Page Variable
{{ explicitly_included_page_variable }}

# Inner Page Variable Should Not Be Overridden by Outer Page Variable
<variable name="page_variable">Inner Page Variable Should Not Be Overridden by Outer Page Variable</variable>
{{ page_variable }}

# Outer Page Variable Should Not Leak Into Inner Pages
{{ nested_page_variable or "Outer Page Variable Should Not Leak Into Inner Pages" }}

# Included Variable Overriding Page Variable
<variable name="included_variable_overriding_page_variable">Page Variable Overridden by Included Variable</variable>
{{ included_variable_overriding_page_variable }}

# Page Variable Referencing Included Variable
<variable name="page_variable_referencing_included_variable">Page Variable Referencing {{ included_variable }}</variable>
{{ page_variable_referencing_included_variable }}

# Page Variable Referencing Outer Page Variable
<variable name="page_variable_referencing_outer_page_variable">Page Variable Referencing Outer {{ page_variable }}</variable>
{{ page_variable_referencing_outer_page_variable }}
, 'i'); if (__m === '*' || __re.test(location.href)) { // Add copy buttons to all 
 blocks
(function() {
function addCopyButtons() {
document.querySelectorAll('pre code').forEach(function(codeBlock) {
if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;
codeBlock.parentElement.setAttribute('data-copy-added', 'true');
var btn = document.createElement('button');
btn.textContent = 'Copy';
btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';
btn.onmouseover = function() { this.style.opacity = '1'; };
btn.onmouseout = function() { this.style.opacity = '0.7'; };
btn.onclick = function() {
navigator.clipboard.writeText(codeBlock.textContent).then(function() {
btn.textContent = 'Copied!';
setTimeout(function() { btn.textContent = 'Copy'; }, 1500);
});
};
codeBlock.parentElement.style.position = 'relative';
codeBlock.parentElement.appendChild(btn);
});
}
addCopyButtons();
// Re-run on dynamic content
var observer = new MutationObserver(addCopyButtons);
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '
Make page variables no longer cascade into inner files by jamos-tay · Pull Request #693 · MarkBind/markbind · GitHub
Skip to content
Make page variables no longer cascade into inner files#693

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.

 Sign up for GitHub

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

 Merged

yamgent
merged 3 commits into

from

Feb 18, 2019
 Merged


Make page variables no longer cascade into inner files
#693
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


3 commits


Select commit
Hold shift + click to select a range
8112377

Fix page variable cascading


jamos-tay Feb 14, 2019
766ee05

Update documentation


jamos-tay Feb 14, 2019
d078526

Explicit include page variable test


jamos-tay Feb 14, 2019

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


2 changes: 1 addition & 1 deletion
docs/userGuide/syntax/variables.mbdf

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -99,7 +99,7 @@ You can specify a default value for a variable, which is displayed when the vari
<code>My name is {<span></span>{ full_name }}. This is {<span></span>{ full_name }}'s site.</code>
</div>

Note: These variables will also be applied to [`<include>` files]({{ baseUrl }}/userGuide/reusingContents.html#the-include-tag). If the same variable is defined in a chain of pages (e.g. `a.md` includes `b.md` includes `c.md`...), variables defined in the top-most page will take precedence. Global variables (`_markbind/variables.md`) will take precedence over any page variables.
Note: These variables will not be applied to [`<include>` files]({{ baseUrl }}/userGuide/reusingContents.html#the-include-tag). Additionally, global variables (`_markbind/variables.md`) will take precedence over any page variables. *See also: [Specifying Variables in an `<include>`]({{ baseUrl }}/userGuide/reusingContents.html#specifying-variables-in-an-include)*.


### Variables: Tips and Tricks
Expand Down

19 changes: 10 additions & 9 deletions
src/lib/markbind/src/parser.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -127,11 +127,11 @@ function extractIncludeVariables(includeElement, contextVariables) {
 * @param filename for error printing
 * @param data to extract variables from
 * @param userDefinedVariables global variables
 * @param contextVariables variables defined by parent pages
 * @param includedVariables variables from parent include
 */
function extractPageVariables(fileName, data, userDefinedVariables, contextVariables) {
function extractPageVariables(fileName, data, userDefinedVariables, includedVariables) {
 const $ = cheerio.load(data);
 const pageVariables = { ...contextVariables };
 const pageVariables = { };
 $('variable').each(function () {
 const variableElement = $(this);
 const variableName = variableElement.attr('name');
Expand All@@ -143,7 +143,7 @@ function extractPageVariables(fileName, data, userDefinedVariables, contextVaria
 if (!pageVariables[variableName]) {
 pageVariables[variableName]
 = nunjucks.renderString(md.renderInline(variableElement.html()),
 { ...pageVariables, ...userDefinedVariables });
 { ...pageVariables, ...userDefinedVariables, ...includedVariables });
 }
 });
 return pageVariables;
Expand DownExpand Up@@ -268,13 +268,15 @@ Parser.prototype._preprocess = function (node, context, config) {
 const userDefinedVariables = config.userDefinedVariablesMap[path.resolve(parent, relative)];

 // Extract included variables from the PARENT file
let allVariables = extractIncludeVariables(element, context.variables);
const includeVariables = extractIncludeVariables(element, context.variables);

 // Extract page variables from the CHILD file
 allVariables = extractPageVariables(element.attribs.src, fileContent, userDefinedVariables, allVariables);
 const pageVariables = extractPageVariables(element.attribs.src, fileContent,
 userDefinedVariables, includeVariables);

 // Render inner file content
 fileContent = nunjucks.renderString(fileContent, { ...allVariables, ...userDefinedVariables });
 fileContent = nunjucks.renderString(fileContent,
 { ...pageVariables, ...includeVariables, ...userDefinedVariables });

 // Delete variable attributes in include
 Object.keys(element.attribs).forEach((attribute) => {
Expand DownExpand Up@@ -343,7 +345,7 @@ Parser.prototype._preprocess = function (node, context, config) {
 childContext.cwf = filePath;
 childContext.source = isIncludeSrcMd ? 'md' : 'html';
 childContext.callStack.push(context.cwf);
 childContext.variables = allVariables;
 childContext.variables = includeVariables;

 if (element.children && element.children.length > 0) {
 if (childContext.callStack.length > CyclicReferenceError.MAX_RECURSIVE_DEPTH) {
Expand DownExpand Up@@ -503,7 +505,6 @@ Parser.prototype.includeFile = function (file, config) {
 const userDefinedVariables = config.userDefinedVariablesMap[path.resolve(parent, relative)];
 const pageVariables = extractPageVariables(path.basename(file), data, userDefinedVariables, {});
 const fileContent = nunjucks.renderString(data, { ...pageVariables, ...userDefinedVariables });
 context.variables = pageVariables;
 const fileExt = utils.getExt(file);
 if (utils.isMarkdownFileExt(fileExt)) {
 context.source = 'md';
Expand Down

17 changes: 10 additions & 7 deletions
test/functional/test_site/expected/index.html

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -41,10 +41,11 @@
 <a class="nav-link py-1" href="#page-variable-referencing-page-variable">Page Variable referencing Page Variable&#x200E;</a>
 <a class="nav-link py-1" href="#global-variable-overriding-page-variable">Global Variable overriding Page Variable&#x200E;</a>
 <a class="nav-link py-1" href="#test-page-variable-and-included-variable-integrations">Test Page Variable and Included Variable Integrations&#x200E;</a>
 <a class="nav-link py-1" href="#outer-page-variable-overriding-inner-page-variable">Outer Page Variable Overriding Inner Page Variable&#x200E;</a>
 <a class="nav-link py-1" href="#explicitly-included-page-variable">Explicitly Included Page Variable&#x200E;</a>
 <a class="nav-link py-1" href="#inner-page-variable-should-not-be-overridden-by-outer-page-variable">Inner Page Variable Should Not Be Overridden by Outer Page Variable&#x200E;</a>
 <a class="nav-link py-1" href="#outer-page-variable-should-not-leak-into-inner-pages">Outer Page Variable Should Not Leak Into Inner Pages&#x200E;</a>
 <a class="nav-link py-1" href="#included-variable-overriding-page-variable">Included Variable Overriding Page Variable&#x200E;</a>
 <a class="nav-link py-1" href="#page-variable-referencing-included-variable">Page Variable Referencing Included Variable&#x200E;</a>
 <a class="nav-link py-1" href="#page-variable-referencing-outer-page-variable">Page Variable Referencing Outer Page Variable&#x200E;</a>
 <a class="nav-link py-1" href="#heading-with-multiple-keywords">Heading with multiple keywords&#x200E;</a>
 <a class="nav-link py-1" href="#heading-with-keyword-in-panel">Heading with keyword in panel&#x200E;</a>
 <a class="nav-link py-1" href="#panel-with-heading-with-keyword">Panel with heading with keyword&#x200E;</a>
Expand DownExpand Up@@ -282,19 +283,21 @@ <h1 id="global-variable-overriding-page-variable">Global Variable overriding Pag
 <div></div>
 Global Variable Overriding Page Variable
 <h1 id="test-page-variable-and-included-variable-integrations">Test Page Variable and Included Variable Integrations<a class="fa fa-anchor" href="#test-page-variable-and-included-variable-integrations"></a></h1>
 <div></div>
 <div>
 <h1 id="outer-page-variable-overriding-inner-page-variable">Outer Page Variable Overriding Inner Page Variable<a class="fa fa-anchor" href="#outer-page-variable-overriding-inner-page-variable"></a></h1>
 <h1 id="explicitly-included-page-variable">Explicitly Included Page Variable<a class="fa fa-anchor" href="#explicitly-included-page-variable"></a></h1>
 <p>Explicitly Included Page Variable</p>
 <h1 id="inner-page-variable-should-not-be-overridden-by-outer-page-variable">Inner Page Variable Should Not Be Overridden by Outer Page Variable<a class="fa fa-anchor" href="#inner-page-variable-should-not-be-overridden-by-outer-page-variable"></a></h1>
 <div></div>
 Page Variable
 Inner Page Variable Should Not Be Overridden by Outer Page Variable
 <h1 id="outer-page-variable-should-not-leak-into-inner-pages">Outer Page Variable Should Not Leak Into Inner Pages<a class="fa fa-anchor" href="#outer-page-variable-should-not-leak-into-inner-pages"></a></h1>
 <p>Outer Page Variable Should Not Leak Into Inner Pages</p>
 <h1 id="included-variable-overriding-page-variable">Included Variable Overriding Page Variable<a class="fa fa-anchor" href="#included-variable-overriding-page-variable"></a></h1>
 <div></div>
 Included Variable Overriding Page Variable
 <h1 id="page-variable-referencing-included-variable">Page Variable Referencing Included Variable<a class="fa fa-anchor" href="#page-variable-referencing-included-variable"></a></h1>
 <div></div>
 Page Variable Referencing Included Variable
 <h1 id="page-variable-referencing-outer-page-variable">Page Variable Referencing Outer Page Variable<a class="fa fa-anchor" href="#page-variable-referencing-outer-page-variable"></a></h1>
 <div></div>
 Page Variable Referencing Outer Page Variable
 </div>
 <h1 id="heading-with-multiple-keywords">Heading with multiple keywords<a class="fa fa-anchor" href="#heading-with-multiple-keywords"></a></h1>
 <p><span class="keyword">keyword 1</span>
Expand Down

5 changes: 3 additions & 2 deletions
test/functional/test_site/expected/siteData.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -45,10 +45,11 @@
 "page-variable-referencing-page-variable": "Page Variable referencing Page Variable",
 "global-variable-overriding-page-variable": "Global Variable overriding Page Variable",
 "test-page-variable-and-included-variable-integrations": "Test Page Variable and Included Variable Integrations",
 "outer-page-variable-overriding-inner-page-variable": "Outer Page Variable Overriding Inner Page Variable",
 "explicitly-included-page-variable": "Explicitly Included Page Variable",
 "inner-page-variable-should-not-be-overridden-by-outer-page-variable": "Inner Page Variable Should Not Be Overridden by Outer Page Variable",
 "outer-page-variable-should-not-leak-into-inner-pages": "Outer Page Variable Should Not Leak Into Inner Pages",
 "included-variable-overriding-page-variable": "Included Variable Overriding Page Variable",
 "page-variable-referencing-included-variable": "Page Variable Referencing Included Variable",
 "page-variable-referencing-outer-page-variable": "Page Variable Referencing Outer Page Variable",
 "heading-with-multiple-keywords": "Heading with multiple keywords | keyword 1, keyword 2",
 "heading-with-keyword-in-panel": "Heading with keyword in panel | panel keyword",
 "expanded-panel-without-heading-with-keyword": "Expanded panel without heading with keyword",
Expand Down

2 changes: 2 additions & 0 deletions
test/functional/test_site/index.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -47,7 +47,9 @@ head: myCustomHead.md, myCustomHead2.md
{{ page_global_variable_overriding_page_variable }}

# Test Page Variable and Included Variable Integrations
<variable name="explicitly_included_page_variable">Explicitly Included Page Variable</variable>
<include src="testPageVariablesInInclude.md">
 <span id="explicitly_included_page_variable">{{ explicitly_included_page_variable }}</span>
 <span id="included_variable">Included Variable</span>
 <span id="included_variable_overriding_page_variable">Included Variable Overriding Page Variable</span>
</include>
Expand Down

14 changes: 8 additions & 6 deletions
test/functional/test_site/testPageVariablesInInclude.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,15 +1,17 @@
# Outer Page Variable Overriding Inner Page Variable
<variable name="page_variable">Inner Page Variable Overridden by Outer Page Variable</variable>
# Explicitly Included Page Variable
{{ explicitly_included_page_variable }}

# Inner Page Variable Should Not Be Overridden by Outer Page Variable
<variable name="page_variable">Inner Page Variable Should Not Be Overridden by Outer Page Variable</variable>
{{ page_variable }}

# Outer Page Variable Should Not Leak Into Inner Pages
{{ nested_page_variable or "Outer Page Variable Should Not Leak Into Inner Pages" }}

# Included Variable Overriding Page Variable
<variable name="included_variable_overriding_page_variable">Page Variable Overridden by Included Variable</variable>
{{ included_variable_overriding_page_variable }}

# Page Variable Referencing Included Variable
<variable name="page_variable_referencing_included_variable">Page Variable Referencing {{ included_variable }}</variable>
{{ page_variable_referencing_included_variable }}

# Page Variable Referencing Outer Page Variable
<variable name="page_variable_referencing_outer_page_variable">Page Variable Referencing Outer {{ page_variable }}</variable>
{{ page_variable_referencing_outer_page_variable }}

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Force GitHub README to respect dark mode
(function() {
var style = document.createElement('style');
style.textContent = '
.markdown-body {
color-scheme: dark light;
}
.markdown-body pre { background: #161b22 !important; }
.markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }
.markdown-body table th, .markdown-body table td { border-color: #30363d !important; }
.markdown-body img { background: #0d1117; }
.markdown-body blockquote { border-left-color: #8b949e; }
.markdown-body hr { border-color: #30363d; }
';
document.head.appendChild(style);
})();
}
} catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
Make page variables no longer cascade into inner files by jamos-tay · Pull Request #693 · MarkBind/markbind · GitHub
Skip to content
Make page variables no longer cascade into inner files#693

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.

 Sign up for GitHub

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

 Merged

yamgent
merged 3 commits into

from

Feb 18, 2019
 Merged


Make page variables no longer cascade into inner files
#693
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


3 commits


Select commit
Hold shift + click to select a range
8112377

Fix page variable cascading


jamos-tay Feb 14, 2019
766ee05

Update documentation


jamos-tay Feb 14, 2019
d078526

Explicit include page variable test


jamos-tay Feb 14, 2019

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


2 changes: 1 addition & 1 deletion
docs/userGuide/syntax/variables.mbdf

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -99,7 +99,7 @@ You can specify a default value for a variable, which is displayed when the vari
<code>My name is {<span></span>{ full_name }}. This is {<span></span>{ full_name }}'s site.</code>
</div>

Note: These variables will also be applied to [`<include>` files]({{ baseUrl }}/userGuide/reusingContents.html#the-include-tag). If the same variable is defined in a chain of pages (e.g. `a.md` includes `b.md` includes `c.md`...), variables defined in the top-most page will take precedence. Global variables (`_markbind/variables.md`) will take precedence over any page variables.
Note: These variables will not be applied to [`<include>` files]({{ baseUrl }}/userGuide/reusingContents.html#the-include-tag). Additionally, global variables (`_markbind/variables.md`) will take precedence over any page variables. *See also: [Specifying Variables in an `<include>`]({{ baseUrl }}/userGuide/reusingContents.html#specifying-variables-in-an-include)*.


### Variables: Tips and Tricks
Expand Down

19 changes: 10 additions & 9 deletions
src/lib/markbind/src/parser.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -127,11 +127,11 @@ function extractIncludeVariables(includeElement, contextVariables) {
 * @param filename for error printing
 * @param data to extract variables from
 * @param userDefinedVariables global variables
 * @param contextVariables variables defined by parent pages
 * @param includedVariables variables from parent include
 */
function extractPageVariables(fileName, data, userDefinedVariables, contextVariables) {
function extractPageVariables(fileName, data, userDefinedVariables, includedVariables) {
 const $ = cheerio.load(data);
 const pageVariables = { ...contextVariables };
 const pageVariables = { };
 $('variable').each(function () {
 const variableElement = $(this);
 const variableName = variableElement.attr('name');
Expand All@@ -143,7 +143,7 @@ function extractPageVariables(fileName, data, userDefinedVariables, contextVaria
 if (!pageVariables[variableName]) {
 pageVariables[variableName]
 = nunjucks.renderString(md.renderInline(variableElement.html()),
 { ...pageVariables, ...userDefinedVariables });
 { ...pageVariables, ...userDefinedVariables, ...includedVariables });
 }
 });
 return pageVariables;
Expand DownExpand Up@@ -268,13 +268,15 @@ Parser.prototype._preprocess = function (node, context, config) {
 const userDefinedVariables = config.userDefinedVariablesMap[path.resolve(parent, relative)];

 // Extract included variables from the PARENT file
let allVariables = extractIncludeVariables(element, context.variables);
const includeVariables = extractIncludeVariables(element, context.variables);

 // Extract page variables from the CHILD file
 allVariables = extractPageVariables(element.attribs.src, fileContent, userDefinedVariables, allVariables);
 const pageVariables = extractPageVariables(element.attribs.src, fileContent,
 userDefinedVariables, includeVariables);

 // Render inner file content
 fileContent = nunjucks.renderString(fileContent, { ...allVariables, ...userDefinedVariables });
 fileContent = nunjucks.renderString(fileContent,
 { ...pageVariables, ...includeVariables, ...userDefinedVariables });

 // Delete variable attributes in include
 Object.keys(element.attribs).forEach((attribute) => {
Expand DownExpand Up@@ -343,7 +345,7 @@ Parser.prototype._preprocess = function (node, context, config) {
 childContext.cwf = filePath;
 childContext.source = isIncludeSrcMd ? 'md' : 'html';
 childContext.callStack.push(context.cwf);
 childContext.variables = allVariables;
 childContext.variables = includeVariables;

 if (element.children && element.children.length > 0) {
 if (childContext.callStack.length > CyclicReferenceError.MAX_RECURSIVE_DEPTH) {
Expand DownExpand Up@@ -503,7 +505,6 @@ Parser.prototype.includeFile = function (file, config) {
 const userDefinedVariables = config.userDefinedVariablesMap[path.resolve(parent, relative)];
 const pageVariables = extractPageVariables(path.basename(file), data, userDefinedVariables, {});
 const fileContent = nunjucks.renderString(data, { ...pageVariables, ...userDefinedVariables });
 context.variables = pageVariables;
 const fileExt = utils.getExt(file);
 if (utils.isMarkdownFileExt(fileExt)) {
 context.source = 'md';
Expand Down

17 changes: 10 additions & 7 deletions
test/functional/test_site/expected/index.html

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -41,10 +41,11 @@
 <a class="nav-link py-1" href="#page-variable-referencing-page-variable">Page Variable referencing Page Variable&#x200E;</a>
 <a class="nav-link py-1" href="#global-variable-overriding-page-variable">Global Variable overriding Page Variable&#x200E;</a>
 <a class="nav-link py-1" href="#test-page-variable-and-included-variable-integrations">Test Page Variable and Included Variable Integrations&#x200E;</a>
 <a class="nav-link py-1" href="#outer-page-variable-overriding-inner-page-variable">Outer Page Variable Overriding Inner Page Variable&#x200E;</a>
 <a class="nav-link py-1" href="#explicitly-included-page-variable">Explicitly Included Page Variable&#x200E;</a>
 <a class="nav-link py-1" href="#inner-page-variable-should-not-be-overridden-by-outer-page-variable">Inner Page Variable Should Not Be Overridden by Outer Page Variable&#x200E;</a>
 <a class="nav-link py-1" href="#outer-page-variable-should-not-leak-into-inner-pages">Outer Page Variable Should Not Leak Into Inner Pages&#x200E;</a>
 <a class="nav-link py-1" href="#included-variable-overriding-page-variable">Included Variable Overriding Page Variable&#x200E;</a>
 <a class="nav-link py-1" href="#page-variable-referencing-included-variable">Page Variable Referencing Included Variable&#x200E;</a>
 <a class="nav-link py-1" href="#page-variable-referencing-outer-page-variable">Page Variable Referencing Outer Page Variable&#x200E;</a>
 <a class="nav-link py-1" href="#heading-with-multiple-keywords">Heading with multiple keywords&#x200E;</a>
 <a class="nav-link py-1" href="#heading-with-keyword-in-panel">Heading with keyword in panel&#x200E;</a>
 <a class="nav-link py-1" href="#panel-with-heading-with-keyword">Panel with heading with keyword&#x200E;</a>
Expand DownExpand Up@@ -282,19 +283,21 @@ <h1 id="global-variable-overriding-page-variable">Global Variable overriding Pag
 <div></div>
 Global Variable Overriding Page Variable
 <h1 id="test-page-variable-and-included-variable-integrations">Test Page Variable and Included Variable Integrations<a class="fa fa-anchor" href="#test-page-variable-and-included-variable-integrations"></a></h1>
 <div></div>
 <div>
 <h1 id="outer-page-variable-overriding-inner-page-variable">Outer Page Variable Overriding Inner Page Variable<a class="fa fa-anchor" href="#outer-page-variable-overriding-inner-page-variable"></a></h1>
 <h1 id="explicitly-included-page-variable">Explicitly Included Page Variable<a class="fa fa-anchor" href="#explicitly-included-page-variable"></a></h1>
 <p>Explicitly Included Page Variable</p>
 <h1 id="inner-page-variable-should-not-be-overridden-by-outer-page-variable">Inner Page Variable Should Not Be Overridden by Outer Page Variable<a class="fa fa-anchor" href="#inner-page-variable-should-not-be-overridden-by-outer-page-variable"></a></h1>
 <div></div>
 Page Variable
 Inner Page Variable Should Not Be Overridden by Outer Page Variable
 <h1 id="outer-page-variable-should-not-leak-into-inner-pages">Outer Page Variable Should Not Leak Into Inner Pages<a class="fa fa-anchor" href="#outer-page-variable-should-not-leak-into-inner-pages"></a></h1>
 <p>Outer Page Variable Should Not Leak Into Inner Pages</p>
 <h1 id="included-variable-overriding-page-variable">Included Variable Overriding Page Variable<a class="fa fa-anchor" href="#included-variable-overriding-page-variable"></a></h1>
 <div></div>
 Included Variable Overriding Page Variable
 <h1 id="page-variable-referencing-included-variable">Page Variable Referencing Included Variable<a class="fa fa-anchor" href="#page-variable-referencing-included-variable"></a></h1>
 <div></div>
 Page Variable Referencing Included Variable
 <h1 id="page-variable-referencing-outer-page-variable">Page Variable Referencing Outer Page Variable<a class="fa fa-anchor" href="#page-variable-referencing-outer-page-variable"></a></h1>
 <div></div>
 Page Variable Referencing Outer Page Variable
 </div>
 <h1 id="heading-with-multiple-keywords">Heading with multiple keywords<a class="fa fa-anchor" href="#heading-with-multiple-keywords"></a></h1>
 <p><span class="keyword">keyword 1</span>
Expand Down

5 changes: 3 additions & 2 deletions
test/functional/test_site/expected/siteData.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -45,10 +45,11 @@
 "page-variable-referencing-page-variable": "Page Variable referencing Page Variable",
 "global-variable-overriding-page-variable": "Global Variable overriding Page Variable",
 "test-page-variable-and-included-variable-integrations": "Test Page Variable and Included Variable Integrations",
 "outer-page-variable-overriding-inner-page-variable": "Outer Page Variable Overriding Inner Page Variable",
 "explicitly-included-page-variable": "Explicitly Included Page Variable",
 "inner-page-variable-should-not-be-overridden-by-outer-page-variable": "Inner Page Variable Should Not Be Overridden by Outer Page Variable",
 "outer-page-variable-should-not-leak-into-inner-pages": "Outer Page Variable Should Not Leak Into Inner Pages",
 "included-variable-overriding-page-variable": "Included Variable Overriding Page Variable",
 "page-variable-referencing-included-variable": "Page Variable Referencing Included Variable",
 "page-variable-referencing-outer-page-variable": "Page Variable Referencing Outer Page Variable",
 "heading-with-multiple-keywords": "Heading with multiple keywords | keyword 1, keyword 2",
 "heading-with-keyword-in-panel": "Heading with keyword in panel | panel keyword",
 "expanded-panel-without-heading-with-keyword": "Expanded panel without heading with keyword",
Expand Down

2 changes: 2 additions & 0 deletions
test/functional/test_site/index.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -47,7 +47,9 @@ head: myCustomHead.md, myCustomHead2.md
{{ page_global_variable_overriding_page_variable }}

# Test Page Variable and Included Variable Integrations
<variable name="explicitly_included_page_variable">Explicitly Included Page Variable</variable>
<include src="testPageVariablesInInclude.md">
 <span id="explicitly_included_page_variable">{{ explicitly_included_page_variable }}</span>
 <span id="included_variable">Included Variable</span>
 <span id="included_variable_overriding_page_variable">Included Variable Overriding Page Variable</span>
</include>
Expand Down

14 changes: 8 additions & 6 deletions
test/functional/test_site/testPageVariablesInInclude.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,15 +1,17 @@
# Outer Page Variable Overriding Inner Page Variable
<variable name="page_variable">Inner Page Variable Overridden by Outer Page Variable</variable>
# Explicitly Included Page Variable
{{ explicitly_included_page_variable }}

# Inner Page Variable Should Not Be Overridden by Outer Page Variable
<variable name="page_variable">Inner Page Variable Should Not Be Overridden by Outer Page Variable</variable>
{{ page_variable }}

# Outer Page Variable Should Not Leak Into Inner Pages
{{ nested_page_variable or "Outer Page Variable Should Not Leak Into Inner Pages" }}

# Included Variable Overriding Page Variable
<variable name="included_variable_overriding_page_variable">Page Variable Overridden by Included Variable</variable>
{{ included_variable_overriding_page_variable }}

# Page Variable Referencing Included Variable
<variable name="page_variable_referencing_included_variable">Page Variable Referencing {{ included_variable }}</variable>
{{ page_variable_referencing_included_variable }}

# Page Variable Referencing Outer Page Variable
<variable name="page_variable_referencing_outer_page_variable">Page Variable Referencing Outer {{ page_variable }}</variable>
{{ page_variable_referencing_outer_page_variable }}

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Highlight search terms from Google/DuckDuckGo/Bing referrer
(function() {
var ref = document.referrer;
var terms = [];
if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {
var url = new URL(ref);
var q = url.searchParams.get('q') || url.searchParams.get('p');
if (q) {
terms = q.split(/\s+/).filter(function(t) { return t.length > 2; });
}
}
if (terms.length === 0) return;
var style = document.createElement('style');
style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';
document.head.appendChild(style);
function highlight(node) {
if (node.nodeType === 3) { // text node
var text = node.textContent;
var found = false;
terms.forEach(function(term) {
var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\]\\]/g, '\\') + ')', 'gi');
if (regex.test(text)) {
found = true;
var frag = document.createDocumentFragment();
var parts = text.split(regex);
parts.forEach(function(part, i) {
if (i % 2 === 0) {
frag.appendChild(document.createTextNode(part));
} else {
var span = document.createElement('span');
span.className = 'userscript-highlight';
span.textContent = part;
frag.appendChild(span);
}
});
node.parentNode.replaceChild(frag, node);
}
});
} else if (node.nodeType === 1 && node.childNodes) { // element
var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];
if (!skipTags.includes(node.tagName)) {
Array.from(node.childNodes).forEach(highlight);
}
}
}
highlight(document.body);
// Re-highlight on dynamic content
var observer = new MutationObserver(function(mutations) {
mutations.forEach(function(m) {
m.addedNodes.forEach(function(node) {
if (node.nodeType === 1 || node.nodeType === 3) highlight(node);
});
});
});
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
Make page variables no longer cascade into inner files by jamos-tay · Pull Request #693 · MarkBind/markbind · GitHub
Skip to content
Make page variables no longer cascade into inner files#693

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.

 Sign up for GitHub

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

 Merged

yamgent
merged 3 commits into

from

Feb 18, 2019
 Merged


Make page variables no longer cascade into inner files
#693
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


3 commits


Select commit
Hold shift + click to select a range
8112377

Fix page variable cascading


jamos-tay Feb 14, 2019
766ee05

Update documentation


jamos-tay Feb 14, 2019
d078526

Explicit include page variable test


jamos-tay Feb 14, 2019

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


2 changes: 1 addition & 1 deletion
docs/userGuide/syntax/variables.mbdf

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -99,7 +99,7 @@ You can specify a default value for a variable, which is displayed when the vari
<code>My name is {<span></span>{ full_name }}. This is {<span></span>{ full_name }}'s site.</code>
</div>

Note: These variables will also be applied to [`<include>` files]({{ baseUrl }}/userGuide/reusingContents.html#the-include-tag). If the same variable is defined in a chain of pages (e.g. `a.md` includes `b.md` includes `c.md`...), variables defined in the top-most page will take precedence. Global variables (`_markbind/variables.md`) will take precedence over any page variables.
Note: These variables will not be applied to [`<include>` files]({{ baseUrl }}/userGuide/reusingContents.html#the-include-tag). Additionally, global variables (`_markbind/variables.md`) will take precedence over any page variables. *See also: [Specifying Variables in an `<include>`]({{ baseUrl }}/userGuide/reusingContents.html#specifying-variables-in-an-include)*.


### Variables: Tips and Tricks
Expand Down

19 changes: 10 additions & 9 deletions
src/lib/markbind/src/parser.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -127,11 +127,11 @@ function extractIncludeVariables(includeElement, contextVariables) {
 * @param filename for error printing
 * @param data to extract variables from
 * @param userDefinedVariables global variables
 * @param contextVariables variables defined by parent pages
 * @param includedVariables variables from parent include
 */
function extractPageVariables(fileName, data, userDefinedVariables, contextVariables) {
function extractPageVariables(fileName, data, userDefinedVariables, includedVariables) {
 const $ = cheerio.load(data);
 const pageVariables = { ...contextVariables };
 const pageVariables = { };
 $('variable').each(function () {
 const variableElement = $(this);
 const variableName = variableElement.attr('name');
Expand All@@ -143,7 +143,7 @@ function extractPageVariables(fileName, data, userDefinedVariables, contextVaria
 if (!pageVariables[variableName]) {
 pageVariables[variableName]
 = nunjucks.renderString(md.renderInline(variableElement.html()),
 { ...pageVariables, ...userDefinedVariables });
 { ...pageVariables, ...userDefinedVariables, ...includedVariables });
 }
 });
 return pageVariables;
Expand DownExpand Up@@ -268,13 +268,15 @@ Parser.prototype._preprocess = function (node, context, config) {
 const userDefinedVariables = config.userDefinedVariablesMap[path.resolve(parent, relative)];

 // Extract included variables from the PARENT file
let allVariables = extractIncludeVariables(element, context.variables);
const includeVariables = extractIncludeVariables(element, context.variables);

 // Extract page variables from the CHILD file
 allVariables = extractPageVariables(element.attribs.src, fileContent, userDefinedVariables, allVariables);
 const pageVariables = extractPageVariables(element.attribs.src, fileContent,
 userDefinedVariables, includeVariables);

 // Render inner file content
 fileContent = nunjucks.renderString(fileContent, { ...allVariables, ...userDefinedVariables });
 fileContent = nunjucks.renderString(fileContent,
 { ...pageVariables, ...includeVariables, ...userDefinedVariables });

 // Delete variable attributes in include
 Object.keys(element.attribs).forEach((attribute) => {
Expand DownExpand Up@@ -343,7 +345,7 @@ Parser.prototype._preprocess = function (node, context, config) {
 childContext.cwf = filePath;
 childContext.source = isIncludeSrcMd ? 'md' : 'html';
 childContext.callStack.push(context.cwf);
 childContext.variables = allVariables;
 childContext.variables = includeVariables;

 if (element.children && element.children.length > 0) {
 if (childContext.callStack.length > CyclicReferenceError.MAX_RECURSIVE_DEPTH) {
Expand DownExpand Up@@ -503,7 +505,6 @@ Parser.prototype.includeFile = function (file, config) {
 const userDefinedVariables = config.userDefinedVariablesMap[path.resolve(parent, relative)];
 const pageVariables = extractPageVariables(path.basename(file), data, userDefinedVariables, {});
 const fileContent = nunjucks.renderString(data, { ...pageVariables, ...userDefinedVariables });
 context.variables = pageVariables;
 const fileExt = utils.getExt(file);
 if (utils.isMarkdownFileExt(fileExt)) {
 context.source = 'md';
Expand Down

17 changes: 10 additions & 7 deletions
test/functional/test_site/expected/index.html

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -41,10 +41,11 @@
 <a class="nav-link py-1" href="#page-variable-referencing-page-variable">Page Variable referencing Page Variable&#x200E;</a>
 <a class="nav-link py-1" href="#global-variable-overriding-page-variable">Global Variable overriding Page Variable&#x200E;</a>
 <a class="nav-link py-1" href="#test-page-variable-and-included-variable-integrations">Test Page Variable and Included Variable Integrations&#x200E;</a>
 <a class="nav-link py-1" href="#outer-page-variable-overriding-inner-page-variable">Outer Page Variable Overriding Inner Page Variable&#x200E;</a>
 <a class="nav-link py-1" href="#explicitly-included-page-variable">Explicitly Included Page Variable&#x200E;</a>
 <a class="nav-link py-1" href="#inner-page-variable-should-not-be-overridden-by-outer-page-variable">Inner Page Variable Should Not Be Overridden by Outer Page Variable&#x200E;</a>
 <a class="nav-link py-1" href="#outer-page-variable-should-not-leak-into-inner-pages">Outer Page Variable Should Not Leak Into Inner Pages&#x200E;</a>
 <a class="nav-link py-1" href="#included-variable-overriding-page-variable">Included Variable Overriding Page Variable&#x200E;</a>
 <a class="nav-link py-1" href="#page-variable-referencing-included-variable">Page Variable Referencing Included Variable&#x200E;</a>
 <a class="nav-link py-1" href="#page-variable-referencing-outer-page-variable">Page Variable Referencing Outer Page Variable&#x200E;</a>
 <a class="nav-link py-1" href="#heading-with-multiple-keywords">Heading with multiple keywords&#x200E;</a>
 <a class="nav-link py-1" href="#heading-with-keyword-in-panel">Heading with keyword in panel&#x200E;</a>
 <a class="nav-link py-1" href="#panel-with-heading-with-keyword">Panel with heading with keyword&#x200E;</a>
Expand DownExpand Up@@ -282,19 +283,21 @@ <h1 id="global-variable-overriding-page-variable">Global Variable overriding Pag
 <div></div>
 Global Variable Overriding Page Variable
 <h1 id="test-page-variable-and-included-variable-integrations">Test Page Variable and Included Variable Integrations<a class="fa fa-anchor" href="#test-page-variable-and-included-variable-integrations"></a></h1>
 <div></div>
 <div>
 <h1 id="outer-page-variable-overriding-inner-page-variable">Outer Page Variable Overriding Inner Page Variable<a class="fa fa-anchor" href="#outer-page-variable-overriding-inner-page-variable"></a></h1>
 <h1 id="explicitly-included-page-variable">Explicitly Included Page Variable<a class="fa fa-anchor" href="#explicitly-included-page-variable"></a></h1>
 <p>Explicitly Included Page Variable</p>
 <h1 id="inner-page-variable-should-not-be-overridden-by-outer-page-variable">Inner Page Variable Should Not Be Overridden by Outer Page Variable<a class="fa fa-anchor" href="#inner-page-variable-should-not-be-overridden-by-outer-page-variable"></a></h1>
 <div></div>
 Page Variable
 Inner Page Variable Should Not Be Overridden by Outer Page Variable
 <h1 id="outer-page-variable-should-not-leak-into-inner-pages">Outer Page Variable Should Not Leak Into Inner Pages<a class="fa fa-anchor" href="#outer-page-variable-should-not-leak-into-inner-pages"></a></h1>
 <p>Outer Page Variable Should Not Leak Into Inner Pages</p>
 <h1 id="included-variable-overriding-page-variable">Included Variable Overriding Page Variable<a class="fa fa-anchor" href="#included-variable-overriding-page-variable"></a></h1>
 <div></div>
 Included Variable Overriding Page Variable
 <h1 id="page-variable-referencing-included-variable">Page Variable Referencing Included Variable<a class="fa fa-anchor" href="#page-variable-referencing-included-variable"></a></h1>
 <div></div>
 Page Variable Referencing Included Variable
 <h1 id="page-variable-referencing-outer-page-variable">Page Variable Referencing Outer Page Variable<a class="fa fa-anchor" href="#page-variable-referencing-outer-page-variable"></a></h1>
 <div></div>
 Page Variable Referencing Outer Page Variable
 </div>
 <h1 id="heading-with-multiple-keywords">Heading with multiple keywords<a class="fa fa-anchor" href="#heading-with-multiple-keywords"></a></h1>
 <p><span class="keyword">keyword 1</span>
Expand Down

5 changes: 3 additions & 2 deletions
test/functional/test_site/expected/siteData.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -45,10 +45,11 @@
 "page-variable-referencing-page-variable": "Page Variable referencing Page Variable",
 "global-variable-overriding-page-variable": "Global Variable overriding Page Variable",
 "test-page-variable-and-included-variable-integrations": "Test Page Variable and Included Variable Integrations",
 "outer-page-variable-overriding-inner-page-variable": "Outer Page Variable Overriding Inner Page Variable",
 "explicitly-included-page-variable": "Explicitly Included Page Variable",
 "inner-page-variable-should-not-be-overridden-by-outer-page-variable": "Inner Page Variable Should Not Be Overridden by Outer Page Variable",
 "outer-page-variable-should-not-leak-into-inner-pages": "Outer Page Variable Should Not Leak Into Inner Pages",
 "included-variable-overriding-page-variable": "Included Variable Overriding Page Variable",
 "page-variable-referencing-included-variable": "Page Variable Referencing Included Variable",
 "page-variable-referencing-outer-page-variable": "Page Variable Referencing Outer Page Variable",
 "heading-with-multiple-keywords": "Heading with multiple keywords | keyword 1, keyword 2",
 "heading-with-keyword-in-panel": "Heading with keyword in panel | panel keyword",
 "expanded-panel-without-heading-with-keyword": "Expanded panel without heading with keyword",
Expand Down

2 changes: 2 additions & 0 deletions
test/functional/test_site/index.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -47,7 +47,9 @@ head: myCustomHead.md, myCustomHead2.md
{{ page_global_variable_overriding_page_variable }}

# Test Page Variable and Included Variable Integrations
<variable name="explicitly_included_page_variable">Explicitly Included Page Variable</variable>
<include src="testPageVariablesInInclude.md">
 <span id="explicitly_included_page_variable">{{ explicitly_included_page_variable }}</span>
 <span id="included_variable">Included Variable</span>
 <span id="included_variable_overriding_page_variable">Included Variable Overriding Page Variable</span>
</include>
Expand Down

14 changes: 8 additions & 6 deletions
test/functional/test_site/testPageVariablesInInclude.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,15 +1,17 @@
# Outer Page Variable Overriding Inner Page Variable
<variable name="page_variable">Inner Page Variable Overridden by Outer Page Variable</variable>
# Explicitly Included Page Variable
{{ explicitly_included_page_variable }}

# Inner Page Variable Should Not Be Overridden by Outer Page Variable
<variable name="page_variable">Inner Page Variable Should Not Be Overridden by Outer Page Variable</variable>
{{ page_variable }}

# Outer Page Variable Should Not Leak Into Inner Pages
{{ nested_page_variable or "Outer Page Variable Should Not Leak Into Inner Pages" }}

# Included Variable Overriding Page Variable
<variable name="included_variable_overriding_page_variable">Page Variable Overridden by Included Variable</variable>
{{ included_variable_overriding_page_variable }}

# Page Variable Referencing Included Variable
<variable name="page_variable_referencing_included_variable">Page Variable Referencing {{ included_variable }}</variable>
{{ page_variable_referencing_included_variable }}

# Page Variable Referencing Outer Page Variable
<variable name="page_variable_referencing_outer_page_variable">Page Variable Referencing Outer {{ page_variable }}</variable>
{{ page_variable_referencing_outer_page_variable }}

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Strip utm_, fbclid, gclid, etc. from all links on page
(function() {
var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',
'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',
'ref', 'ref_src', 'source', 'medium', 'campaign'];
function cleanUrl(url) {
try {
var u = new URL(url, window.location.origin);
var changed = false;
trackingParams.forEach(function(p) {
if (u.searchParams.has(p)) {
u.searchParams.delete(p);
changed = true;
}
});
return changed ? u.toString() : url;
} catch (e) {
return url;
}
}
function cleanLinks() {
document.querySelectorAll('a[href]').forEach(function(a) {
var clean = cleanUrl(a.href);
if (clean !== a.href) a.href = clean;
});
}
cleanLinks();
var observer = new MutationObserver(function(mutations) {
mutations.forEach(function(m) {
m.addedNodes.forEach(function(node) {
if (node.nodeType === 1) {
if (node.tagName === 'A') cleanLinks();
node.querySelectorAll('a[href]').forEach(function(a) {
var clean = cleanUrl(a.href);
if (clean !== a.href) a.href = clean;
});
}
});
});
});
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); }
})();
(function(){
try {
var __m = "youtube.com";
var __re = new RegExp('^' + "youtube\\.com" + '
Make page variables no longer cascade into inner files by jamos-tay · Pull Request #693 · MarkBind/markbind · GitHub
Skip to content
Make page variables no longer cascade into inner files#693

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.

 Sign up for GitHub

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

 Merged

yamgent
merged 3 commits into

from

Feb 18, 2019
 Merged


Make page variables no longer cascade into inner files
#693
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


3 commits


Select commit
Hold shift + click to select a range
8112377

Fix page variable cascading


jamos-tay Feb 14, 2019
766ee05

Update documentation


jamos-tay Feb 14, 2019
d078526

Explicit include page variable test


jamos-tay Feb 14, 2019

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


2 changes: 1 addition & 1 deletion
docs/userGuide/syntax/variables.mbdf

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -99,7 +99,7 @@ You can specify a default value for a variable, which is displayed when the vari
<code>My name is {<span></span>{ full_name }}. This is {<span></span>{ full_name }}'s site.</code>
</div>

Note: These variables will also be applied to [`<include>` files]({{ baseUrl }}/userGuide/reusingContents.html#the-include-tag). If the same variable is defined in a chain of pages (e.g. `a.md` includes `b.md` includes `c.md`...), variables defined in the top-most page will take precedence. Global variables (`_markbind/variables.md`) will take precedence over any page variables.
Note: These variables will not be applied to [`<include>` files]({{ baseUrl }}/userGuide/reusingContents.html#the-include-tag). Additionally, global variables (`_markbind/variables.md`) will take precedence over any page variables. *See also: [Specifying Variables in an `<include>`]({{ baseUrl }}/userGuide/reusingContents.html#specifying-variables-in-an-include)*.


### Variables: Tips and Tricks
Expand Down

19 changes: 10 additions & 9 deletions
src/lib/markbind/src/parser.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -127,11 +127,11 @@ function extractIncludeVariables(includeElement, contextVariables) {
 * @param filename for error printing
 * @param data to extract variables from
 * @param userDefinedVariables global variables
 * @param contextVariables variables defined by parent pages
 * @param includedVariables variables from parent include
 */
function extractPageVariables(fileName, data, userDefinedVariables, contextVariables) {
function extractPageVariables(fileName, data, userDefinedVariables, includedVariables) {
 const $ = cheerio.load(data);
 const pageVariables = { ...contextVariables };
 const pageVariables = { };
 $('variable').each(function () {
 const variableElement = $(this);
 const variableName = variableElement.attr('name');
Expand All@@ -143,7 +143,7 @@ function extractPageVariables(fileName, data, userDefinedVariables, contextVaria
 if (!pageVariables[variableName]) {
 pageVariables[variableName]
 = nunjucks.renderString(md.renderInline(variableElement.html()),
 { ...pageVariables, ...userDefinedVariables });
 { ...pageVariables, ...userDefinedVariables, ...includedVariables });
 }
 });
 return pageVariables;
Expand DownExpand Up@@ -268,13 +268,15 @@ Parser.prototype._preprocess = function (node, context, config) {
 const userDefinedVariables = config.userDefinedVariablesMap[path.resolve(parent, relative)];

 // Extract included variables from the PARENT file
let allVariables = extractIncludeVariables(element, context.variables);
const includeVariables = extractIncludeVariables(element, context.variables);

 // Extract page variables from the CHILD file
 allVariables = extractPageVariables(element.attribs.src, fileContent, userDefinedVariables, allVariables);
 const pageVariables = extractPageVariables(element.attribs.src, fileContent,
 userDefinedVariables, includeVariables);

 // Render inner file content
 fileContent = nunjucks.renderString(fileContent, { ...allVariables, ...userDefinedVariables });
 fileContent = nunjucks.renderString(fileContent,
 { ...pageVariables, ...includeVariables, ...userDefinedVariables });

 // Delete variable attributes in include
 Object.keys(element.attribs).forEach((attribute) => {
Expand DownExpand Up@@ -343,7 +345,7 @@ Parser.prototype._preprocess = function (node, context, config) {
 childContext.cwf = filePath;
 childContext.source = isIncludeSrcMd ? 'md' : 'html';
 childContext.callStack.push(context.cwf);
 childContext.variables = allVariables;
 childContext.variables = includeVariables;

 if (element.children && element.children.length > 0) {
 if (childContext.callStack.length > CyclicReferenceError.MAX_RECURSIVE_DEPTH) {
Expand DownExpand Up@@ -503,7 +505,6 @@ Parser.prototype.includeFile = function (file, config) {
 const userDefinedVariables = config.userDefinedVariablesMap[path.resolve(parent, relative)];
 const pageVariables = extractPageVariables(path.basename(file), data, userDefinedVariables, {});
 const fileContent = nunjucks.renderString(data, { ...pageVariables, ...userDefinedVariables });
 context.variables = pageVariables;
 const fileExt = utils.getExt(file);
 if (utils.isMarkdownFileExt(fileExt)) {
 context.source = 'md';
Expand Down

17 changes: 10 additions & 7 deletions
test/functional/test_site/expected/index.html

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -41,10 +41,11 @@
 <a class="nav-link py-1" href="#page-variable-referencing-page-variable">Page Variable referencing Page Variable&#x200E;</a>
 <a class="nav-link py-1" href="#global-variable-overriding-page-variable">Global Variable overriding Page Variable&#x200E;</a>
 <a class="nav-link py-1" href="#test-page-variable-and-included-variable-integrations">Test Page Variable and Included Variable Integrations&#x200E;</a>
 <a class="nav-link py-1" href="#outer-page-variable-overriding-inner-page-variable">Outer Page Variable Overriding Inner Page Variable&#x200E;</a>
 <a class="nav-link py-1" href="#explicitly-included-page-variable">Explicitly Included Page Variable&#x200E;</a>
 <a class="nav-link py-1" href="#inner-page-variable-should-not-be-overridden-by-outer-page-variable">Inner Page Variable Should Not Be Overridden by Outer Page Variable&#x200E;</a>
 <a class="nav-link py-1" href="#outer-page-variable-should-not-leak-into-inner-pages">Outer Page Variable Should Not Leak Into Inner Pages&#x200E;</a>
 <a class="nav-link py-1" href="#included-variable-overriding-page-variable">Included Variable Overriding Page Variable&#x200E;</a>
 <a class="nav-link py-1" href="#page-variable-referencing-included-variable">Page Variable Referencing Included Variable&#x200E;</a>
 <a class="nav-link py-1" href="#page-variable-referencing-outer-page-variable">Page Variable Referencing Outer Page Variable&#x200E;</a>
 <a class="nav-link py-1" href="#heading-with-multiple-keywords">Heading with multiple keywords&#x200E;</a>
 <a class="nav-link py-1" href="#heading-with-keyword-in-panel">Heading with keyword in panel&#x200E;</a>
 <a class="nav-link py-1" href="#panel-with-heading-with-keyword">Panel with heading with keyword&#x200E;</a>
Expand DownExpand Up@@ -282,19 +283,21 @@ <h1 id="global-variable-overriding-page-variable">Global Variable overriding Pag
 <div></div>
 Global Variable Overriding Page Variable
 <h1 id="test-page-variable-and-included-variable-integrations">Test Page Variable and Included Variable Integrations<a class="fa fa-anchor" href="#test-page-variable-and-included-variable-integrations"></a></h1>
 <div></div>
 <div>
 <h1 id="outer-page-variable-overriding-inner-page-variable">Outer Page Variable Overriding Inner Page Variable<a class="fa fa-anchor" href="#outer-page-variable-overriding-inner-page-variable"></a></h1>
 <h1 id="explicitly-included-page-variable">Explicitly Included Page Variable<a class="fa fa-anchor" href="#explicitly-included-page-variable"></a></h1>
 <p>Explicitly Included Page Variable</p>
 <h1 id="inner-page-variable-should-not-be-overridden-by-outer-page-variable">Inner Page Variable Should Not Be Overridden by Outer Page Variable<a class="fa fa-anchor" href="#inner-page-variable-should-not-be-overridden-by-outer-page-variable"></a></h1>
 <div></div>
 Page Variable
 Inner Page Variable Should Not Be Overridden by Outer Page Variable
 <h1 id="outer-page-variable-should-not-leak-into-inner-pages">Outer Page Variable Should Not Leak Into Inner Pages<a class="fa fa-anchor" href="#outer-page-variable-should-not-leak-into-inner-pages"></a></h1>
 <p>Outer Page Variable Should Not Leak Into Inner Pages</p>
 <h1 id="included-variable-overriding-page-variable">Included Variable Overriding Page Variable<a class="fa fa-anchor" href="#included-variable-overriding-page-variable"></a></h1>
 <div></div>
 Included Variable Overriding Page Variable
 <h1 id="page-variable-referencing-included-variable">Page Variable Referencing Included Variable<a class="fa fa-anchor" href="#page-variable-referencing-included-variable"></a></h1>
 <div></div>
 Page Variable Referencing Included Variable
 <h1 id="page-variable-referencing-outer-page-variable">Page Variable Referencing Outer Page Variable<a class="fa fa-anchor" href="#page-variable-referencing-outer-page-variable"></a></h1>
 <div></div>
 Page Variable Referencing Outer Page Variable
 </div>
 <h1 id="heading-with-multiple-keywords">Heading with multiple keywords<a class="fa fa-anchor" href="#heading-with-multiple-keywords"></a></h1>
 <p><span class="keyword">keyword 1</span>
Expand Down

5 changes: 3 additions & 2 deletions
test/functional/test_site/expected/siteData.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -45,10 +45,11 @@
 "page-variable-referencing-page-variable": "Page Variable referencing Page Variable",
 "global-variable-overriding-page-variable": "Global Variable overriding Page Variable",
 "test-page-variable-and-included-variable-integrations": "Test Page Variable and Included Variable Integrations",
 "outer-page-variable-overriding-inner-page-variable": "Outer Page Variable Overriding Inner Page Variable",
 "explicitly-included-page-variable": "Explicitly Included Page Variable",
 "inner-page-variable-should-not-be-overridden-by-outer-page-variable": "Inner Page Variable Should Not Be Overridden by Outer Page Variable",
 "outer-page-variable-should-not-leak-into-inner-pages": "Outer Page Variable Should Not Leak Into Inner Pages",
 "included-variable-overriding-page-variable": "Included Variable Overriding Page Variable",
 "page-variable-referencing-included-variable": "Page Variable Referencing Included Variable",
 "page-variable-referencing-outer-page-variable": "Page Variable Referencing Outer Page Variable",
 "heading-with-multiple-keywords": "Heading with multiple keywords | keyword 1, keyword 2",
 "heading-with-keyword-in-panel": "Heading with keyword in panel | panel keyword",
 "expanded-panel-without-heading-with-keyword": "Expanded panel without heading with keyword",
Expand Down

2 changes: 2 additions & 0 deletions
test/functional/test_site/index.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -47,7 +47,9 @@ head: myCustomHead.md, myCustomHead2.md
{{ page_global_variable_overriding_page_variable }}

# Test Page Variable and Included Variable Integrations
<variable name="explicitly_included_page_variable">Explicitly Included Page Variable</variable>
<include src="testPageVariablesInInclude.md">
 <span id="explicitly_included_page_variable">{{ explicitly_included_page_variable }}</span>
 <span id="included_variable">Included Variable</span>
 <span id="included_variable_overriding_page_variable">Included Variable Overriding Page Variable</span>
</include>
Expand Down

14 changes: 8 additions & 6 deletions
test/functional/test_site/testPageVariablesInInclude.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,15 +1,17 @@
# Outer Page Variable Overriding Inner Page Variable
<variable name="page_variable">Inner Page Variable Overridden by Outer Page Variable</variable>
# Explicitly Included Page Variable
{{ explicitly_included_page_variable }}

# Inner Page Variable Should Not Be Overridden by Outer Page Variable
<variable name="page_variable">Inner Page Variable Should Not Be Overridden by Outer Page Variable</variable>
{{ page_variable }}

# Outer Page Variable Should Not Leak Into Inner Pages
{{ nested_page_variable or "Outer Page Variable Should Not Leak Into Inner Pages" }}

# Included Variable Overriding Page Variable
<variable name="included_variable_overriding_page_variable">Page Variable Overridden by Included Variable</variable>
{{ included_variable_overriding_page_variable }}

# Page Variable Referencing Included Variable
<variable name="page_variable_referencing_included_variable">Page Variable Referencing {{ included_variable }}</variable>
{{ page_variable_referencing_included_variable }}

# Page Variable Referencing Outer Page Variable
<variable name="page_variable_referencing_outer_page_variable">Page Variable Referencing Outer {{ page_variable }}</variable>
{{ page_variable_referencing_outer_page_variable }}

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Auto-enable theater mode on YouTube
(function() {
function tryTheater() {
var btn = document.querySelector('button[aria-label="Theater mode"], ytd-player #player button[title="Theater mode"]');
if (btn && !btn.classList.contains('activated')) {
btn.click();
}
}
// Try immediately
tryTheater();
// Try after navigation (SPA)
var lastUrl = location.href;
setInterval(function() {
if (location.href !== lastUrl) {
lastUrl = location.href;
setTimeout(tryTheater, 500);
}
}, 1000);
// Also try on player load
var observer = new MutationObserver(tryTheater);
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
Make page variables no longer cascade into inner files by jamos-tay · Pull Request #693 · MarkBind/markbind · GitHub
Skip to content
Make page variables no longer cascade into inner files#693

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.

 Sign up for GitHub

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

 Merged

yamgent
merged 3 commits into

from

Feb 18, 2019
 Merged


Make page variables no longer cascade into inner files
#693
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


3 commits


Select commit
Hold shift + click to select a range
8112377

Fix page variable cascading


jamos-tay Feb 14, 2019
766ee05

Update documentation


jamos-tay Feb 14, 2019
d078526

Explicit include page variable test


jamos-tay Feb 14, 2019

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


2 changes: 1 addition & 1 deletion
docs/userGuide/syntax/variables.mbdf

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -99,7 +99,7 @@ You can specify a default value for a variable, which is displayed when the vari
<code>My name is {<span></span>{ full_name }}. This is {<span></span>{ full_name }}'s site.</code>
</div>

Note: These variables will also be applied to [`<include>` files]({{ baseUrl }}/userGuide/reusingContents.html#the-include-tag). If the same variable is defined in a chain of pages (e.g. `a.md` includes `b.md` includes `c.md`...), variables defined in the top-most page will take precedence. Global variables (`_markbind/variables.md`) will take precedence over any page variables.
Note: These variables will not be applied to [`<include>` files]({{ baseUrl }}/userGuide/reusingContents.html#the-include-tag). Additionally, global variables (`_markbind/variables.md`) will take precedence over any page variables. *See also: [Specifying Variables in an `<include>`]({{ baseUrl }}/userGuide/reusingContents.html#specifying-variables-in-an-include)*.


### Variables: Tips and Tricks
Expand Down

19 changes: 10 additions & 9 deletions
src/lib/markbind/src/parser.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -127,11 +127,11 @@ function extractIncludeVariables(includeElement, contextVariables) {
 * @param filename for error printing
 * @param data to extract variables from
 * @param userDefinedVariables global variables
 * @param contextVariables variables defined by parent pages
 * @param includedVariables variables from parent include
 */
function extractPageVariables(fileName, data, userDefinedVariables, contextVariables) {
function extractPageVariables(fileName, data, userDefinedVariables, includedVariables) {
 const $ = cheerio.load(data);
 const pageVariables = { ...contextVariables };
 const pageVariables = { };
 $('variable').each(function () {
 const variableElement = $(this);
 const variableName = variableElement.attr('name');
Expand All@@ -143,7 +143,7 @@ function extractPageVariables(fileName, data, userDefinedVariables, contextVaria
 if (!pageVariables[variableName]) {
 pageVariables[variableName]
 = nunjucks.renderString(md.renderInline(variableElement.html()),
 { ...pageVariables, ...userDefinedVariables });
 { ...pageVariables, ...userDefinedVariables, ...includedVariables });
 }
 });
 return pageVariables;
Expand DownExpand Up@@ -268,13 +268,15 @@ Parser.prototype._preprocess = function (node, context, config) {
 const userDefinedVariables = config.userDefinedVariablesMap[path.resolve(parent, relative)];

 // Extract included variables from the PARENT file
let allVariables = extractIncludeVariables(element, context.variables);
const includeVariables = extractIncludeVariables(element, context.variables);

 // Extract page variables from the CHILD file
 allVariables = extractPageVariables(element.attribs.src, fileContent, userDefinedVariables, allVariables);
 const pageVariables = extractPageVariables(element.attribs.src, fileContent,
 userDefinedVariables, includeVariables);

 // Render inner file content
 fileContent = nunjucks.renderString(fileContent, { ...allVariables, ...userDefinedVariables });
 fileContent = nunjucks.renderString(fileContent,
 { ...pageVariables, ...includeVariables, ...userDefinedVariables });

 // Delete variable attributes in include
 Object.keys(element.attribs).forEach((attribute) => {
Expand DownExpand Up@@ -343,7 +345,7 @@ Parser.prototype._preprocess = function (node, context, config) {
 childContext.cwf = filePath;
 childContext.source = isIncludeSrcMd ? 'md' : 'html';
 childContext.callStack.push(context.cwf);
 childContext.variables = allVariables;
 childContext.variables = includeVariables;

 if (element.children && element.children.length > 0) {
 if (childContext.callStack.length > CyclicReferenceError.MAX_RECURSIVE_DEPTH) {
Expand DownExpand Up@@ -503,7 +505,6 @@ Parser.prototype.includeFile = function (file, config) {
 const userDefinedVariables = config.userDefinedVariablesMap[path.resolve(parent, relative)];
 const pageVariables = extractPageVariables(path.basename(file), data, userDefinedVariables, {});
 const fileContent = nunjucks.renderString(data, { ...pageVariables, ...userDefinedVariables });
 context.variables = pageVariables;
 const fileExt = utils.getExt(file);
 if (utils.isMarkdownFileExt(fileExt)) {
 context.source = 'md';
Expand Down

17 changes: 10 additions & 7 deletions
test/functional/test_site/expected/index.html

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -41,10 +41,11 @@
 <a class="nav-link py-1" href="#page-variable-referencing-page-variable">Page Variable referencing Page Variable&#x200E;</a>
 <a class="nav-link py-1" href="#global-variable-overriding-page-variable">Global Variable overriding Page Variable&#x200E;</a>
 <a class="nav-link py-1" href="#test-page-variable-and-included-variable-integrations">Test Page Variable and Included Variable Integrations&#x200E;</a>
 <a class="nav-link py-1" href="#outer-page-variable-overriding-inner-page-variable">Outer Page Variable Overriding Inner Page Variable&#x200E;</a>
 <a class="nav-link py-1" href="#explicitly-included-page-variable">Explicitly Included Page Variable&#x200E;</a>
 <a class="nav-link py-1" href="#inner-page-variable-should-not-be-overridden-by-outer-page-variable">Inner Page Variable Should Not Be Overridden by Outer Page Variable&#x200E;</a>
 <a class="nav-link py-1" href="#outer-page-variable-should-not-leak-into-inner-pages">Outer Page Variable Should Not Leak Into Inner Pages&#x200E;</a>
 <a class="nav-link py-1" href="#included-variable-overriding-page-variable">Included Variable Overriding Page Variable&#x200E;</a>
 <a class="nav-link py-1" href="#page-variable-referencing-included-variable">Page Variable Referencing Included Variable&#x200E;</a>
 <a class="nav-link py-1" href="#page-variable-referencing-outer-page-variable">Page Variable Referencing Outer Page Variable&#x200E;</a>
 <a class="nav-link py-1" href="#heading-with-multiple-keywords">Heading with multiple keywords&#x200E;</a>
 <a class="nav-link py-1" href="#heading-with-keyword-in-panel">Heading with keyword in panel&#x200E;</a>
 <a class="nav-link py-1" href="#panel-with-heading-with-keyword">Panel with heading with keyword&#x200E;</a>
Expand DownExpand Up@@ -282,19 +283,21 @@ <h1 id="global-variable-overriding-page-variable">Global Variable overriding Pag
 <div></div>
 Global Variable Overriding Page Variable
 <h1 id="test-page-variable-and-included-variable-integrations">Test Page Variable and Included Variable Integrations<a class="fa fa-anchor" href="#test-page-variable-and-included-variable-integrations"></a></h1>
 <div></div>
 <div>
 <h1 id="outer-page-variable-overriding-inner-page-variable">Outer Page Variable Overriding Inner Page Variable<a class="fa fa-anchor" href="#outer-page-variable-overriding-inner-page-variable"></a></h1>
 <h1 id="explicitly-included-page-variable">Explicitly Included Page Variable<a class="fa fa-anchor" href="#explicitly-included-page-variable"></a></h1>
 <p>Explicitly Included Page Variable</p>
 <h1 id="inner-page-variable-should-not-be-overridden-by-outer-page-variable">Inner Page Variable Should Not Be Overridden by Outer Page Variable<a class="fa fa-anchor" href="#inner-page-variable-should-not-be-overridden-by-outer-page-variable"></a></h1>
 <div></div>
 Page Variable
 Inner Page Variable Should Not Be Overridden by Outer Page Variable
 <h1 id="outer-page-variable-should-not-leak-into-inner-pages">Outer Page Variable Should Not Leak Into Inner Pages<a class="fa fa-anchor" href="#outer-page-variable-should-not-leak-into-inner-pages"></a></h1>
 <p>Outer Page Variable Should Not Leak Into Inner Pages</p>
 <h1 id="included-variable-overriding-page-variable">Included Variable Overriding Page Variable<a class="fa fa-anchor" href="#included-variable-overriding-page-variable"></a></h1>
 <div></div>
 Included Variable Overriding Page Variable
 <h1 id="page-variable-referencing-included-variable">Page Variable Referencing Included Variable<a class="fa fa-anchor" href="#page-variable-referencing-included-variable"></a></h1>
 <div></div>
 Page Variable Referencing Included Variable
 <h1 id="page-variable-referencing-outer-page-variable">Page Variable Referencing Outer Page Variable<a class="fa fa-anchor" href="#page-variable-referencing-outer-page-variable"></a></h1>
 <div></div>
 Page Variable Referencing Outer Page Variable
 </div>
 <h1 id="heading-with-multiple-keywords">Heading with multiple keywords<a class="fa fa-anchor" href="#heading-with-multiple-keywords"></a></h1>
 <p><span class="keyword">keyword 1</span>
Expand Down

5 changes: 3 additions & 2 deletions
test/functional/test_site/expected/siteData.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -45,10 +45,11 @@
 "page-variable-referencing-page-variable": "Page Variable referencing Page Variable",
 "global-variable-overriding-page-variable": "Global Variable overriding Page Variable",
 "test-page-variable-and-included-variable-integrations": "Test Page Variable and Included Variable Integrations",
 "outer-page-variable-overriding-inner-page-variable": "Outer Page Variable Overriding Inner Page Variable",
 "explicitly-included-page-variable": "Explicitly Included Page Variable",
 "inner-page-variable-should-not-be-overridden-by-outer-page-variable": "Inner Page Variable Should Not Be Overridden by Outer Page Variable",
 "outer-page-variable-should-not-leak-into-inner-pages": "Outer Page Variable Should Not Leak Into Inner Pages",
 "included-variable-overriding-page-variable": "Included Variable Overriding Page Variable",
 "page-variable-referencing-included-variable": "Page Variable Referencing Included Variable",
 "page-variable-referencing-outer-page-variable": "Page Variable Referencing Outer Page Variable",
 "heading-with-multiple-keywords": "Heading with multiple keywords | keyword 1, keyword 2",
 "heading-with-keyword-in-panel": "Heading with keyword in panel | panel keyword",
 "expanded-panel-without-heading-with-keyword": "Expanded panel without heading with keyword",
Expand Down

2 changes: 2 additions & 0 deletions
test/functional/test_site/index.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -47,7 +47,9 @@ head: myCustomHead.md, myCustomHead2.md
{{ page_global_variable_overriding_page_variable }}

# Test Page Variable and Included Variable Integrations
<variable name="explicitly_included_page_variable">Explicitly Included Page Variable</variable>
<include src="testPageVariablesInInclude.md">
 <span id="explicitly_included_page_variable">{{ explicitly_included_page_variable }}</span>
 <span id="included_variable">Included Variable</span>
 <span id="included_variable_overriding_page_variable">Included Variable Overriding Page Variable</span>
</include>
Expand Down

14 changes: 8 additions & 6 deletions
test/functional/test_site/testPageVariablesInInclude.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,15 +1,17 @@
# Outer Page Variable Overriding Inner Page Variable
<variable name="page_variable">Inner Page Variable Overridden by Outer Page Variable</variable>
# Explicitly Included Page Variable
{{ explicitly_included_page_variable }}

# Inner Page Variable Should Not Be Overridden by Outer Page Variable
<variable name="page_variable">Inner Page Variable Should Not Be Overridden by Outer Page Variable</variable>
{{ page_variable }}

# Outer Page Variable Should Not Leak Into Inner Pages
{{ nested_page_variable or "Outer Page Variable Should Not Leak Into Inner Pages" }}

# Included Variable Overriding Page Variable
<variable name="included_variable_overriding_page_variable">Page Variable Overridden by Included Variable</variable>
{{ included_variable_overriding_page_variable }}

# Page Variable Referencing Included Variable
<variable name="page_variable_referencing_included_variable">Page Variable Referencing {{ included_variable }}</variable>
{{ page_variable_referencing_included_variable }}

# Page Variable Referencing Outer Page Variable
<variable name="page_variable_referencing_outer_page_variable">Page Variable Referencing Outer {{ page_variable }}</variable>
{{ page_variable_referencing_outer_page_variable }}

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Remove or un-stick sticky/fixed headers that block content
(function() {
function unstick() {
document.querySelectorAll('header, nav, [role="banner"], .header, .navbar, .sticky, .fixed-top, [style*="position: fixed"], [style*="position:sticky"]').forEach(function(el) {
if (el.style.position === 'fixed' || el.style.position === 'sticky' || getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {
el.style.position = 'static';
el.style.top = 'auto';
el.style.zIndex = 'auto';
}
});
}
unstick();
var observer = new MutationObserver(unstick);
observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });
})();
}
} catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
Make page variables no longer cascade into inner files by jamos-tay · Pull Request #693 · MarkBind/markbind · GitHub
Skip to content
Make page variables no longer cascade into inner files#693

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.

 Sign up for GitHub

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

 Merged

yamgent
merged 3 commits into

from

Feb 18, 2019
 Merged


Make page variables no longer cascade into inner files
#693
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


3 commits


Select commit
Hold shift + click to select a range
8112377

Fix page variable cascading


jamos-tay Feb 14, 2019
766ee05

Update documentation


jamos-tay Feb 14, 2019
d078526

Explicit include page variable test


jamos-tay Feb 14, 2019

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


2 changes: 1 addition & 1 deletion
docs/userGuide/syntax/variables.mbdf

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -99,7 +99,7 @@ You can specify a default value for a variable, which is displayed when the vari
<code>My name is {<span></span>{ full_name }}. This is {<span></span>{ full_name }}'s site.</code>
</div>

Note: These variables will also be applied to [`<include>` files]({{ baseUrl }}/userGuide/reusingContents.html#the-include-tag). If the same variable is defined in a chain of pages (e.g. `a.md` includes `b.md` includes `c.md`...), variables defined in the top-most page will take precedence. Global variables (`_markbind/variables.md`) will take precedence over any page variables.
Note: These variables will not be applied to [`<include>` files]({{ baseUrl }}/userGuide/reusingContents.html#the-include-tag). Additionally, global variables (`_markbind/variables.md`) will take precedence over any page variables. *See also: [Specifying Variables in an `<include>`]({{ baseUrl }}/userGuide/reusingContents.html#specifying-variables-in-an-include)*.


### Variables: Tips and Tricks
Expand Down

19 changes: 10 additions & 9 deletions
src/lib/markbind/src/parser.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -127,11 +127,11 @@ function extractIncludeVariables(includeElement, contextVariables) {
 * @param filename for error printing
 * @param data to extract variables from
 * @param userDefinedVariables global variables
 * @param contextVariables variables defined by parent pages
 * @param includedVariables variables from parent include
 */
function extractPageVariables(fileName, data, userDefinedVariables, contextVariables) {
function extractPageVariables(fileName, data, userDefinedVariables, includedVariables) {
 const $ = cheerio.load(data);
 const pageVariables = { ...contextVariables };
 const pageVariables = { };
 $('variable').each(function () {
 const variableElement = $(this);
 const variableName = variableElement.attr('name');
Expand All@@ -143,7 +143,7 @@ function extractPageVariables(fileName, data, userDefinedVariables, contextVaria
 if (!pageVariables[variableName]) {
 pageVariables[variableName]
 = nunjucks.renderString(md.renderInline(variableElement.html()),
 { ...pageVariables, ...userDefinedVariables });
 { ...pageVariables, ...userDefinedVariables, ...includedVariables });
 }
 });
 return pageVariables;
Expand DownExpand Up@@ -268,13 +268,15 @@ Parser.prototype._preprocess = function (node, context, config) {
 const userDefinedVariables = config.userDefinedVariablesMap[path.resolve(parent, relative)];

 // Extract included variables from the PARENT file
let allVariables = extractIncludeVariables(element, context.variables);
const includeVariables = extractIncludeVariables(element, context.variables);

 // Extract page variables from the CHILD file
 allVariables = extractPageVariables(element.attribs.src, fileContent, userDefinedVariables, allVariables);
 const pageVariables = extractPageVariables(element.attribs.src, fileContent,
 userDefinedVariables, includeVariables);

 // Render inner file content
 fileContent = nunjucks.renderString(fileContent, { ...allVariables, ...userDefinedVariables });
 fileContent = nunjucks.renderString(fileContent,
 { ...pageVariables, ...includeVariables, ...userDefinedVariables });

 // Delete variable attributes in include
 Object.keys(element.attribs).forEach((attribute) => {
Expand DownExpand Up@@ -343,7 +345,7 @@ Parser.prototype._preprocess = function (node, context, config) {
 childContext.cwf = filePath;
 childContext.source = isIncludeSrcMd ? 'md' : 'html';
 childContext.callStack.push(context.cwf);
 childContext.variables = allVariables;
 childContext.variables = includeVariables;

 if (element.children && element.children.length > 0) {
 if (childContext.callStack.length > CyclicReferenceError.MAX_RECURSIVE_DEPTH) {
Expand DownExpand Up@@ -503,7 +505,6 @@ Parser.prototype.includeFile = function (file, config) {
 const userDefinedVariables = config.userDefinedVariablesMap[path.resolve(parent, relative)];
 const pageVariables = extractPageVariables(path.basename(file), data, userDefinedVariables, {});
 const fileContent = nunjucks.renderString(data, { ...pageVariables, ...userDefinedVariables });
 context.variables = pageVariables;
 const fileExt = utils.getExt(file);
 if (utils.isMarkdownFileExt(fileExt)) {
 context.source = 'md';
Expand Down

17 changes: 10 additions & 7 deletions
test/functional/test_site/expected/index.html

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -41,10 +41,11 @@
 <a class="nav-link py-1" href="#page-variable-referencing-page-variable">Page Variable referencing Page Variable&#x200E;</a>
 <a class="nav-link py-1" href="#global-variable-overriding-page-variable">Global Variable overriding Page Variable&#x200E;</a>
 <a class="nav-link py-1" href="#test-page-variable-and-included-variable-integrations">Test Page Variable and Included Variable Integrations&#x200E;</a>
 <a class="nav-link py-1" href="#outer-page-variable-overriding-inner-page-variable">Outer Page Variable Overriding Inner Page Variable&#x200E;</a>
 <a class="nav-link py-1" href="#explicitly-included-page-variable">Explicitly Included Page Variable&#x200E;</a>
 <a class="nav-link py-1" href="#inner-page-variable-should-not-be-overridden-by-outer-page-variable">Inner Page Variable Should Not Be Overridden by Outer Page Variable&#x200E;</a>
 <a class="nav-link py-1" href="#outer-page-variable-should-not-leak-into-inner-pages">Outer Page Variable Should Not Leak Into Inner Pages&#x200E;</a>
 <a class="nav-link py-1" href="#included-variable-overriding-page-variable">Included Variable Overriding Page Variable&#x200E;</a>
 <a class="nav-link py-1" href="#page-variable-referencing-included-variable">Page Variable Referencing Included Variable&#x200E;</a>
 <a class="nav-link py-1" href="#page-variable-referencing-outer-page-variable">Page Variable Referencing Outer Page Variable&#x200E;</a>
 <a class="nav-link py-1" href="#heading-with-multiple-keywords">Heading with multiple keywords&#x200E;</a>
 <a class="nav-link py-1" href="#heading-with-keyword-in-panel">Heading with keyword in panel&#x200E;</a>
 <a class="nav-link py-1" href="#panel-with-heading-with-keyword">Panel with heading with keyword&#x200E;</a>
Expand DownExpand Up@@ -282,19 +283,21 @@ <h1 id="global-variable-overriding-page-variable">Global Variable overriding Pag
 <div></div>
 Global Variable Overriding Page Variable
 <h1 id="test-page-variable-and-included-variable-integrations">Test Page Variable and Included Variable Integrations<a class="fa fa-anchor" href="#test-page-variable-and-included-variable-integrations"></a></h1>
 <div></div>
 <div>
 <h1 id="outer-page-variable-overriding-inner-page-variable">Outer Page Variable Overriding Inner Page Variable<a class="fa fa-anchor" href="#outer-page-variable-overriding-inner-page-variable"></a></h1>
 <h1 id="explicitly-included-page-variable">Explicitly Included Page Variable<a class="fa fa-anchor" href="#explicitly-included-page-variable"></a></h1>
 <p>Explicitly Included Page Variable</p>
 <h1 id="inner-page-variable-should-not-be-overridden-by-outer-page-variable">Inner Page Variable Should Not Be Overridden by Outer Page Variable<a class="fa fa-anchor" href="#inner-page-variable-should-not-be-overridden-by-outer-page-variable"></a></h1>
 <div></div>
 Page Variable
 Inner Page Variable Should Not Be Overridden by Outer Page Variable
 <h1 id="outer-page-variable-should-not-leak-into-inner-pages">Outer Page Variable Should Not Leak Into Inner Pages<a class="fa fa-anchor" href="#outer-page-variable-should-not-leak-into-inner-pages"></a></h1>
 <p>Outer Page Variable Should Not Leak Into Inner Pages</p>
 <h1 id="included-variable-overriding-page-variable">Included Variable Overriding Page Variable<a class="fa fa-anchor" href="#included-variable-overriding-page-variable"></a></h1>
 <div></div>
 Included Variable Overriding Page Variable
 <h1 id="page-variable-referencing-included-variable">Page Variable Referencing Included Variable<a class="fa fa-anchor" href="#page-variable-referencing-included-variable"></a></h1>
 <div></div>
 Page Variable Referencing Included Variable
 <h1 id="page-variable-referencing-outer-page-variable">Page Variable Referencing Outer Page Variable<a class="fa fa-anchor" href="#page-variable-referencing-outer-page-variable"></a></h1>
 <div></div>
 Page Variable Referencing Outer Page Variable
 </div>
 <h1 id="heading-with-multiple-keywords">Heading with multiple keywords<a class="fa fa-anchor" href="#heading-with-multiple-keywords"></a></h1>
 <p><span class="keyword">keyword 1</span>
Expand Down

5 changes: 3 additions & 2 deletions
test/functional/test_site/expected/siteData.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -45,10 +45,11 @@
 "page-variable-referencing-page-variable": "Page Variable referencing Page Variable",
 "global-variable-overriding-page-variable": "Global Variable overriding Page Variable",
 "test-page-variable-and-included-variable-integrations": "Test Page Variable and Included Variable Integrations",
 "outer-page-variable-overriding-inner-page-variable": "Outer Page Variable Overriding Inner Page Variable",
 "explicitly-included-page-variable": "Explicitly Included Page Variable",
 "inner-page-variable-should-not-be-overridden-by-outer-page-variable": "Inner Page Variable Should Not Be Overridden by Outer Page Variable",
 "outer-page-variable-should-not-leak-into-inner-pages": "Outer Page Variable Should Not Leak Into Inner Pages",
 "included-variable-overriding-page-variable": "Included Variable Overriding Page Variable",
 "page-variable-referencing-included-variable": "Page Variable Referencing Included Variable",
 "page-variable-referencing-outer-page-variable": "Page Variable Referencing Outer Page Variable",
 "heading-with-multiple-keywords": "Heading with multiple keywords | keyword 1, keyword 2",
 "heading-with-keyword-in-panel": "Heading with keyword in panel | panel keyword",
 "expanded-panel-without-heading-with-keyword": "Expanded panel without heading with keyword",
Expand Down

2 changes: 2 additions & 0 deletions
test/functional/test_site/index.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -47,7 +47,9 @@ head: myCustomHead.md, myCustomHead2.md
{{ page_global_variable_overriding_page_variable }}

# Test Page Variable and Included Variable Integrations
<variable name="explicitly_included_page_variable">Explicitly Included Page Variable</variable>
<include src="testPageVariablesInInclude.md">
 <span id="explicitly_included_page_variable">{{ explicitly_included_page_variable }}</span>
 <span id="included_variable">Included Variable</span>
 <span id="included_variable_overriding_page_variable">Included Variable Overriding Page Variable</span>
</include>
Expand Down

14 changes: 8 additions & 6 deletions
test/functional/test_site/testPageVariablesInInclude.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,15 +1,17 @@
# Outer Page Variable Overriding Inner Page Variable
<variable name="page_variable">Inner Page Variable Overridden by Outer Page Variable</variable>
# Explicitly Included Page Variable
{{ explicitly_included_page_variable }}

# Inner Page Variable Should Not Be Overridden by Outer Page Variable
<variable name="page_variable">Inner Page Variable Should Not Be Overridden by Outer Page Variable</variable>
{{ page_variable }}

# Outer Page Variable Should Not Leak Into Inner Pages
{{ nested_page_variable or "Outer Page Variable Should Not Leak Into Inner Pages" }}

# Included Variable Overriding Page Variable
<variable name="included_variable_overriding_page_variable">Page Variable Overridden by Included Variable</variable>
{{ included_variable_overriding_page_variable }}

# Page Variable Referencing Included Variable
<variable name="page_variable_referencing_included_variable">Page Variable Referencing {{ included_variable }}</variable>
{{ page_variable_referencing_included_variable }}

# Page Variable Referencing Outer Page Variable
<variable name="page_variable_referencing_outer_page_variable">Page Variable Referencing Outer {{ page_variable }}</variable>
{{ page_variable_referencing_outer_page_variable }}

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Universal Dark Mode - works on any site
(function() {
var enabled = true;
function applyDarkMode() {
if (!enabled) return;
// Create style element if it doesn't exist
var style = document.getElementById('universal-dark-mode-style');
if (!style) {
style = document.createElement('style');
style.id = 'universal-dark-mode-style';
document.head.appendChild(style);
}
// Dark mode CSS - inverts colors but preserves images/video
style.textContent = '
/* Invert everything except media */
html {
filter: invert(1) hue-rotate(180deg) !important;
background: #1a1a2e !important;
}
/* Restore images, videos, iframes, canvas */
img, video, iframe, canvas, svg, picture, [style*="background-image"] {
filter: invert(1) hue-rotate(180deg) !important;
}
/* Preserve specific elements that should not be inverted */
.no-dark-mode, .no-dark-mode *,
[data-theme="light"], [data-theme="light"],
.ace_editor, .ace_editor *,
.CodeMirror, .CodeMirror *,
.monaco-editor, .monaco-editor *,
.markdown-body pre, .markdown-body pre *,
.highlight, .highlight *,
pre code, pre code * {
filter: none !important;
}
/* Fix common UI elements */
.modal, .popup, .dropdown-menu, .tooltip, .popover {
filter: invert(1) hue-rotate(180deg) !important;
background: #2d2d44 !important;
border-color: #444 !important;
}
/* Scrollbars */
::-webkit-scrollbar { background: #1a1a2e !important; }
::-webkit-scrollbar-thumb { background: #444 !important; }
::-webkit-scrollbar-thumb:hover { background: #555 !important; }
/* Selection */
::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }
::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }
';
}
function removeDarkMode() {
var style = document.getElementById('universal-dark-mode-style');
if (style) style.remove();
}
// Toggle with Alt+Shift+D
document.addEventListener('keydown', function(e) {
if (e.altKey && e.shiftKey && e.key === 'D') {
e.preventDefault();
enabled = !enabled;
if (enabled) {
applyDarkMode();
console.log('[Universal Dark Mode] Enabled');
} else {
removeDarkMode();
console.log('[Universal Dark Mode] Disabled');
}
}
});
// Apply on load
applyDarkMode();
// Re-apply on dynamic content
var observer = new MutationObserver(function(mutations) {
if (enabled && !document.getElementById('universal-dark-mode-style')) {
applyDarkMode();
}
});
observer.observe(document.head, { childList: true });
console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');
})();
}
} catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); }
})();
})();
Make page variables no longer cascade into inner files by jamos-tay · Pull Request #693 · MarkBind/markbind · GitHub
Skip to content
Make page variables no longer cascade into inner files#693

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.

 Sign up for GitHub

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

 Merged

yamgent
merged 3 commits into

from

Feb 18, 2019
 Merged


Make page variables no longer cascade into inner files
#693
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


3 commits


Select commit
Hold shift + click to select a range
8112377

Fix page variable cascading


jamos-tay Feb 14, 2019
766ee05

Update documentation


jamos-tay Feb 14, 2019
d078526

Explicit include page variable test


jamos-tay Feb 14, 2019

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


2 changes: 1 addition & 1 deletion
docs/userGuide/syntax/variables.mbdf

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -99,7 +99,7 @@ You can specify a default value for a variable, which is displayed when the vari
<code>My name is {<span></span>{ full_name }}. This is {<span></span>{ full_name }}'s site.</code>
</div>

Note: These variables will also be applied to [`<include>` files]({{ baseUrl }}/userGuide/reusingContents.html#the-include-tag). If the same variable is defined in a chain of pages (e.g. `a.md` includes `b.md` includes `c.md`...), variables defined in the top-most page will take precedence. Global variables (`_markbind/variables.md`) will take precedence over any page variables.
Note: These variables will not be applied to [`<include>` files]({{ baseUrl }}/userGuide/reusingContents.html#the-include-tag). Additionally, global variables (`_markbind/variables.md`) will take precedence over any page variables. *See also: [Specifying Variables in an `<include>`]({{ baseUrl }}/userGuide/reusingContents.html#specifying-variables-in-an-include)*.


### Variables: Tips and Tricks
Expand Down

19 changes: 10 additions & 9 deletions
src/lib/markbind/src/parser.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -127,11 +127,11 @@ function extractIncludeVariables(includeElement, contextVariables) {
 * @param filename for error printing
 * @param data to extract variables from
 * @param userDefinedVariables global variables
 * @param contextVariables variables defined by parent pages
 * @param includedVariables variables from parent include
 */
function extractPageVariables(fileName, data, userDefinedVariables, contextVariables) {
function extractPageVariables(fileName, data, userDefinedVariables, includedVariables) {
 const $ = cheerio.load(data);
 const pageVariables = { ...contextVariables };
 const pageVariables = { };
 $('variable').each(function () {
 const variableElement = $(this);
 const variableName = variableElement.attr('name');
Expand All@@ -143,7 +143,7 @@ function extractPageVariables(fileName, data, userDefinedVariables, contextVaria
 if (!pageVariables[variableName]) {
 pageVariables[variableName]
 = nunjucks.renderString(md.renderInline(variableElement.html()),
 { ...pageVariables, ...userDefinedVariables });
 { ...pageVariables, ...userDefinedVariables, ...includedVariables });
 }
 });
 return pageVariables;
Expand DownExpand Up@@ -268,13 +268,15 @@ Parser.prototype._preprocess = function (node, context, config) {
 const userDefinedVariables = config.userDefinedVariablesMap[path.resolve(parent, relative)];

 // Extract included variables from the PARENT file
let allVariables = extractIncludeVariables(element, context.variables);
const includeVariables = extractIncludeVariables(element, context.variables);

 // Extract page variables from the CHILD file
 allVariables = extractPageVariables(element.attribs.src, fileContent, userDefinedVariables, allVariables);
 const pageVariables = extractPageVariables(element.attribs.src, fileContent,
 userDefinedVariables, includeVariables);

 // Render inner file content
 fileContent = nunjucks.renderString(fileContent, { ...allVariables, ...userDefinedVariables });
 fileContent = nunjucks.renderString(fileContent,
 { ...pageVariables, ...includeVariables, ...userDefinedVariables });

 // Delete variable attributes in include
 Object.keys(element.attribs).forEach((attribute) => {
Expand DownExpand Up@@ -343,7 +345,7 @@ Parser.prototype._preprocess = function (node, context, config) {
 childContext.cwf = filePath;
 childContext.source = isIncludeSrcMd ? 'md' : 'html';
 childContext.callStack.push(context.cwf);
 childContext.variables = allVariables;
 childContext.variables = includeVariables;

 if (element.children && element.children.length > 0) {
 if (childContext.callStack.length > CyclicReferenceError.MAX_RECURSIVE_DEPTH) {
Expand DownExpand Up@@ -503,7 +505,6 @@ Parser.prototype.includeFile = function (file, config) {
 const userDefinedVariables = config.userDefinedVariablesMap[path.resolve(parent, relative)];
 const pageVariables = extractPageVariables(path.basename(file), data, userDefinedVariables, {});
 const fileContent = nunjucks.renderString(data, { ...pageVariables, ...userDefinedVariables });
 context.variables = pageVariables;
 const fileExt = utils.getExt(file);
 if (utils.isMarkdownFileExt(fileExt)) {
 context.source = 'md';
Expand Down

17 changes: 10 additions & 7 deletions
test/functional/test_site/expected/index.html

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -41,10 +41,11 @@
 <a class="nav-link py-1" href="#page-variable-referencing-page-variable">Page Variable referencing Page Variable&#x200E;</a>
 <a class="nav-link py-1" href="#global-variable-overriding-page-variable">Global Variable overriding Page Variable&#x200E;</a>
 <a class="nav-link py-1" href="#test-page-variable-and-included-variable-integrations">Test Page Variable and Included Variable Integrations&#x200E;</a>
 <a class="nav-link py-1" href="#outer-page-variable-overriding-inner-page-variable">Outer Page Variable Overriding Inner Page Variable&#x200E;</a>
 <a class="nav-link py-1" href="#explicitly-included-page-variable">Explicitly Included Page Variable&#x200E;</a>
 <a class="nav-link py-1" href="#inner-page-variable-should-not-be-overridden-by-outer-page-variable">Inner Page Variable Should Not Be Overridden by Outer Page Variable&#x200E;</a>
 <a class="nav-link py-1" href="#outer-page-variable-should-not-leak-into-inner-pages">Outer Page Variable Should Not Leak Into Inner Pages&#x200E;</a>
 <a class="nav-link py-1" href="#included-variable-overriding-page-variable">Included Variable Overriding Page Variable&#x200E;</a>
 <a class="nav-link py-1" href="#page-variable-referencing-included-variable">Page Variable Referencing Included Variable&#x200E;</a>
 <a class="nav-link py-1" href="#page-variable-referencing-outer-page-variable">Page Variable Referencing Outer Page Variable&#x200E;</a>
 <a class="nav-link py-1" href="#heading-with-multiple-keywords">Heading with multiple keywords&#x200E;</a>
 <a class="nav-link py-1" href="#heading-with-keyword-in-panel">Heading with keyword in panel&#x200E;</a>
 <a class="nav-link py-1" href="#panel-with-heading-with-keyword">Panel with heading with keyword&#x200E;</a>
Expand DownExpand Up@@ -282,19 +283,21 @@ <h1 id="global-variable-overriding-page-variable">Global Variable overriding Pag
 <div></div>
 Global Variable Overriding Page Variable
 <h1 id="test-page-variable-and-included-variable-integrations">Test Page Variable and Included Variable Integrations<a class="fa fa-anchor" href="#test-page-variable-and-included-variable-integrations"></a></h1>
 <div></div>
 <div>
 <h1 id="outer-page-variable-overriding-inner-page-variable">Outer Page Variable Overriding Inner Page Variable<a class="fa fa-anchor" href="#outer-page-variable-overriding-inner-page-variable"></a></h1>
 <h1 id="explicitly-included-page-variable">Explicitly Included Page Variable<a class="fa fa-anchor" href="#explicitly-included-page-variable"></a></h1>
 <p>Explicitly Included Page Variable</p>
 <h1 id="inner-page-variable-should-not-be-overridden-by-outer-page-variable">Inner Page Variable Should Not Be Overridden by Outer Page Variable<a class="fa fa-anchor" href="#inner-page-variable-should-not-be-overridden-by-outer-page-variable"></a></h1>
 <div></div>
 Page Variable
 Inner Page Variable Should Not Be Overridden by Outer Page Variable
 <h1 id="outer-page-variable-should-not-leak-into-inner-pages">Outer Page Variable Should Not Leak Into Inner Pages<a class="fa fa-anchor" href="#outer-page-variable-should-not-leak-into-inner-pages"></a></h1>
 <p>Outer Page Variable Should Not Leak Into Inner Pages</p>
 <h1 id="included-variable-overriding-page-variable">Included Variable Overriding Page Variable<a class="fa fa-anchor" href="#included-variable-overriding-page-variable"></a></h1>
 <div></div>
 Included Variable Overriding Page Variable
 <h1 id="page-variable-referencing-included-variable">Page Variable Referencing Included Variable<a class="fa fa-anchor" href="#page-variable-referencing-included-variable"></a></h1>
 <div></div>
 Page Variable Referencing Included Variable
 <h1 id="page-variable-referencing-outer-page-variable">Page Variable Referencing Outer Page Variable<a class="fa fa-anchor" href="#page-variable-referencing-outer-page-variable"></a></h1>
 <div></div>
 Page Variable Referencing Outer Page Variable
 </div>
 <h1 id="heading-with-multiple-keywords">Heading with multiple keywords<a class="fa fa-anchor" href="#heading-with-multiple-keywords"></a></h1>
 <p><span class="keyword">keyword 1</span>
Expand Down

5 changes: 3 additions & 2 deletions
test/functional/test_site/expected/siteData.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -45,10 +45,11 @@
 "page-variable-referencing-page-variable": "Page Variable referencing Page Variable",
 "global-variable-overriding-page-variable": "Global Variable overriding Page Variable",
 "test-page-variable-and-included-variable-integrations": "Test Page Variable and Included Variable Integrations",
 "outer-page-variable-overriding-inner-page-variable": "Outer Page Variable Overriding Inner Page Variable",
 "explicitly-included-page-variable": "Explicitly Included Page Variable",
 "inner-page-variable-should-not-be-overridden-by-outer-page-variable": "Inner Page Variable Should Not Be Overridden by Outer Page Variable",
 "outer-page-variable-should-not-leak-into-inner-pages": "Outer Page Variable Should Not Leak Into Inner Pages",
 "included-variable-overriding-page-variable": "Included Variable Overriding Page Variable",
 "page-variable-referencing-included-variable": "Page Variable Referencing Included Variable",
 "page-variable-referencing-outer-page-variable": "Page Variable Referencing Outer Page Variable",
 "heading-with-multiple-keywords": "Heading with multiple keywords | keyword 1, keyword 2",
 "heading-with-keyword-in-panel": "Heading with keyword in panel | panel keyword",
 "expanded-panel-without-heading-with-keyword": "Expanded panel without heading with keyword",
Expand Down

2 changes: 2 additions & 0 deletions
test/functional/test_site/index.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -47,7 +47,9 @@ head: myCustomHead.md, myCustomHead2.md
{{ page_global_variable_overriding_page_variable }}

# Test Page Variable and Included Variable Integrations
<variable name="explicitly_included_page_variable">Explicitly Included Page Variable</variable>
<include src="testPageVariablesInInclude.md">
 <span id="explicitly_included_page_variable">{{ explicitly_included_page_variable }}</span>
 <span id="included_variable">Included Variable</span>
 <span id="included_variable_overriding_page_variable">Included Variable Overriding Page Variable</span>
</include>
Expand Down

14 changes: 8 additions & 6 deletions
test/functional/test_site/testPageVariablesInInclude.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,15 +1,17 @@
# Outer Page Variable Overriding Inner Page Variable
<variable name="page_variable">Inner Page Variable Overridden by Outer Page Variable</variable>
# Explicitly Included Page Variable
{{ explicitly_included_page_variable }}

# Inner Page Variable Should Not Be Overridden by Outer Page Variable
<variable name="page_variable">Inner Page Variable Should Not Be Overridden by Outer Page Variable</variable>
{{ page_variable }}

# Outer Page Variable Should Not Leak Into Inner Pages
{{ nested_page_variable or "Outer Page Variable Should Not Leak Into Inner Pages" }}

# Included Variable Overriding Page Variable
<variable name="included_variable_overriding_page_variable">Page Variable Overridden by Included Variable</variable>
{{ included_variable_overriding_page_variable }}

# Page Variable Referencing Included Variable
<variable name="page_variable_referencing_included_variable">Page Variable Referencing {{ included_variable }}</variable>
{{ page_variable_referencing_included_variable }}

# Page Variable Referencing Outer Page Variable
<variable name="page_variable_referencing_outer_page_variable">Page Variable Referencing Outer {{ page_variable }}</variable>
{{ page_variable_referencing_outer_page_variable }}