Skip to content

Cherry-pick: "Added Tip to Variables for using Custom Company Fields" to 5.x #627

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
adiati98 wants to merge 7 commits into
base: 5.x
Choose a base branch
from
+28 −16
Open

Cherry-pick: "Added Tip to Variables for using Custom Company Fields" to 5.x #627

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
45dcad6
Added ProTip to Variables for using Custom Company Fields
LeonOltmanns Jun 14, 2024
a101945
address vale warnings and fix format
adiati98 Jan 28, 2026
4181da8
minor wording fix
adiati98 Jan 28, 2026
eedb4b1
fix: links and rename files for consistency
adiati98 Jan 28, 2026
a520a27
fix other broken links
adiati98 Jan 28, 2026
2fa20b5
fix incorrect URl
adiati98 Jan 28, 2026
a205716
remove semicolon
adiati98 Jan 28, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 9 additions & 3 deletions docs/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -80,7 +80,13 @@
r"https://github.com/search*",
# Requires authentication.
r"https://www.maxmind.com/en/accounts/current*",
# The URLs below broken and should be replaced by working ones.
r"https://staffwww.fullcoll.edu/sedwards/Nano/NanoKeyboardCommands.html",
r"https://blog.maxmind.com/search-results*"
# 403 client error from these domains
r"https://www.maxmind.com/en/home",
r"https://www.maxmind.com/en/geolite2/signup",
r"https://support.maxmind.com/hc/en-us/search*",
r"https://dev.mysql.com/doc/refman/5.7/en/regexp.html",
# 400 client error from this domain
r"https://developers.facebook.com/products/facebook-login/",
# 403 client error from this domain
r"https://www.vtiger.com/",
]
6 changes: 6 additions & 0 deletions docs/configuration/variables.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -137,6 +137,12 @@ See :doc:`Companies</companies/companies_overview>` for more information.
* - Zip Code (Company)
- ``{contactfield=companyzipcode}``

.. tip::

**Custom Company fields**

The syntax for custom Company fields differs from core Company field syntax. You must **not** add the word "Company" in the variable and instead treat it as a ``contactfield``.
Copy link
Contributor Author

@adiati98 adiati98 Jan 28, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@RCheesley I'm trying to keep the original version (with slight wording changes). But do you think the below is clearer and hold the same meaning? If so, I'll fix this and other PRs for other branches.

Suggested change
The syntax for custom Company fields differs from core Company field syntax. You must **not** add the word "Company" in the variable and instead treat it as a ``contactfield``.
Unlike core Company fields, custom Company fields require the ``contactfield`` syntax. Don't include the word 'Company' in the variable name.


Mautic Component tokens
***********************

Expand Down
2 changes: 1 addition & 1 deletion docs/links/linux_file_folder_ownership.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,6 @@

link_name = "Linux file and folder ownership documentation"
link_text = "file and folder ownership"
link_url = "https://www.thegeekdiary.com/understanding-basic-file-permissions-and-ownership-in-linux/"
link_url = "https://www.digitalocean.com/community/tutorials/how-to-set-permissions-linux"

link.xref_links.update({link_name: (link_text, link_url)})
2 changes: 1 addition & 1 deletion docs/links/clear_cache.py → docs/links/mautic_clear_cache_docs.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,6 @@

link_name = "clearing the symfony cache"
link_text = "clearing the Symfony cache"
link_url = "https://developer.mautic.org/#cache"
link_url = "https://devdocs.mautic.org/en/5.x/components/cache.html"

link.xref_links.update({link_name: (link_text, link_url)})
2 changes: 1 addition & 1 deletion docs/links/mautic_developer_api_section.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,6 @@

link_name = "Mautic developer API"
link_text = "in the Developer Documentation"
link_url = "https://developer.mautic.org/#rest-api"
link_url = "https://devdocs.mautic.org/en/5.x/rest_api/assets.html"

link.xref_links.update({link_name: (link_text, link_url)})
2 changes: 1 addition & 1 deletion docs/links/marketplace.py → docs/links/mautic_marketplace_docs.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,6 @@

