Allow pages to be excluded from search #296

nusjzx · 2018-06-29T07:29:46Z

What is the purpose of this pull request? (put "X" next to an item, remove the rest)

• [ ] Documentation update
• [ ] Bug fix
• [ ] New feature
• [X] Enhancement to an existing feature
• [ ] Other, please explain:

Resolves #269

What is the rationale for this request?
In some websites, there is heavy duplication of content. e.g., normal text book and a printable version of a text book. should allow some pages to be excluded from search results

What changes did you make? (Give an overview)
allow "searchable" : "no" in page or glob entries. when rendering site data, filter out these pages

Testing instructions:

2103 website: add "searchable" : "no" in {glob: "print.md"} entry
before:

after:

no more printable entries.
website: https://nusjzx.github.io/website-base/

yamgent · 2018-06-29T08:15:48Z

Update PR title: 269-Allow pages excluded from search -> Allow pages to be excluded from search (remove the issue number + add 'to be')
Need to select the correct purpose of the PR:

• [ ] Documentation update
• [ ] Bug fix
• [ ] New feature
• [ ] Enhancement to an existing feature
• [ ] Other, please explain:

~~I can't get the searchable attribute to work on the page's frontmatter. See this folder:~~

~`https://github.com/yamgent/markbind-problems/tree/master/pr_296_version_1~~

~~I added searchable: no to nextPage.md. Tried it on the live preview, I can still find nextPage.md:~~

Not relevant as per Prof's comment in #269.

yamgent

Also update the documentation website to explain how to use the new searchable syntax.

yamgent · 2018-06-29T08:34:21Z

lib/Page.js

@@ -60,6 +60,7 @@ function Page(pageConfig) {
  this.frontMatter = {};
  this.headings = {};
  this.includedFiles = {};
+  this.searchable = pageConfig.searchable;


Let's move this line below line 46, as the variables that are using pageConfig are all initialized there.

yamgent · 2018-06-29T08:35:41Z

lib/Site.js

@@ -259,6 +259,7 @@ Site.prototype.createPage = function (config) {
    sourcePath,
    tempPath,
    resultPath,
+    searchable: config.searchable,


Let's move this to below line 254 to maintain alphabetical order (only the sourcePath, tempPath, resultPath and asset are placed at the bottom).

yamgent · 2018-06-29T08:37:36Z

lib/Site.js

  // Add pages collected by walkSync without duplication
-  this.addressablePages = _.unionWith(this.addressablePages, globPaths,
+  this.addressablePages = _.unionWith(globPaths, this.addressablePages,


Is there a reason why we swapped the order here?

As you explained face-to-face, the scenario in concern was this:

{ "src": "index.md", "title": "Hello World" }, { "glob": "index.md", "searchable": "no" },

This will not work if the order is not swapped.

Hmm, src should have higher priority than glob as it's more specific.

Hmm, src should have higher priority than glob as it's more specific.

@acjh agree with you on this. @damithc do you agree with this as well?

I'm ok with src having higher priority than glob.

{ "src": "index.md", "title": "Hello World" }, { "glob": "index.md", "searchable": "no" },

In the case above, it looks like the "searchable": "no" should be applied because src (although of higher priority) doesn't specify the searchable property. i.e., specified should take priority over not specified. But I'm ok this is too hard to implement.

yamgent · 2018-06-29T08:45:34Z

lib/Site.js

@@ -491,6 +494,7 @@ Site.prototype.generatePages = function () {
    faviconUrl,
    pageSrc: page.src,
    title: page.title,
+    searchable: page.searchable ? (page.searchable !== 'no') : true,


Can be simplified to just:

searchable: (page.searchable !== 'no'),

EDIT: Edited the syntax

yamgent

Just a grammar correction, the rest LGTM.

yamgent · 2018-07-02T06:00:51Z

docs/userGuide/siteConfiguration.md

@@ -45,7 +46,7 @@ Let's examine a typical `site.json` file:
 | **baseUrl** | The base url relative to your domain. Default: <code></code>&nbsp;(empty). For example, if you are using Github Pages to host your deployed website and it is published at `https://markbind.github.io/site-demo-cs2103`, then your `baseUrl` would be `/site-demo-cs2103`. You can use this variable for [specifying path reference](contentAuthoring.html#specifying-path-reference) of images and links. **You may need to change the `baseUrl` when deploying to a different repo.** |
 | **faviconPath** | The location of the favicon. Default: `favicon.ico`. If the favicon was recently changed, you may need to force-refresh to see the new image. |
 | **titlePrefix** | The prefix for all page titles. The separator <code>-</code> will be inserted by MarkBind. |
