Skip to content

Template Version 2.0

Latest
Latest
Compare
Choose a tag to compare
@draldric draldric released this 24 Jan 17:28
V2.0.0
45c08ad
This commit was created on GitHub.com and signed with GitHub’s verified signature.
GPG key ID: B5690EEEBB952194
Verified
Learn about vigilant mode.

What's New in Version 2.0

Major Changes

  • Folder Restructured

    • Added New Folders.
      • Added Folder dedicated for LaTeX Files.
      • Added Folder to house the documents with the text for the Prefatory Pages.
      • Added Folder for all inclusions with subfolders:
        • Code.
        • Tables.
        • Data.
        • Images.
        • PDF's.

  • Restructured Class File (ualberta.cls)

    • Now 90% more Readable.
    • With 100% more Comments.

  • Main Document Restructuring

    • Removed Bloated Beginning Comments from over 100 lines to just over 30.
      • Kept Copyright Notice.
      • Removed "Guide" from the Comments.
        -[x] Added Guide into the Example Document.
      • Add Guide Section for Packages.
      • Add Guide Section for LaTeX Macros.
      • Add Guide Section for Theorem Environments.
      • Add Guide Section for Useful Commands.
      • Added Guide Section for Tables.
      • Add Guide Section for Including Code.
    • Added Better Document Options.
      • Add Guide Section for how to use the Document Options.
      • Updated pdfa to automatically update the *.xmpdata file with the information from the data entered.
        • Fix LaTeX warning due to ordering of packages.
      • Added saychapapp, which adds the word Chapter or Appendix in front of the number or letter for the Table of Contents.
      • Added fancyheader, which adds the current chapter and section information into the head with the page number.
    • Added \settoclevel{#} command with a corresponding comment to the document to allow easy changing of the Table of Contents Depth.
    • Added File Locations Sections and Macros
    • Added file for LaTeX Macros to be stored
    • Removed Abstract text, and moved to Prefatory Files.
      • Added Actual example for Abstract.
    • Removed Preface text, and moved to Prefatory Files.
      • Added Actual example for Preface.
    • Removed Quote text, and moved to Prefatory Files.
      • Added Actual example for Quote.
    • Removed Dedication text, and moved to Prefatory Files.
      • Added Actual example for Dedication.
    • Removed Acknowledgements text, and moved to Prefatory Files.
      • Added Actual example for Acknowledgement.
    • Removed Nomenclature text, and moved to Prefatory Files.
      • Added Actual example for Nomenclature.
    • Removed Acronyms text, and moved to Prefatory Files.
      • Added Actual example for Acronyms.
    • Removed Glossary text, and moved to Prefatory Files.
      • Added Actual example for Glossary.
    • Updated \makeabstract to smartly detect if if section is empty. If it is, it will not print the section.
    • Updated \makepreface to smartly detect if if section is empty. If it is, it will not print the section.
    • Updated \makequote, \makededication, and \makededicationandquote to smartly detect if if section is empty. If it is, it will not print the section.
    • Updated \listoftables to smartly detect if if section is empty. If it is, it will not print the section.
    • Updated \listoffigures to smartly detect if if section is empty. If it is, it will not print the section.
    • Updated \listofplates to smartly detect if if section is empty. If it is, it will not print the section.
    • Updated \listofsymbols to smartly detect if if section is empty. If it is, it will not print the section.
    • Updated \abbreviations to smartly detect if if section is empty. If it is, it will not print the section.
    • Updated \generateglossary to smartly detect if if section is empty. If it is, it will not print the section.
    • Removed all Chapters and Appendices from file and Added New ones in external files, see Chapter Updates.

Minor Changes

  • Setup Guide
    • Created a tailored setup guide, covering LaTeX installation, document structure, formatting, and best practices.
    • Emphasized University-specific formatting requirements with in-depth explanations for each step to ensure compliance.
    • Planned: Develop a quick-start checklist for beginner users to familiarize themselves with LaTeX in less than an hour.
    • Planned: Add video tutorials and interactive guides for setting up the environment, troubleshooting, and template customization.
  • In-Depth Troubleshooting and User Experience Tips
    • In Development Adding a new section on troubleshooting, highlighting solutions to common LaTeX errors (e.g., citation issues, missing packages, compile errors).
    • Planned: Create a Frequently Asked Questions (FAQ) section based on user feedback.
  • Expanded Document Formatting and Structure Sections
    • Added chapters on document structure, figure/table formatting, equations, cross-referencing, and citation management.
    • Included specific formatting guidance covering best practices for presenting technical content in figures, tables, and equations.
    • In Development Providing tips on managing citations and bibliography using BibTeX and BibLaTeX, with an emphasis on maintaining consistency and academic integrity.
    • Planned: Create template variations with department-specific styles for fields like health sciences, physics, and social sciences.
  • Streamlined LaTeX Preamble and Dependencies
    • Optimized the LaTeX preamble by removing unused packages, and reducing dependency load.
    • Added detailed comments in the code to explain each part of the setup, enabling users to customize their documents with minimal confusion.
  • Compatibility Testing and Improvements
    • Planned: Compatibility tests with additional cloud-based LaTeX platforms to support collaborative research environments.
    • Planned: Create a feedback loop to gather user-reported compatibility issues for future updates.

Compliance and Submission Support

  • University-Specific Compliance Checklist
    • Planned: Created a step-by-step submission checklist tailored to the University of Alberta's formatting and submission guidelines.
    • Planned: Add department-specific checklists for humanities, business, and health sciences to broaden template applicability.
    • Planned: Automate formatting checks for common errors (e.g., margins, spacing) to ensure users comply with university standards.
  • PDF/A Export Guide
    • Planned: Provided a detailed PDF/A export guide, ensuring compatibility for university archives and online repositories.

Cross-Referencing and Advanced Plotting

  • Improved Cross-Referencing with hyperref and cleveref
    • Integrated hyperref and cleveref packages for enhanced cross-referencing, ensuring clickable links and consistent label styling across document sections.
    • Provided customizable styling options to adapt cross-references to specific document styles.
    • Allow custom cross-reference formats for departments with unique citation requirements, like law or historical studies.
  • Advanced Plotting Capabilities with pgfplots
    • Integrated pgfplots package, allowing for complex plot types (3D, pie, scatter, and bar graphs).
    • Planned: Include sample templates for advanced data visualization (e.g., time-series, layered graphs).
    • Planned: Add sample code snippets for scientific plot types, such as error bars and multiple data overlays.
    • Planned: Include pre-configured templates for research presentation slides featuring interactive visualizations.

Installation Instructions and Tool Recommendations

  • Updated Installation Guides for Popular LaTeX Platforms
    • Added basic installation instructions for TeX Live, MiKTeX, and MacTeX on Windows, macOS, and Linux.
  • Tool and Software Recommendations
    • Listed recommended LaTeX editors, reference managers, and collaboration tools to streamline the academic workflow.
    • Suggested graphic design tools (e.g., Inkscape, GIMP) to improve the quality of images and charts in LaTeX documents.
    • Planned: Provide comparisons and feature descriptions of popular LaTeX editors.
    • Planned: Add a tool recommendations section for students.

Bug Fixes and Stability Improvements

  • Resolved Package Conflicts and Improved Stability
    • Removed unused or conflicting packages to reduce compile-time errors and improve template stability.
    • Addressed formatting inconsistencies (e.g., spacing, alignment) to ensure a professional appearance.
Assets 2
Loading