Comments (3)
It would be nice if PMLC help will also print information about the location of these folders and files
In the new version I've already implement a new CLI command pmlc info
. This command displays various useful information about PML, including the location of the data directory on the user's machine.
Here is an output example of the new version under construction:
App name: PML Companion
Short name: PMLC
Version: 3.0.0
Version date: 2022-03-08
Shared data dir.: C:\Users\NAME\AppData\Roaming\PMLC_3
Working dir.: C:\tests\PML\quick_test
OS name: Windows 11
Java version.: 17.0.2
you mean like if there are some user defined nodes like a third party library, i.e. that they will end up being documented in the local PML Reference Manual?
Yes, exactly.
This would mean that end users would be able to generate a single documentation file for their entire library collection.
Yes, that's the final goal.
from pml-companion.
The reference manual and user manual are both already bundled with the distribution.
They are stored in the following sub-directories of the distribution:
docs\ref_manual\index.html
docs\user_manual\index.html
However, note that the location of the manuals will change in the next version. This will be necessary because the new version will be distributed as a single standalone exe file. At first execution, the manuals will automatically be stored into a version-dependant APPDATA sub-directory, together with other files used by PML (default CSS files, etc.)
having a PMLC option to open up both docs in the browser would be a much easier way to go about it.
Something like:
pmlc userman
pmlc refman
Yes! Excellent idea. This would be much more convenient for the user.
users could build the document themselves in a few steps
This option is currently available only for the reference manual. This option will remain in the new version. The reason for allowing the user to create the reference manual (although it's available already in a specific directory) was to integrate user-defined-nodes in the reference manual (not done yet).
from pml-companion.
At first execution, the manuals will automatically be stored into a version-dependant APPDATA sub-directory, together with other files used by PML (default CSS files, etc.)
It would be nice if PMLC help will also print information about the location of these folders and files, i.e. for completeness sake. This would also be quite useful if these folder were to change in the future (e.g. their folder names, or filenames, etc.).
was to integrate user-defined-nodes in the reference manual (not done yet).
you mean like if there are some user defined nodes like a third party library, i.e. that they will end up being documented in the local PML Reference Manual? or is it just that you'll integrate those parts of the PDML documentation that deal with custom nodes?
The idea of being able to generate reference docs for custom nodes is interesting though, especially if these were distributed as some sort of reusable library — i.e. having a way to distinguish these type of reusable assets, and provide some means of documenting them, either via in-source comments or a PML document with a special naming convention that can be automatically associated as being the documentation of a user component. This would mean that end users would be able to generate a single documentation file for their entire library collection.
from pml-companion.
Related Issues (20)
- JavaScript Date function fails in user-defined node HOT 2
- Links URL and Relative Paths HOT 7
- Discrete Headings to Exclude Sections from TOC HOT 5
- Broken Tables in PML 2.3.0 HOT 3
- Problems with [text Node HOT 2
- Node Repetition via Asterisk HOT 2
- PML Docs: Add Version Info to Ref Man & Create Docs Archive HOT 5
- Why Multiple Heading IDs? HOT 4
- Fatal Conversion Error: [text Inside [title HOT 2
- Resources directory written to '?/.config' when inside Docker container HOT 2
- Resources directory written for non-action commands like help HOT 2
- PMLC v3.1.0 Segfault on Linux HOT 5
- HTML Attributes Ignored on Images HOT 4
- List Enhancements HOT 7
- CSS Option Treats Everything As CSS HOT 8
- Stylesheets Copy-&-Subfolder Prevents CSS Debugging HOT 12
- Parser Inconsistency with Quoted IDs HOT 3
- PMLC 3.1.0 Crashes on Empty [options Node HOT 2
- Delimited Text Syntax and Unbalanced Delimiters HOT 3
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from pml-companion.