-| **pages** | An array of pages to be rendered. The `src` is the file; `title` is the page title for the generated web page. Titles specified here take priority over titles specified in the [front matter](contentAuthoring.html#front-matter) of individual pages. Alternatively, `glob` can be used to define a file pattern. If `title` is not specified in the front matter, the page will have `titlePrefix` as its title. |
+| **pages** | An array of pages to be rendered. The `src` is the file; `title` is the page title for the generated web page. Titles specified here take priority over titles specified in the [front matter](contentAuthoring.html#front-matter) of individual pages. Alternatively, `glob` can be used to define a file pattern. If `title` is not specified in the front matter, the page will have `titlePrefix` as its title. `"searchable": "no"` can be used to specified pages excluded from searching. If you need to exclude pages covered in both page entry and glob entry, you need to specify `"searchable": "no"` in page entry.|


"searchable": "no" can be used to ~~specified~~ specify pages excluded...

...specify pages to be excluded from searching...

yamgent · 2018-07-02T07:45:22Z

docs/userGuide/siteConfiguration.md

@@ -45,7 +46,7 @@ Let's examine a typical `site.json` file:
 | **baseUrl** | The base url relative to your domain. Default: <code></code>&nbsp;(empty). For example, if you are using Github Pages to host your deployed website and it is published at `https://markbind.github.io/site-demo-cs2103`, then your `baseUrl` would be `/site-demo-cs2103`. You can use this variable for [specifying path reference](contentAuthoring.html#specifying-path-reference) of images and links. **You may need to change the `baseUrl` when deploying to a different repo.** |
 | **faviconPath** | The location of the favicon. Default: `favicon.ico`. If the favicon was recently changed, you may need to force-refresh to see the new image. |
 | **titlePrefix** | The prefix for all page titles. The separator <code>-</code> will be inserted by MarkBind. |
-| **pages** | An array of pages to be rendered. The `src` is the file; `title` is the page title for the generated web page. Titles specified here take priority over titles specified in the [front matter](contentAuthoring.html#front-matter) of individual pages. Alternatively, `glob` can be used to define a file pattern. If `title` is not specified in the front matter, the page will have `titlePrefix` as its title. |
+| **pages** | An array of pages to be rendered. The `src` is the file; `title` is the page title for the generated web page. Titles specified here take priority over titles specified in the [front matter](contentAuthoring.html#front-matter) of individual pages. Alternatively, `glob` can be used to define a file pattern. If `title` is not specified in the front matter, the page will have `titlePrefix` as its title. `"searchable": "no"` can be used to specified pages to be excluded from searching. If you need to exclude pages covered in both page entry and glob entry, you need to specify `"searchable": "no"` in page entry.|


"searchable": "no" can be used to ~~specified~~ specify pages excluded...

Did you miss this one?

yamgent

Do squash your commits

nusjzx changed the title ~~269-Allow pages excluded from search~~ Allow pages to be excluded from search Jun 29, 2018

yamgent reviewed Jun 29, 2018

View reviewed changes

yamgent reviewed Jul 2, 2018

View reviewed changes

yamgent approved these changes Jul 2, 2018

View reviewed changes

nusjzx added 2 commits July 2, 2018 16:13

Allow pages to be excluded from searching

0377219

Update documentation

24fc5cf

nusjzx force-pushed the 269-allow-pages-excluded-from-search branch from 99d544d to 24fc5cf Compare July 2, 2018 08:23

yamgent merged commit e6fdd1b into MarkBind:master Jul 3, 2018

yamgent modified the milestones: v1.9.0, v1.9.0 (Migration), v1.8.4 Jul 3, 2018

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Allow pages to be excluded from search #296

Allow pages to be excluded from search #296

nusjzx commented Jun 29, 2018 •

edited

Loading

yamgent commented Jun 29, 2018 •

edited

Loading

yamgent left a comment

yamgent Jun 29, 2018

yamgent Jun 29, 2018

yamgent Jun 29, 2018

yamgent Jun 29, 2018

acjh Jul 1, 2018 •

edited

Loading

yamgent Jul 2, 2018

damithc Jul 2, 2018

yamgent Jun 29, 2018 •

edited

Loading

yamgent left a comment

yamgent Jul 2, 2018

yamgent Jul 2, 2018

yamgent Jul 2, 2018

yamgent left a comment

Allow pages to be excluded from search #296

Allow pages to be excluded from search #296

Conversation

nusjzx commented Jun 29, 2018 • edited Loading

yamgent commented Jun 29, 2018 • edited Loading

yamgent left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

acjh Jul 1, 2018 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

yamgent Jun 29, 2018 • edited Loading

Choose a reason for hiding this comment

yamgent left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

yamgent left a comment

Choose a reason for hiding this comment

nusjzx commented Jun 29, 2018 •

edited

Loading

yamgent commented Jun 29, 2018 •

edited

Loading

acjh Jul 1, 2018 •

edited

Loading

yamgent Jun 29, 2018 •

edited

Loading