Addition Nodes in HTML head #56

Ze0nC · 2020-01-19T07:32:49Z

Hi @JohnSundell, sorry for requesting pulling so frequently.
Here is one about an API change. The idea is in early stage and I want to discuss about it with you if you are interested.

About the change

To add the additionalNodes argument in head function to specify addition nodes for pages.
To add a whole-site additional Nodes for head.

I really appreciate the idea of "javascript-free", but sometimes we need to embed javascript in html head, such as when using Google Analytics.
Therefore, I needed a way to add customized additional whole site nodes.

I have tried to write an extension in extension Node where Context == HTML.HeadContext in my own package. But I think it might be better to include the ability to add additional nodes in the official Publish repo.

usage example
One example is adding Google Analytics to Publish, which requires script node in head.
I have made demo plugin which uses the additionalWholeSiteHeadNodes property.

Another example is writing articles which need specific .js files. I have tried to show LaTeX equations with MathJax, so I need to add MathJaX script on some pages (not all). In this case the 'additionalNodes' argument is helpful.

Please consider the request when convienent.
Cheers,
Zhijin

Details are moved to plugin's readme.md

Removed the optional arguments of .head (Reverted last commit.)

…addition-node-in-head

into addition-node-in-head # Conflicts: # Sources/Publish/API/PlotComponents.swift

artur-ios-dev · 2020-01-19T09:18:54Z

Oh, I was about to create same PR 👍 Right now we end up doing a pretty much the copy of the already prepared .head() which kinda sucks.

Ze0nC · 2020-01-21T17:04:09Z

Oh, I was about to create same PR 👍 Right now we end up doing a pretty much the copy of the already prepared .head() which kinda sucks.

It seems we all have this issue.

Since I want to keep using current code of my theme, I am using forked version of Publish and I have to keep it updated with upstream. It sometimes causes conflicts with other plugins.

Btw do you have any suggestion on improvement this implementation? I am wondering if there is a better way to do it...

artur-ios-dev · 2020-01-21T17:05:42Z

@Ze0nC I just made my own header function for now until this PR is merged.

Ze0nC · 2020-01-21T17:06:13Z

Oh, I was about to create same PR 👍 Right now we end up doing a pretty much the copy of the already prepared .head() which kinda sucks.

Off topic question: do you find any way to modify the content after generation of HTML, just like the Modifier in Plot.

artur-ios-dev · 2020-01-21T18:03:19Z

Off topic question: do you find any way to modify the content after generation of HTML, just like the Modifier in Plot.

I put a STRING_KEY in my article which I replace with the actual text while building page.

JohnSundell

Thanks a lot for this @Ze0nC. Just remove the static var, and I'll gladly merge this in. I agree that Plot probably needs a way to modify nodes after they were created. I'll see if I can find some time to work on figuring something out for that soon, and if you have any ideas, feel free to submit a PR. I'm really grateful for all of your contributions 🙂

JohnSundell · 2020-01-24T09:24:32Z

Sources/Publish/API/PlotComponents.swift

    /// - parameter rssFeedPath: The path to any RSS feed to associate with the
    ///   resulting HTML page. Default: `feed.rss`.
    /// - parameter rssFeedTitle: An optional title for the page's RSS feed.
+    /// - parameter additionalNodes: Optional additional nodes for the page.


for the page -> to add to the resulting <head> element.

JohnSundell · 2020-01-24T09:26:21Z

Sources/Publish/API/PlotComponents.swift


