NoTeX 1.0.0
A modern noteworthy LaTeX template
Loading...
Searching...
No Matches
notex::ProjectConfig Struct Reference

Persisted metadata for a single NoTeX project, stored as JSON in .notex/notex.json. More...

#include <notex/manager.hpp>

Public Attributes

int schema_version = 1
 Version of this on-disk schema.
std::string notex_version
std::string project_type
 "mono" or "multi"; set by init.
std::string main_file = "main.tex"
 Project's entry .tex file.
std::string installation_type
std::string theme
 Set by the theme command.
std::string bibliography_file
 Set once a bibliography exists.

Detailed Description

Persisted metadata for a single NoTeX project, stored as JSON in .notex/notex.json.

Fields that are not yet populated by anything are left as empty strings rather than std::optional, so that the schema itself does not have to change shape once something starts writing to them. The list of sections is deliberately not part of this schema: it is always derived by scanning the filesystem and the project's \subfile lines, so that sections added or removed by hand are always respected.

Definition at line 36 of file manager.hpp.

Member Data Documentation

◆ bibliography_file

std::string notex::ProjectConfig::bibliography_file

Set once a bibliography exists.

Definition at line 45 of file manager.hpp.

◆ installation_type

std::string notex::ProjectConfig::installation_type

"local" or "global"; set by install.

Definition at line 42 of file manager.hpp.

Referenced by notex::Installer::install_local(), and notex::Installer::uninstall_local().

◆ main_file

std::string notex::ProjectConfig::main_file = "main.tex"

Project's entry .tex file.

Definition at line 41 of file manager.hpp.

◆ notex_version

std::string notex::ProjectConfig::notex_version

notex version that created the project.

Definition at line 38 of file manager.hpp.

◆ project_type

std::string notex::ProjectConfig::project_type

"mono" or "multi"; set by init.

Definition at line 40 of file manager.hpp.

◆ schema_version

int notex::ProjectConfig::schema_version = 1

Version of this on-disk schema.

Definition at line 37 of file manager.hpp.

◆ theme

std::string notex::ProjectConfig::theme

Set by the theme command.

Definition at line 44 of file manager.hpp.


The documentation for this struct was generated from the following file: