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 \expandableinput #1679

Open
wants to merge 5 commits into
base: develop
Choose a base branch
from
Open

Add \expandableinput #1679

wants to merge 5 commits into from

Conversation

josephwright
Copy link
Member

READ ME FIRST: Please understand that in most cases we will not be able to merge a pull request because there are a lot of internal activities needed when updating the LaTeX2e sources. If you have a code suggestion please discuss it with the team first.

Internal housekeeping

Status of pull request

  • Feedback wanted
  • Under development
  • Ready to merge

Checklist of required changes before merge will be approved

  • [n/a] Test file(s) added (straight copy of expl3 function, so covered there)
  • Version and date string updated in changed source files
  • Relevant \changes entries in source included
  • Relevant changes.txt updated
  • Rollback provided (if necessary)?
  • ltnewsX.tex (and/or latexchanges.tex) updated

Copy link
Member

@FrankMittelbach FrankMittelbach left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

approved with some editorial comments + question on the name

@@ -6,6 +6,10 @@ to completeness or accuracy and it contains some references to files that are
not part of the distribution.
================================================================================

2025-01-26 Joseph Wright <[email protected]>
* ltexpl.dtx, usrguide.tex
Add \expandableinput
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There was the suggestion to use \ExpandableInput, not sure which is better or if there should/could be adifferent name

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I wasn't sure if the name suggestion was all-lower or CamelCase - as this feels like a document command ...

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Are "document commands" the CamelCase ones?

@@ -549,4 +549,26 @@
%<latexrelease>\EndIncludeInRelease
% \end{macrocode}
%
% \begin{macro}{\expandableinput}
% \changes{v1.3i}{2025/02/26}{Added document level name for \cs{file_input_raw:n} (gh/514)}
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

if it is called raw here then perhaps \rawinput might be a better choice on the document level.

Copy link
Member Author

@josephwright josephwright Feb 26, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Was my initial thinking, but I wanted to see how it looked to others - and we had said 'expandable input' as a name (capitalisation not specified!)

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

"expandable" seems to make more sense than "rawl, does it not?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Oops: should be "raw" !

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

As we discussed in the team meeting, getting general users to understand when they might need something expandable is hard - so I don't think there is a perfect name. I can live with \expandableinput, \ExpandableInput or \rawinput (or some others - things like \untrackedinput or \lowlevelinput would also make some sense). Basically we have to pick something :)

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think I'd prefer \ExpandableInput (camel case like \InputIfFileExists) \UntrackedInput would also work.

Copy link
Contributor

@car222222 car222222 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

A few additional thoughts/questions.

Comment on lines 1326 to 1327
\cs{expandableinput} is available: this skips recording the file name and any
file hooks, but otherwise behaves like \cs{input}. In particular, it still uses
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Does this wording mean/imply that "file hooks are recorded".
If so, what does this mean?
If not, then this needs rewording.

@@ -549,4 +549,26 @@
%<latexrelease>\EndIncludeInRelease
% \end{macrocode}
%
% \begin{macro}{\expandableinput}
% \changes{v1.3i}{2025/02/26}{Added document level name for \cs{file_input_raw:n} (gh/514)}
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

"expandable" seems to make more sense than "rawl, does it not?

Copy link
Member

@davidcarlisle davidcarlisle left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Approving modulo ongoing discussion on the name. I left a comment already on that, although it's only a mild preference in any case.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Expandable \input (possibly with file lookup and hooks)
4 participants