+public extension Node where Context == HTML.DocumentContext {
+    /// Additional nodes of head. These nodes will be added to head of whole site.
+    static var additionalWholeSiteHeadNodes: [Node<HTML.HeadContext>] = []


I don't think adding globally mutable state is a good idea. I understand the use case for this, but I think it should be solved in other ways, for example by creating a site-specific head extension which then composes these universal nodes into Publish's head(for...) call.

I agree with you. Global variable is not a clean way to do.

Let me consider a better implementation.

I'd just remove it for now, so that we can merge the other change in 🙂

I have removed it.

…addition-node-in-head

… Context == HTML.DocumentContext

Ze0nC · 2020-02-21T12:41:29Z

Hi @JohnSundell ! I have finished my defense so now I have more free time on it!

After some considerations and trials I found it is hard for me to implement it without using global variable, so I would like to discuss with you.

First of all, we need to store the nodes in some place, and I have considered:

Node<HTML.DocumentContext>: This is bad since it is global. But it is the most convenient place to put global head nodes?
Website instance: Probably a good place, but I think 'Node' probably shouldn't appear here
PublishContext: Same with above.
HTMLFactory: Seems to be a good place. This is where HTML are generated.
Theme: Seems to be a good place?

I have considered for some days but haven't figured it out.
Do you have some ideas/suggestions?

Cheers,
Zhijin

Ze0nC · 2020-03-02T18:40:11Z

Hi @JohnSundell. I hope you are doing well recently.
I committed a draft of new way to manage global head nodes of websites.
Here are the changes:

'ConditionalHeadNode' has been added. It defines a var node: Node<HTML.HeadContext> with a var condition: (Location) -> Bool, and var target: String which is description of Website.
'ConditionalHeadNode' has a static variable var all: [ConditionalHeadNode], which holds all head nodes to add.
2 new functions were added to extension of Website to add and get the head nodes.

When the above change, it is possible to:

Add global head nodes to certain websites.
Add head nodes to certain pages of website.

However, it is not perfect:

Should Website protocol has functions which deal with Node?
Current way to identify target websites is by using description of websites. This is not safe and Swiftly. However due to limitation of my skills I didn't find a better to do it.
Instead of var all: [ConditionalHeadNode], a dictionary might be better to store the nodes.

I hope this implementation is better then previous one.

Cheers,
Zhijin

yogeshmanghnani · 2020-07-14T22:19:31Z

why isn't this PR merged ?

Malauch · 2021-01-03T06:55:19Z

I hope this PR will be merged soon.

jjaychen1e · 2021-10-18T02:56:56Z

I'm looking forward to this great feature! When can this PR be merged?

t2ac32 · 2021-12-06T22:29:17Z

So there's no implemented way of adding a Script tag at this moment?

dannys42 · 2021-12-30T05:36:45Z

I was looking for a solution to this as well, but I'm thinking it would be nice to have it as a plugin or additional publishing step. My reason for this is that I'd like to easily switch it on/off depending on whether I'm deploying for production or test.

dannys42 · 2021-12-31T07:41:18Z

@Ze0nC My approach to this problem is in PR-120. It's working with raw HTML, so not type-safe in any way, but allows someone to easily make a GoogleAnalytics plugin.

Ze0nC added 18 commits January 15, 2020 22:24

Create add-syntax-highlighting-with-pygments.md

3da8e49

Updated title.

d3013df

Added link to new Howto md

a92915c

Simplified the how-to md

91cab18

Details are moved to plugin's readme.md

Changed add to adding

a364f45

Grammar fix

edba0c2

added adding-color-to-tags.md

7fd436e

Added new article

b53afd0

Merge remote-tracking branch 'upstream/master'

d75ab29

Fix branch issue

d35d66f

head node accepts additional nodes

237a471

Added functions to add additional head nodes

52d8686

Removed the optional arguments of .head (Reverted last commit.)

Merge branch 'master' of https://github.com/JohnSundell/Publish into …

fbdd94c

…addition-node-in-head

removed colortags how-to

05349c0

Additional whole site node and optional node for pages.

ade65fb

Additional whole site node and optional node for pages.

fec29f6

Merge branch 'addition-node-in-head' of https://github.com/Ze0nC/Publish

d0f1147

into addition-node-in-head # Conflicts: # Sources/Publish/API/PlotComponents.swift

Fixed naming and optional argument

b0c45a4

JohnSundell reviewed Jan 24, 2020

View reviewed changes

JohnSundell added the awaiting update Awaiting an update from the PR author label Jan 29, 2020

Ze0nC added 2 commits February 21, 2020 04:02

Merge branch 'master' of https://github.com/JohnSundell/Publish into …

ba4e185

…addition-node-in-head

Removed global variable of additionalWholeSiteHeadNodes in Node where…

760267b

… Context == HTML.DocumentContext

Added a mechanism to add head nodes to a website at certain locations.

07abca8

russellgordon mentioned this pull request Aug 15, 2020

Add equation support JohnSundell/Ink#56

Open

Addition Nodes in HTML head #56

Are you sure you want to change the base?

Addition Nodes in HTML head #56

Uh oh!

Conversation

Ze0nC commented Jan 19, 2020

Uh oh!

artur-ios-dev commented Jan 19, 2020

Uh oh!

Ze0nC commented Jan 21, 2020

Uh oh!

artur-ios-dev commented Jan 21, 2020

Uh oh!

Ze0nC commented Jan 21, 2020

Uh oh!

artur-ios-dev commented Jan 21, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

JohnSundell left a comment

Choose a reason for hiding this comment

Uh oh!

JohnSundell Jan 24, 2020

Choose a reason for hiding this comment

Uh oh!

JohnSundell Jan 24, 2020

Choose a reason for hiding this comment

Uh oh!

Ze0nC Jan 24, 2020

Choose a reason for hiding this comment

Uh oh!

JohnSundell Jan 24, 2020

Choose a reason for hiding this comment

Uh oh!

Ze0nC Feb 21, 2020

Choose a reason for hiding this comment

Uh oh!

Ze0nC commented Feb 21, 2020

Uh oh!

Ze0nC commented Mar 2, 2020

Uh oh!

yogeshmanghnani commented Jul 14, 2020

Uh oh!

Malauch commented Jan 3, 2021

Uh oh!

jjaychen1e commented Oct 18, 2021

Uh oh!

t2ac32 commented Dec 6, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

dannys42 commented Dec 30, 2021

Uh oh!

dannys42 commented Dec 31, 2021

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

8 participants

artur-ios-dev commented Jan 21, 2020 •

edited

Loading

t2ac32 commented Dec 6, 2021 •

edited

Loading