Replies: 3 comments 11 replies
-
Additional Changes
... will change to:
|
Beta Was this translation helpful? Give feedback.
-
Your choice in being more specific in scoping might be a good one, especially if you're focusing on PML. I've intentionally kept things more generic for now. Thanks for sharing as well, it'll be interesting to come back after some time and see how the two approaches evolve. To your point though, I can see value in that for sure. I was editing some HTML earlier and wish I could jump to different nodes.
Thanks for sharing. PDML doesn't require many scopes, but I plan to experiment with dialects/vocabularies like PML and reading up on your experiences would indeed be helpful. I'm more active on the PDML discussions, but I check these sometimes for more information or to see if someone else had thoughts I'm having. Thanks @tajmone and @pml-lang, describing the
I was thinking the same thing.
I see the value in this, and your examples show what I consider natural uses of the language. I think this should be documented to make it more clear that this is possible. The current wording of the rule is black and white to me; clear, but evidently not the whole picture.
Hm.. maybe a youtube video of a workflow could be a good start; going over the capabilities, extensions, a few examples, then end with an example of a larger use of PDML, such as PML. Or reverse that order; a series of PML videos, that sprinkle in little tidbits of PDML knowledge. I've read at least two reddit threads about new markup languages, but be ready to see a larger margin of "ughhhh, another markup language" type commenters lol. |
Beta Was this translation helpful? Give feedback.
-
You're right. There are a few other features that are implemented already, but not yet documented.
Thanks for the tip. I've no experience with doing Youtube videos, therefore I was thinking more of an "Introduction to PDML" article (published on relevant sites) that focuses on advantages and shows examples of exclusive PDML features. The primary goal must be to explain why people might want to have a closer look at PDML. Then do the same for PML, focusing on technical writers, because IMO they would benefit most from PML.
Could you share the links, please? |
Beta Was this translation helpful? Give feedback.
Uh oh!
There was an error while loading. Please reload this page.
-
Upcoming Breaking Changes
The following breaking changes are planned to be implemented in the upcoming PML major version 4.0.0.
Feedback before implementing them is welcome.
Attributes Containing Text Replaced With Child-Nodes
A few nodes use attributes to define text rendered in the document.
Instead of using attributes, it is better to use child-nodes, for the following reasons:
The following nodes are affected:
link
,xref
,quote
,admon
.Node
link
Attribute
text
will be removed. The link text must be contained in the node.Hence, this code:
must be replaced by:
The text can then be formatted/styled by using inline nodes:
Node
xref
Attribute
text
will be removed. The text must be contained in the node.Moreover attribute
node_id
will be renamed toref_id
.Hence, this code:
must be replaced by:
Node
quote
Attribute
source
will be removed. A new node namedq_source
is used within nodequote
to define the source of the quote.Hence, this code:
must be replaced by:
Node
admon
Attribute
label
will be removed. A new node nameda_label
is used within nodeadmon
to define the label of the admonition.Hence, this code:
must be replaced by:
CSS_files
ParameterParameter
CSS_files
(a list of directories and/or files) is used to explicitly define the CSS files to be used in the target HTML document.When a directory is specified then all files in the directory are currently copied into the target directory, regardless of their file extension.
In the new version, only files with extension
.css
will be copied.The behavior remains unchanged if a file is specified. The file will be copied into the target directory, regardless of its extension.
This change has been discussed here.
'Text Block Syntax' Removed
The Text Block Syntax that was deprecated in version 3.1.0. will no more be supported in raw text nodes.
The following nodes are affected by this change:
code
,input
,output
,html
,table_data
.export_tags
CommandCommand
export_tags
will be renamed toexport_meta_data
.The default output file name will change from
pml_tags.json
topml_meta_data.json
.The content of the JSON file will change as follows:
pml_tags
will be renamed topml_meta
.tags
will be renamed tonodes
.GitHub Documentation Repositories Merged Into a Single Repository``
The individual repositories for PML documentation (e.g. User Manual) will be removed, and their content (including issues and discussion) will be transferred to a single
pml-website
repository.Beta Was this translation helpful? Give feedback.
All reactions