Allow to open the online manual from Qucs #1
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
so that the "online help" of each component can point to the component help page. Actually Qucs will point to the component model help, which will be a link to the first component using a particular model. Each component in the Component Reference pages has two references (labels): - an internal one, used for internal links in the html help - an external one, used by the Qucs GUI, which referes to the component model
for every component (actually, model) by using an external file with the same name as the component model. The file will be included at the end of the component description. A few examples of additional info for some components are included.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This goes together with Qucs/qucs#448.
The manual pages generation has been modified to add an additional internal reference to (almost) all components in the Component Reference page using the related component model; e.g.
component_reference.html#vccswill point to the VCCS component.Components sharing a model (e.g. PNP and NPN BJTs) have a model link to the first component only. Ideally these components should be somehow grouped together but this is not done yet.
Since a component can be in more than one Category, a separated Categories Reference page has been created to more easily see the content of each category.
The Quick Reference page is now sorted according to the Device field description alphabetical order.
I have also added the possibility to include additional information for every component (model); a reStructuredText file with the same name as the component model will be appended (if it exists) to the component description. This allows also to include internal links to other components, e.g. now at the end of the 3 Mutual Inductors components, the manual shows:
These additional info files are currently placed in a dedicated directory; in the future this might be extended to have a dedicated directory for every component: this will allow to easily add more complex things, with pictures, examples, etc.
I did not include the updated generated manual - I'll leave this to @guitorri so he can check if all this works 😁 . I was not actually sure if it should be updated, maybe it should go to a new page on GitHub, like
http://qucs.github.io/qucs-manual/develop/instead ofhttp://qucs.github.io/qucs-manual/0.0.19/