Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add possibility to include created plots in PDF documentation #197

Open
numeredev opened this issue Feb 29, 2024 · 0 comments
Open

Add possibility to include created plots in PDF documentation #197

numeredev opened this issue Feb 29, 2024 · 0 comments
Assignees
Labels
change Change something in an existing feature

Comments

@numeredev
Copy link
Member

DESCRIPTION

Is your change request related to a problem? Please describe.
Although it is in principle possible to include images in the PDF documentation using LaTeX commands, that is quite tedious as it requires to give the absolute path and does not allow using placeholders.

Describe the solution you'd like
Provide at least a simple doc keyword like \insertplot "FILE" "CAPTION", which will include the graphic FILE at its position using the caption CAPTION. This keyword shall not be part of the internal documentation or converted to something like [Image].

Describe possible alternatives you've considered
A clear and concise description of any alternative solutions or features you've considered, if any.

Additional context
Add any other context or screenshots about the feature request here.

(Do not write below this line)


DEVS' SECTION

ANALYSIS

(Describe, what's the issue and which changes have to be made)

IMPLEMENTATION STEPS

(see also our Wiki for implementation guidelines)

  • Implement the necessary changes in a new branch created here on GitHub
  • Test your implementation

DOCUMENTATION STEPS

(see also our Wiki for further information)

  • Update the changes log
  • Add comments to your implementation
  • Add Doxygen documentation comments
  • Create or update the documentation articles (*.NHLP and *.NDB files, if needed)
  • Update the language strings (*.NLNG files, if needed)

PULL REQUEST

  • Create a pull request for your changes
  • Fill out the template
  • Assign @numere-org/maintainers as reviewers
@numeredev numeredev added the change Change something in an existing feature label Feb 29, 2024
@numeredev numeredev self-assigned this Feb 29, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
change Change something in an existing feature
Projects
Status: New
Development

No branches or pull requests

1 participant