rules

BibTypeRule dataclass

BibTypeRule(entry_type: str, standard_name: str = 'default', required_fields: List[str] = list(), suggested_fields: List[str] = list(), optional_fields: List[str] = list(), forbidden_fields: List[str] = list(), field_mappings: Dict[str, str] = dict(), formatting: FormattingRules = FormattingRules(), output: OutputRules = OutputRules(), version: str = '1.0')

Rules for a specific BibTeX entry type.

to_dict

to_dict() -> Dict[str, Any]

Convert to dictionary for serialization.

Source code in ures/literature/citation/rules/data_type.py

def to_dict(self) -> Dict[str, Any]:
    """Convert to dictionary for serialization."""
    return asdict(self)

OutputRules dataclass

OutputRules(field_order: List[str] = list(), conditional_fields: Dict[str, str] = dict(), required_middlewares: List[Type[BlockMiddleware]] = list(), max_authors: int = 5)

Output formatting rules.

FormattingRules dataclass

FormattingRules(year_range: tuple[int, int] = (1000, 2100), page_separator: str = '--', proceedings_style: str = 'full')

Formatting rules for bibliography entries.