cocopp.captions

module documentation

Provides basic functionality for creating figure and table captions.

In particular, a replace functionality is provided that takes a raw caption text and replaces certain !!KEYWORDS!! with the corresponding values, depending on the current settings (genericsettings, testbedsettings, ...).

Function	`get_best_ert_text`	Undocumented
Function	`get_light_brown_line_text`	Undocumented
Function	`get_nblow`	Undocumented
Function	`get_nbup`	Undocumented
Function	`get_ppfigs_ftarget`	Undocumented
Function	`get_reference_algorithm_text`	Undocumented
Function	`replace`	Replaces all !!KEYWORDS!! in the text as specified in replace_dict.
Variable	`replace_dict`	Undocumented
Variable	`replace_dict_html`	Undocumented
Variable	`tohtml`	Undocumented
Variable	`ynormalize_by_dimension`	Undocumented

def get_best_ert_text(): ¶

Undocumented

def get_light_brown_line_text(testbedname): ¶

Undocumented

def get_nblow(): ¶

Undocumented

def get_nbup(): ¶

Undocumented

def get_ppfigs_ftarget(): ¶

Undocumented

def get_reference_algorithm_text(best_algorithm_mandatory=True): ¶

Undocumented

def replace(text, html=False): ¶

Replaces all !!KEYWORDS!! in the text as specified in replace_dict.

If html==True, some translation is done before and after the actual replacement in order to deal with HTML-specific codings.

replace_dict = ¶

Undocumented

replace_dict_html = ¶

Undocumented

tohtml: bool = ¶

Undocumented

ynormalize_by_dimension: bool = ¶

Undocumented