link_name = "Developer Documentation Marketplace"
link_text = "Developer Documentation Marketplace"
link_url = "https://developer.mautic.org/#marketplace"
link_url = "https://devdocs.mautic.org/en/5.x/marketplace/getting_started.html"

link.xref_links.update({link_name: (link_text, link_url)})
2 changes: 1 addition & 1 deletion docs/links/plugins_documentation.py → docs/links/mautic_plugins_documentation.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,6 @@

link_name = "Plugins developer documentation"
link_text = "Plugins developer documentation"
link_url = "https://developer.mautic.org/#plugins"
link_url = "https://devdocs.mautic.org/en/5.x/plugins/getting_started.html"

link.xref_links.update({link_name: (link_text, link_url)})
2 changes: 1 addition & 1 deletion docs/links/mautic_api_documentation.py → docs/links/mautic_reports_api_docs.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,6 @@

link_name = "Reports API documentation"
link_text = "Reports API documentation"
link_url = "https://developer.mautic.org/#reports"
link_url = "https://devdocs.mautic.org/en/5.x/rest_api/reports.html"

link.xref_links.update({link_name: (link_text, link_url)})
2 changes: 1 addition & 1 deletion docs/links/roles_api.py → docs/links/mautic_roles_api_docs.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,6 @@

link_name = "create Roles using the API"
link_text = "create Roles using the API"
link_url = "https://developer.mautic.org/#roles"
link_url = "https://devdocs.mautic.org/en/5.x/rest_api/roles.html"

link.xref_links.update({link_name: (link_text, link_url)})
2 changes: 1 addition & 1 deletion docs/links/theme_directory_structure.py → .../mautic_theme_directory_structure_docs.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,6 @@

link_name = "themes developer documentation"
link_text = "themes developer documentation"
link_url = "https://developer.mautic.org/#theme-directory-structure"
link_url = "https://devdocs.mautic.org/en/5.x/themes/getting_started.html#directory-structure"

link.xref_links.update({link_name: (link_text, link_url)})
2 changes: 1 addition & 1 deletion docs/links/theme.py → docs/links/mautic_theme_docs.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,6 @@

link_name = "create a Theme"
link_text = "create a Theme"
link_url = "https://developer.mautic.org/#themes"
link_url = "https://devdocs.mautic.org/en/5.x/themes/getting_started.html"

link.xref_links.update({link_name: (link_text, link_url)})
2 changes: 1 addition & 1 deletion docs/links/maxmind_ccpa.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,6 @@

link_name = "MaxMind website"
link_text = "MaxMind website"
link_url = "https://blog.maxmind.com/search-results?q=ccpa"
link_url = "https://support.maxmind.com/hc/en-us/search?utf8=%E2%9C%93&query=ccpa"

link.xref_links.update({link_name: (link_text, link_url)})
2 changes: 1 addition & 1 deletion docs/links/nano_kb_commands.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,6 @@

link_name = "Nano keyboard commands"
link_text = "Nano keyboard commands"
link_url = "https://staffwww.fullcoll.edu/sedwards/Nano/NanoKeyboardCommands.html"
link_url = "https://www.nano-editor.org/dist/latest/cheatsheet.html"

link.xref_links.update({link_name: (link_text, link_url)})
2 changes: 1 addition & 1 deletion docs/links/transifex.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,6 @@

link_name = "Transifex"
link_text = "Transifex"
link_url = "https://www.transifex.com/mautic/mautic/"
link_url = "https://explore.transifex.com/mautic/mautic/"

link.xref_links.update({link_name: (link_text, link_url)})
2 changes: 1 addition & 1 deletion docs/links/transifex_language_list.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,6 @@

link_name = "transifex-language-list"
link_text = "list of languages"
link_url = "https://www.transifex.com/mautic/mautic/"
link_url = "https://explore.transifex.com/mautic/mautic/"

link.xref_links.update({link_name: (link_text, link_url)})