What are the naming conventions or suggestions when defining a custom contact method field?

In the powerful ecosystem of Anqi CMS, the flexibility of custom contact information fields is undoubtedly a key factor in improving website operation efficiency.As an experienced website operations expert, I know that every detail can affect the overall performance of the website, and the naming convention of 'parameter name', although seemingly trivial, is actually related to the maintainability, scalability, and smoothness of team collaboration of the website content.Today, let's delve into the naming conventions and practical suggestions for defining custom contact information fields when defining them in Anqi CMS.

The value of the AnQi CMS contact information customization feature

The 'Contact Information Settings' module of AnQi CMS is designed very user-friendly, in addition to the preset contact person, phone number, email and other basic fields, it also gives the operator strong customization capabilities.This means that you can easily add more personalized contact methods such as "WhatsApp account", "Facebook homepage link", "Online customer service QQ", "Specific branch hotline", etc. based on the specific needs or marketing strategy of the enterprise.This high degree of customization ensures that your website can fully and accurately display the communication channels between the company and the users.

However, when we flexibly define these custom fields in the background, an important issue arises: how should we name these 'parameter names' to be standardized, efficient, and error-free?

Official guidance and naming core principles

According to the relevant documents of Anqi CMS, the official has given clear guidance and suggestions on the naming of "parameter names". It mentions that:The parameter name is the name provided for template calling, letters will be automatically converted to camel case, which means the first letter of each word is capitalized and there are no spaces in the middle.You can also set the parameter name in Chinese, but it is recommended to set it in English."

From this passage, we can extract several core naming principles:

1. Prefer English namingAlthough AnQi CMS allows the use of Chinese as parameter names, it is strongly recommended to use English from a long-term and technical perspective.English parameter names usually show better compatibility and stability in template parsing, cross-language environment support, and interaction with backend code.It can effectively avoid potential errors caused by character encoding or special symbol parsing issues, making your website run more stably.
2. Strictly follow CamelCase naming convention (CamelCase)This is the default rule for automatic parameter name processing in AnQiCMS, which is also the naming convention commonly followed by the Go language community (the development language of AnQiCMS).Camel case naming method refers to the practice where each word of a parameter name consists of the first letter in uppercase, and words are not separated by spaces, underscores, or hyphens.AfterSalesEmailinstead ofafter_sales_emailorafter-sales-emailEven if you do not follow it when you enter it, the system may automatically convert it, but actively following can reduce confusion and improve predictability.
3. Avoid using special characters and spaces： Except for the camel case naming method mentioned to avoid spaces, any special characters that may conflict with programming syntax (such as!@#$%^&*Avoid characters such as （）should be avoided. Punctuation should be avoided. Pure alphabetic and numeric combinations are chosen to ensure that parameter names can be correctly identified in any parsing environment.

Why are these naming conventions so important?

Follow the naming conventions, not just for the sake of 'looking good' or 'conforming to conventions', but for the actual benefits it brings in many aspects:

• Improve readability and maintainability: A clear and uniform naming style allows you and your team to quickly understand the use of each field.When the scale of a website expands or requires long-term maintenance, a good naming system can greatly reduce the cost of understanding and the difficulty of troubleshooting errors.
• Reduce errors and conflictsThe standardized naming can effectively avoid template parsing failures or data calling exceptions caused by spelling errors, inconsistent naming, or conflicts with system built-in fields.
• Promote teamworkA set of unified naming conventions is the foundation for efficient collaboration when multiple operation or development personnel manage a website.It reduced communication costs and ensured consistency in code and content logic.
• Enhance template calling efficiency: The template tags of AnQi CMS, such as{% contact with name="参数名" %}, directly depend on these parameter names. Standard naming allows you to refer to the required data with more confidence and efficiency when writing or modifying templates.

Tips for actual operation

On the Anqi CMS backend, in the 'Backend Settings' -> 'Contact Information Settings' page, when you click 'Customize Settings Parameters' and add a new entry, please directly enter the English camel case naming you have thought of according to the above specifications. For example, if you want to add 'WeChat Customer Service ID', you can name itWeChatServiceId.And the "parameter value{% contact with name="WeChatServiceId" %}This way to get its value.

In summary, defining the 'parameter name' for the custom contact information field in Anqi CMS is not just a simple text input, but also a strategic choice that needs to take into account both technical specifications and operational efficiency.Adhering to the principle of English first, camel case naming, and avoiding special characters, it will bring a more stable, more efficient, and easier to maintain content management experience to your website.

Frequently Asked Questions (FAQ)

Q1: Can the parameter name of the custom contact information field be in Chinese?A: SecureCMS allows you to set parameter names in Chinese, but from a technical perspective and based on practical experience, it is strongly recommended to use English.English parameter names better adapt to the parsing mechanism of template engines, reduce potential compatibility issues, and enhance code readability during team collaboration, especially when undergoing secondary development or cross-language deployment.

Q2: Can you use underscores or hyphens when naming parameter names? For examplecustom_phoneorcustom-phone?A: According to AnQiCMS's official recommendations and its Go language features, custom parameter names should follow the 'camelCase' naming convention, which means each word should start with an uppercase letter and not contain spaces or special symbols. The system will automatically try to convert names that do not comply with this rule, but in order to maintain consistency with the internal processing logic of the system and avoid unnecessary parsing errors, it is recommended that you actively useCustomPhoneThis form, notcustom_phoneorcustom-phone.

Q3: What if the custom parameter name I define conflicts with the built-in contact information field name (such asEmail/Cellphone) what will happen?A: Although the AnQiCMS backend interface usually avoids you creating parameter names that are exactly the same as built-in fields, in extreme cases, if there is a repetition, it may lead to confusion or overlay when the template is called.To avoid this uncertainty, it is strongly recommended that your custom parameter names be unique and not duplicate any system built-in field names.MyCompanyEmailTo ensure uniqueness, thus avoiding potential problems.