As an experienced website operation expert, I know how to flexibly use the template function, especially in an efficient content management system like AnQiCMS,includeTags are crucial for building maintainable and scalable websites. Today, we will delve deeper into the topic of when you need to go throughincludeWhat is the correct syntax and delimiter when passing multiple parameters to a template fragment in a tag.

In the template design of Anqi CMS, we often extract the common parts of the page, such as the header, footer, sidebar, or some reusable content modules, into independent template files.The benefits of doing so are evident: it improves code reusability, makes the template structure clearer, and greatly reduces the complexity of maintenance later.includeTag.

includeThe basics of tags: the foundation of modular templates.

Let's review first.includeThe basic usage of tags. It allows you to embed content from one template file into another. For example, if you have a file namedpartial/header.htmlThe header template, you can introduce it to the main page like this:

{% include "partial/header.html" %}

Sometimes, you may not be sure if the template file you want to include exists. To avoid page errors caused by a missing file, you can addif_existsKeyword, so if the template file does not actually exist, it will be gracefully ignored:

{% include "partial/header.html" if_exists %}

This basic introduction method is very convenient for static modules that do not require dynamic changes.But the content of the website is often dynamic, and the template fragments we introduce may need to be displayed with different content based on the data passed from the parent template.includeThe parameter passing capability of tags is particularly critical.

Unlock flexibility:withPassing parameters in clauses

In order for the template fragments included to be able to receive and process data from the parent template, the Anqi CMS providesincludetags that providewithclauses. ThroughwithYou can pass variables from the parent template or directly defined new values to the included template.

Assuming yourheader.htmlneed a dynamic page title. You can pass a parameter like this:

{% include "partial/header.html" with pageTitle="我们的最新产品" %}

Inheader.htmlInternally, you can use it just like a regular variable{{ pageTitle }}to display this value. For example,header.htmlmay contain code like this:

<!DOCTYPE html>
<html lang="zh-CN">
<head>
    <meta charset="UTF-8">
    <title>{{ pageTitle }} - 安企CMS</title>
    <!-- 其他头部元素 -->
</head>
<body>
    <!-- 页面内容 -->
</body>
</html>

Key points: Passing multiple arguments and separators

Now, we have arrived at the core issue of the article: what is the correct syntax and delimiter for passing multiple parameters at once in Secure CMS?includeWhat is the correct syntax and delimiter for the tag?

The answer is very concise and clear: you just need towithcontinue using after the clause:key=valueto list all the parameters that need to be passed, and these parameters are separated byspacesas a natural separator.

Let's look at a more specific example. If yourheader.htmlNot only the page title is needed, but also the page keywords (keywords) and page description (description), you can pass them like this: 

{% include "partial/header.html" with pageTitle="安企CMS最新动态" pageKeywords="安企CMS,Go语言CMS,企业建站" pageDescription="安企CMS是基于Go语言开发的企业级内容管理系统，为您提供高效、安全的内容管理解决方案的最新动态。" %}

In this example,pageTitle/pageKeywordsandpageDescriptionthey are three independent parameters, separated by aspacesin.header.htmlIn the template,{{ pageTitle }}/{{ pageKeywords }}and{{ pageDescription }}you can use them to retrieve and display this information respectively.

This is based on space.key=valueIt maintains a high degree of intuitiveness and readability in the passing method, even if there are many parameters to pass, it can be seen at a glance.

Fine control:onlyThe role of keywords

In some cases, you may want the template fragment to be introduced to access only the parameters explicitly passed, and not any other variables inherited from the parent template.withAt this time,onlyKeywords come into play here. InwithAdd at the end of the clauseonly, you can create an isolated scope.

For example:

{% include "partial/footer.html" with companyName="安企CMS科技有限公司" only %}

In this case,footer.htmlCan only accesscompanyNamethis variable, while other variables defined in the parent template, such assiteUrlorcurrentUserwill not be accessible infooter.htmlUsing directly. This is very useful for building highly modular and loosely coupled components, which can effectively avoid variable conflicts or accidental data leakage, enhancing the robustness of the template.

The Practice Value: Why These Details Are Crucial

For Website Operation, It's Important to Understand and Use It ProficientlyincludeLabel parameter passing mechanism, not just mastering a technical detail, but also the key to improving work efficiency and website quality. It enables us to:

  • Build more flexible templates:Easily customize the content of introduced modules without creating a large number of repetitive template files.
  • Improve development efficiency:Team members can develop different template fragments in parallel and seamlessly integrate them through parameter passing.
  • Optimize content updates:When the general module needs to be changed, only one template file needs to be modified, and it can be adjusted through parameters to adapt to different page requirements, greatly simplifying the content update process.
  • Promote SEO optimization:For different pages, passing customized TDK (title, keywords, description) through parameters helps enhance the search engine's understanding of the content and ranking.

In short, the Anqi CMS'sincludeTags go throughwithClauses and clear spacing delimiters provide powerful and intuitive support for passing template parameters.配合onlyKeywords, you can control the variable scope of template fragments more finely, thereby building more robust, efficient, and easy-to-maintain websites.

Common Questions (FAQ)

  1. Question: If I amincludeAttempt to access a variable that is not passed and also not defined in the parent template?withWhat will happen if a variable that is passed and also not defined in the parent template is accessed?Answer: In the Django template engine of Anqi CMS, if you try to access a variable that has neither been passed throughwithExplicitly passed clause, which is not within the current parent template scope, the variable is usually parsed asnil(Empty value). It may display as blank when directly outputted in a template, or it may be evaluated as such when performing logical judgments (such as{% if variable %})falseThis design is robust and usually does not cause the program to crash, but will produce the corresponding results based on your template logic.

  2. Question: BesidesincludeWhat are some similar template reuse mechanisms in AnQi CMS? What are the differences between them?Answer: AnQi CMS template engine also providesextendsandmacroetc. reuse mechanisms.

    • extends:Used for template inheritance, you define a basic skeleton template (parent template) that contains{% block %}{% endblock %}defined blocks. Sub templates can access{% extends '父模板路径' %}Inherit from the parent template and rewrite (override) or extend these blocks.extendsMore focused on the consistency of the overall page layout and structure.
    • macro:Similar to functions in programming languages, it allows you to define reusable code snippets and pass in parameters.macroHas its own scope and can only access variables passed in as parameters. It is more suitable for generating repetitive HTML structures, such as a generic product card or form input box.
    • include:More focused on directly inserting the content of a template file into another template, suitable for inserting independent, possibly dynamic parametered small components or local content.

  3. Question: WhenincludeDo the order of parameters matter when passing multiple parameters to a tag?Answer: No, the order of parameters inwiththe sub-clausedoes not matter.key=valueParameters are passed in the form of an array, the template engine will identify and retrieve the corresponding values according to the key name (key) rather than depending on their position in the statement. So, whether it ispageTitle="标题" pageKeywords="关键词"orpageKeywords="关键词" pageTitle="标题"The effects are all the same.