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

Documentation: explain "nested circuits" better. #38

Closed
peterb12 opened this issue Aug 18, 2017 · 4 comments
Closed

Documentation: explain "nested circuits" better. #38

peterb12 opened this issue Aug 18, 2017 · 4 comments

Comments

@peterb12
Copy link

Although I have an intuition about what this probably means, it really isn't clear from the documentation.

@hneemann
Copy link
Owner

I have updated the menu entry names and the tool tip texts. (See here)
But the main problem is, that I am not an English native speaker! :-)
If you could provide a better translation/description, I would appreciate that. :-)

@peterb12
Copy link
Author

Happy to help translate. Could you explain (in your native language is fine, I'll figure it out) what the intent is if the user selects "New nested circuit"?

My intuition is that what this means is (I'm not proposing you use this language, just confirming my understanding) "Create a new circuit (and new associated file) in this library", where "library" really means "In the same folder as the circuit I happen to be editing right now."

Is that correct?

@hneemann
Copy link
Owner

I think so. But let me explain what is going on:

Digital uses a simple approach to deal with sub circuits: If you open a circuit you can import all circuits located in the same folder or in a sub folder via the "Components->Custom" menu. Only the file name matters, not the full path. Thus you can rearrange the folder structure without breaking anything. You also can copy all the files to any other location and it still works.

But there is a problem: This only works if the root folder is known. If there is no root folder, you can't import anything.

Imagine the following situation: You are working on a project and you decided to create a new sub circuit. You can do so by clicking "File->New". But then there is no file name yet. So you can't import a file from your project you are working on. This is a confusing situation. You have to save the new empty file first to define a root folder.

Therefore there is a menu entry "File->New nested Circuit" (I just renamed it to "File->New embedded Circuit"). In this case a new editor window is opened and the root folder remains unchanged. Thus you can import all the circuits you are working on.

@hneemann
Copy link
Owner

Is in the main a duplicate of #33.

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

No branches or pull requests

2 participants