Sometimes the manual just isn’t enough!
If you encounter any issues or have questions while using Ximera, there are multiple ways to get assistance:
Email the Ximera developers who are happy to help! We can assist you with any technical or content-related questions you may have. You can reach us directly via email:
When contacting us, please include: The URL to the GitHub repository as this will allow us to directly see and interact with your code and the URL of a deployed page if applicable.
Join our Discord server by going to:
There you can ask questions and talk directly to developers.
Submit an issue on our GitHub and we’ll find it! If you have identified a bug, want to request a feature, you can make the request here:
If the Ximera Manual requires clarification, please submit an issue on our GitHub repository:
When submitting an issue, follow these steps:
- (a)
- Log in to your GitHub account. If you don’t have one, you can create an account for free at GitHub.
- (b)
- Navigate to: https://github.com/XimeraProject/ximeraManuals/issues
- (c)
- Click the “New Issue” button.
- (d)
- Provide a descriptive title and a detailed explanation of the issue or suggestion.
- (e)
- Attach any relevant files, screenshots, or links to help the team understand your report.
Community contributions are essential to Ximera’s sustainability. Ximera is an open-source project, and we welcome contributions from the community. If you have suggestions for improving the platform or this manual, feel free to fork the repository and submit a pull request on GitHub.
If you would like to contribute to the Ximera document class, we suggest the following workflow:
- (a)
- Make a Template of a testing repository like: https://github.com/ XimeraProject/ximeraFirstSteps
- (b)
- Clone your template, or work on your template in a GitHub Codespace.
- (c)
- Fork XimeraLatex.
- (d)
- Clone your fork of Ximera LaTeX into your template, and switch
to the
developmentbranch (this should be up-to-date with themasterbranch). - (e)
- In your template, rename the folder
ximeraLatexto.ximera_local. Now your template will use this version of Ximera LaTeX. - (f)
- Make your edits by either directly editing a preamble file (that
overrides the current
ximeraLatex) or withinximera.clsfound within.ximera_localdirectly. - (g)
- Once your changes work, make your changes in the
*.dtxfiles. If you developed inximera.clsdirectly, change its name toximeradev.clsso that it is not overwritten in the next step. - (h)
- Run
makeand a newximera.cls,xourse.cls,ximera.4htandxourse.4htwill be generated, overwriting any existing files in.ximera_local. - (i)
- Push changes to your fork of
ximeraLatex. It is best to make small commits, and give detailed descriptions. - (j)
- When ready, submit a pull-request from your fork.
Once your changes have been accepted via a pull-request, Ximera developers will update the branch master from the branch development.
Thank you for using Ximera. We are committed to providing high-quality tools for creating and sharing interactive mathematics content. Your feedback and questions are invaluable to us!