[CMS] Add a way to retrieve contents of a different page

[saroyanm]

Background

As mentioned in #2118, sometimes we have a page list the topics covered on another page. A typical example is ​https://adblockplus.org/en/faq, each section refers to a different page.

Currently, we already have the toclist template filter that is used to generate the Table of Contents for a page. However, it only accept HTML code as parameter (available to default.tmpl as the body variable), and there is no way to retrieve the contents of a different page.

What to change

Add a template function get_page_content(page, locale=None) that will process a different page similarly to cms.utils.process_page() function but return the head and the body without embedding them in a template. Note that cms.utils.process_page() logic isn't quite trivial, so it shouldn't be duplicated.

[sebastian]

So you want to show a table of contents for page A on page B? Sounds like an uncommon scenario to me. On which pages do we do that currently? Why do we have to do so?

[saroyanm]

Replying to sebastian:

On which pages do we do that currently?

Here are the list of pages affected by that implementation:
​https://adblockplus.org/en/faq
​https://adblockplus.org/en/android-about
​https://adblockplus.org/en/android-config

[sebastian]

Replying to saroyanm:

Replying to sebastian:

On which pages do we do that currently?

Here are the list of pages affected by that implementation:
​https://adblockplus.org/en/faq

There is no TOC here.

​https://adblockplus.org/en/android-about
​https://adblockplus.org/en/android-config

The TOC here lists the content of the same page. Shouldn't that work with the toclist filter as it is currently implemented?

[saroyanm]

Replying to sebastian:

Replying to saroyanm:

Replying to sebastian:

On which pages do we do that currently?

Here are the list of pages affected by that implementation:
​https://adblockplus.org/en/faq

There is no TOC here.

Here is the content of that page:
<anwtoc titletag="h2" page="en/faq_project"/>
<anwtoc titletag="h2" page="en/faq_install"/>
<anwtoc titletag="h2" page="en/faq_basics"/>
<anwtoc titletag="h2" page="en/faq_features"/>
<anwtoc titletag="h2" page="en/faq_customization"/>
<anwtoc titletag="h2" page="en/faq_internal"/>
<anwtoc titletag="h2" page="en/faq_troubleshooting"/>

​https://adblockplus.org/en/android-about
​https://adblockplus.org/en/android-config

The TOC here lists the content of the same page. Shouldn't that work with the toclist filter as it is currently implemented?

As far as I can see they are listing content from ​https://adblockplus.org/en/android-faq:
<anwtoc page="en/android-faq"/>

[sebastian]

Ah, now I get what you mean. You aren't talking about the actual TOC list at the top of the page, but the FAQ sections which list items from the respective FAQ page.

[trev]

Sorry about unsetting the "ready" flag but I think that this is the wrong approach. The toclist filter already works on any content - what is needed here is a new template filter to load the content for another page. Ideally it would reuse some code with utils.process_page() which currently does everything necessary but also applies the overall template. We should instead stop at getting the head and body of the page.

[sebastian]

I already though about that. But didn't have a strong preference on one way or another here .If in doubt I like to keep templates as limited as possible. But fair enough.

[trev]

Updated title and description, does that sound right to you?

[kzar]

Your idea seems to work OK Wladimir, I was able to get the toclist for a page with a snippet like {{ get_page_content("about.html")[1]|toclist }}. Only thing I noticed is that we might want to move the toc macro out of default.tmpl as we don't seem to have access to it from the other templates currently.

[sebastian]

Maybe we should just make the toclist filter generate HTML, getting rid of the macro.
The HTML generated there is rather generic (just a <ul>, no site-specify classes/ids).

[kzar]

Might be a good idea, one problem would be that the toclist filter would then need to know the page's URL to prepend for each link in the table of contents. We could always add that as an extra parameter though I suppose.

[kzar]

​https://hg.adblockplus.org/cms/rev/9d9cd417365b

[Ross]

Implemented and working.

Tested by:
Running the website converter script as per the read me and checking the TOC output for the mentioned pages + serving pages from CMS.

Tested with:
www / r18024
sitescripts / r501
web.adblockplus.org / r68
website-converter / master / 105208883c4336a3788820fe9ab379cf639f8387