From 3d2223d696d4fae9ea4a096c281b0b1c69315a99 Mon Sep 17 00:00:00 2001 From: tajmone Date: Thu, 14 Jul 2022 10:50:28 +0200 Subject: [PATCH 1/5] EditorConfig Settings Improve repository settings to enforce consistent code styles across different OSs and editors by adding EditorConfig rules and tweaking Git configurations: * New `.editorconfig` and `.gitattributes` configuration files to enforce consistent code style rules for: * Repository configuration files. * Plain-text and LICENSE files. * Shell and batch scripts. * Markdown document. * PML documents. * Add to `.gitignore` new rules to cover common OSs and application temporary files that are likely to occur on end users machines. These settings will reduce noise in commits and PRs by avoiding spurious whitespace changes enforced by custom editor settings (conversion of spaces to tabs, etc.) ending up in new commits and pull requests, restricting them to actual contents changes. --- .editorconfig | 79 ++++++++++++++++++++++++++++++++++++++++++++++++++ .gitattributes | 23 +++++++++++++++ .gitignore | 38 ++++++++++++++++++++++++ 3 files changed, 140 insertions(+) create mode 100644 .editorconfig create mode 100644 .gitattributes diff --git a/.editorconfig b/.editorconfig new file mode 100644 index 0000000..43b7523 --- /dev/null +++ b/.editorconfig @@ -0,0 +1,79 @@ +root = true + + +## PML Sources +############## +[*.pml] +charset = utf-8 +end_of_line = unset +indent_style = space +indent_size = 4 +insert_final_newline = true +trim_trailing_whitespace = true + + +## Repository Configurations +############################ +[.{git*,editorconfig}] +indent_style = space +indent_size = unset +end_of_line = lf +charset = utf-8 +trim_trailing_whitespace = true +insert_final_newline = true + +[.gitmodules] +indent_style = tab + +[.gitkeep] +insert_final_newline = false + + +## Shell Scripts +################ +[*.sh] +end_of_line = lf +indent_style = tab +indent_size = unset +charset = utf-8 +trim_trailing_whitespace = true +insert_final_newline = true + + +## Batch Scripts +################ +[*.{bat,cmd}] +indent_style = tab +indent_size = unset +end_of_line = crlf +charset = utf-8 +trim_trailing_whitespace = true +insert_final_newline = true + + +## Markdown GFM +############### +[*.md] +indent_style = space +indent_size = unset +end_of_line = unset +charset = utf-8 +trim_trailing_whitespace = true +insert_final_newline = true + +## Plain-Text Files +################### +[*.txt] +indent_style = space +indent_size = unset +end_of_line = unset +trim_trailing_whitespace = true +insert_final_newline = true + +[{LICENSE,README}] +indent_size = unset +indent_style = space +end_of_line = unset +trim_trailing_whitespace = true +insert_final_newline = true + diff --git a/.gitattributes b/.gitattributes new file mode 100644 index 0000000..1b14dbc --- /dev/null +++ b/.gitattributes @@ -0,0 +1,23 @@ +* text=auto + +## Repository Configuration +########################### +.editorconfig text eol=lf +.travis.yml text eol=lf +.gitattributes text eol=lf +.gitconfig text eol=lf +.gitignore text eol=lf +.gitmodules text eol=lf + +## Documentation Files +###################### +*.md text +*.pml text linguist-language=PML +*.txt text +LICENSE text + +## Scripts +########## +*.bat text eol=crlf +*.com text eol=crlf +*.sh text eol=lf diff --git a/.gitignore b/.gitignore index eeccd56..16b350b 100644 --- a/.gitignore +++ b/.gitignore @@ -7,3 +7,41 @@ # Directories and files starting with NOGIT_ **/NOGIT_* + +############################ +## COMMON IGNORE PATTERNS ## +############################ + +## Apps Local Settings & Temp Files +################################### + +# Chrome's debug logs for local HTML pages: +debug.log + +# Links and URLs: +*.lnk +*.url + +## Linux +######## +*~ +.directory +.fuse_hidden* +.nfs* +.Trash-* + +## macOS +######## +*.DS_Store +._* +.AppleDouble +.LSOverride +Icon + +## Windows +########## +Thumbs.db +ehthumbs.db +ehthumbs_vista.db +Desktop.ini +.BIN/ From 4b926e9f7004ddcc79afabdf6058bb1c6b25076a Mon Sep 17 00:00:00 2001 From: Christian Neumanns Date: Fri, 15 Jul 2022 14:17:04 +0700 Subject: [PATCH 2/5] new CLI syntax p2h --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 9c2b975..93f3053 100644 --- a/README.md +++ b/README.md @@ -5,7 +5,7 @@ This repository contains the PML markup code used to create the [PML Changelog]( ## Create an HTML Version You can create an HTML version of the changelog like this: -- If not done already, [install](https://www.pml-lang.dev/downloads/install.html) the _PML Campanion_ +- If not done already, [install](https://www.pml-lang.dev/downloads/install.html) the _PML Companion_ - Create a local copy of this repository - Open a terminal in the root directory of your local repository - Execute the following OS command: From 907bdbb03ef172ad51f0ed24afe1335f69a04103 Mon Sep 17 00:00:00 2001 From: tajmone Date: Fri, 15 Jul 2022 10:03:40 +0200 Subject: [PATCH 3/5] Enforce Code Styles Consistency * Apply cosmetic tweaks to all source files that failed to pass EditorConfig styles consistency validation. * `README.md`: * Fix some markdown formatting errors. * Polish a couple of sentences. * Convert inline-links to reference labels placed at the end of the document, and add descriptive title text to be show on link hovering. --- README.md | 28 ++++++++++++++++++------- input/text/index.pml | 2 +- input/text/version_1.1.0_2021-01-14.pml | 6 +++--- input/text/version_1.3.0_2021-03-09.pml | 6 +++--- input/text/version_1.4.0_2021-04-16.pml | 4 ++-- input/text/version_2.0.0_2021-09-03.pml | 14 ++++++------- input/text/version_2.1.0_2021-09-09.pml | 2 +- input/text/version_2.2.0_2021-12-14.pml | 4 ++-- input/text/version_2.3.0_2022-02-11.pml | 6 +++--- input/text/version_3.0.0_2022-07-xx.pml | 10 ++++----- 10 files changed, 47 insertions(+), 35 deletions(-) diff --git a/README.md b/README.md index 93f3053..6a54674 100644 --- a/README.md +++ b/README.md @@ -1,17 +1,29 @@ # PML Changelog -This repository contains the PML markup code used to create the [PML Changelog](https://www.pml-lang.dev/docs/changelog/index.html). +This repository contains the PML markup code used to create the [PML Changelog]. ## Create an HTML Version -You can create an HTML version of the changelog like this: -- If not done already, [install](https://www.pml-lang.dev/downloads/install.html) the _PML Companion_ -- Create a local copy of this repository -- Open a terminal in the root directory of your local repository +To build an HTML version of the Changelog from this source repository: + +- If you haven't already done so, [install the _PML Companion_]. +- Create a local copy of this repository. +- Open a terminal in the root directory of your local repository. - Execute the following OS command: - - `pmlc p2h input/text/index.pml` + + pmlc p2h input/text/index.pml + ## More Info -For more information about PML please visit its [website](https://www.pml-lang.dev). \ No newline at end of file +For more information about PML, please visit the [PML website]. + + + +[PML website]: https://www.pml-lang.dev "Visit the PML website" +[PML Changelog]: https://www.pml-lang.dev/docs/changelog/index.html "View the online PML Changelog" +[install the _PML Companion_]: https://www.pml-lang.dev/downloads/install.html "Go to PMLC download page" + + diff --git a/input/text/index.pml b/input/text/index.pml index 9070806..1511d35 100644 --- a/input/text/index.pml +++ b/input/text/index.pml @@ -28,4 +28,4 @@ [u:ins_file path=version_1.3.0_2021-03-09.pml] [u:ins_file path=version_1.2.0_2021-02-10.pml] [u:ins_file path=version_1.1.0_2021-01-14.pml] -] \ No newline at end of file +] diff --git a/input/text/version_1.1.0_2021-01-14.pml b/input/text/version_1.1.0_2021-01-14.pml index b585e23..dc783e2 100644 --- a/input/text/version_1.1.0_2021-01-14.pml +++ b/input/text/version_1.1.0_2021-01-14.pml @@ -10,7 +10,7 @@ ] [el [c table]: A table layout composed of rows and columns. - + Besides just text, each cell in the table can have complex content, including nested tables. Conceptually similar to a HTML table. ] [el @@ -35,7 +35,7 @@ ] [ch [title New Command Line Arguments] - + Added command line arguments [c HTML_header] and [c HTML_footer] to the [i PML to HTML Converter]. Allows you to: [list [el Provide a custom HTML header/footer for each document, or generate only the HTML body code (no header/footer).] @@ -43,4 +43,4 @@ ] ] ] -] \ No newline at end of file +] diff --git a/input/text/version_1.3.0_2021-03-09.pml b/input/text/version_1.3.0_2021-03-09.pml index e2fd4bc..59555d1 100644 --- a/input/text/version_1.3.0_2021-03-09.pml +++ b/input/text/version_1.3.0_2021-03-09.pml @@ -7,7 +7,7 @@ The tag's open/close symbols have changed from [c {}] to [c \[\]] Example: - + Old version: [c {i great}] New version: [c \[i great\]] @@ -42,7 +42,7 @@ Attribute [c TOC_title] has been added to node [c document] It defines the title displayed for the table of contents. - + The default value is "Table of Contents". ] @@ -60,7 +60,7 @@ [list [el The Javascript code for expanding/collapsing the table of contents has been removed. - + The HTML [c
] tag is used instead. ] diff --git a/input/text/version_1.4.0_2021-04-16.pml b/input/text/version_1.4.0_2021-04-16.pml index cd19614..48ed0ae 100644 --- a/input/text/version_1.4.0_2021-04-16.pml +++ b/input/text/version_1.4.0_2021-04-16.pml @@ -26,7 +26,7 @@ ] [ch [title Bug Fixes] - + The table of contents is now displayed correctly on devices with small screens. ] -] \ No newline at end of file +] diff --git a/input/text/version_2.0.0_2021-09-03.pml b/input/text/version_2.0.0_2021-09-03.pml index a6a98c4..6eebe90 100644 --- a/input/text/version_2.0.0_2021-09-03.pml +++ b/input/text/version_2.0.0_2021-09-03.pml @@ -54,7 +54,7 @@ For all other nodes, the new [c header] node (see below) should be used instead of the old [c title] attribute. Example: - + Old code: [code [el (title = "List element header") @@ -84,7 +84,7 @@ Attribute values that contain spaces must be enclosed in quotes. Example: [c() path = "name with spaces.png"] - + For more information please refer to the [link url=https://www.pml-lang.dev/docs/user_manual/index.html#lenient_parsing text="user manual"]. ] ] @@ -123,7 +123,7 @@ [code [!ins-file path=sub-chapter.pml] code] - + For more information please refer to the [link url=https://www.pml-lang.dev/docs/user_manual/index.html#file_splitting text="user manual"] [note @@ -143,9 +143,9 @@ [list [el New parameter [c open_file_cmd] for command [c convert]. - + This argument enables you to automatically open an editor for the first file in which an error was detected. - + For more information, type the following command in a terminal, and look for parameter [c open_file_cmd]: [input pmlc command_info -command convert @@ -161,7 +161,7 @@ [list [el [c title]: A title for a chapter (can include markup, included in the table of contents) - + This node replaces the chapter's [c title] [i attribute], which is no more supported. ] [el @@ -225,4 +225,4 @@ ] ] ] -] \ No newline at end of file +] diff --git a/input/text/version_2.1.0_2021-09-09.pml b/input/text/version_2.1.0_2021-09-09.pml index 08e9fbe..64fff05 100644 --- a/input/text/version_2.1.0_2021-09-09.pml +++ b/input/text/version_2.1.0_2021-09-09.pml @@ -15,4 +15,4 @@ ] ] ] -] \ No newline at end of file +] diff --git a/input/text/version_2.2.0_2021-12-14.pml b/input/text/version_2.2.0_2021-12-14.pml index 8b7457e..6547fd1 100644 --- a/input/text/version_2.2.0_2021-12-14.pml +++ b/input/text/version_2.2.0_2021-12-14.pml @@ -7,7 +7,7 @@ For more information please refer to chapter [link url=https://www.pml-lang.dev/docs/advanced_features/index.html#user_defined_nodes text="User-Defined Nodes"]. ] - + [el Unicode escape sequences above FFFF are now supported. This is useful to insert emoticons and some Asian characters. @@ -30,4 +30,4 @@ [el When Unicode characters above [c FFFF] are inserted into a PML document with copy/paste, they are now correctly written into the HTML target file.] ] ] -] \ No newline at end of file +] diff --git a/input/text/version_2.3.0_2022-02-11.pml b/input/text/version_2.3.0_2022-02-11.pml index 5a0f566..f5b06a6 100644 --- a/input/text/version_2.3.0_2022-02-11.pml +++ b/input/text/version_2.3.0_2022-02-11.pml @@ -7,7 +7,7 @@ Script nodes enable you to embed source code in a PML document, and execute it when the document is parsed. For more information please refer to [link url=https://www.pml-lang.dev/docs/advanced_features/index.html#script_nodes text="Script Nodes"]. ] - + [el Node [c table_data]: Besides using a comma or tab as cell separator, a vertical bar ([c |]) or a semicolon ([c ;]) can now also be used. ] @@ -26,10 +26,10 @@ ] The old syntax will no more be supported in a future version. ] - + [el The method to define user-defined-nodes will probably change in the future, as explained [link url=https://www.pml-lang.dev/docs/advanced_features/index.html#UDN_how text=here]. ] ] ] -] \ No newline at end of file +] diff --git a/input/text/version_3.0.0_2022-07-xx.pml b/input/text/version_3.0.0_2022-07-xx.pml index f0fd114..d65b407 100644 --- a/input/text/version_3.0.0_2022-07-xx.pml +++ b/input/text/version_3.0.0_2022-07-xx.pml @@ -4,7 +4,7 @@ The tool has been completely rewritten in Java (PPL is no longer used). Some features are therefore no longer available, some will be added again later. - + However, there are only 2 minor changes related to the PML [i syntax]: the [c !] symbol and the [c caption] attribute are no longer supported, as explained below. Before deciding to upgrade to version 3.0, have a look at the changes described below. @@ -17,7 +17,7 @@ Please refer to the [link url=[u:get pml_docs_url]commands_manual/index.html text="Commands Reference Manual"] to see the updated list of commands and arguments. Most important breaking changes: - + [list [el The [c convert] command has been renamed to [c PML_to_HTML] (shortcut: [c p2h]) and is used as follows: @@ -64,7 +64,7 @@ [el The following two fields have been removed from the [c pml_tags.json] file (created by the [c export_tags] command): [c default_attribute_id] and [c closing_tag]. - + The [c position] field has been added to attributes as a replacement for [c default_attribute_id], which is more versatile for future improvements. ] ] @@ -110,7 +110,7 @@ [el Semantic node validation is now implemented (but not yet applied to all nodes). - + For example, [c list] nodes can only contain [c el] nodes, and each [c el] node must be a child of a [c list] node. ] @@ -128,4 +128,4 @@ All known bugs have been fixed. ] -] \ No newline at end of file +] From 7cada305d6bc86f2c3bf9b41f74c941f70ba20e5 Mon Sep 17 00:00:00 2001 From: Christian Neumanns Date: Mon, 25 Jul 2022 09:00:07 +0700 Subject: [PATCH 4/5] update date changed --- input/text/index.pml | 2 +- input/text/version_3.0.0_2022-07-xx.pml | 10 +++++----- qwe.rtf | 1 - 3 files changed, 6 insertions(+), 7 deletions(-) delete mode 100644 qwe.rtf diff --git a/input/text/index.pml b/input/text/index.pml index 9070806..1511d35 100644 --- a/input/text/index.pml +++ b/input/text/index.pml @@ -28,4 +28,4 @@ [u:ins_file path=version_1.3.0_2021-03-09.pml] [u:ins_file path=version_1.2.0_2021-02-10.pml] [u:ins_file path=version_1.1.0_2021-01-14.pml] -] \ No newline at end of file +] diff --git a/input/text/version_3.0.0_2022-07-xx.pml b/input/text/version_3.0.0_2022-07-xx.pml index f0fd114..d65b407 100644 --- a/input/text/version_3.0.0_2022-07-xx.pml +++ b/input/text/version_3.0.0_2022-07-xx.pml @@ -4,7 +4,7 @@ The tool has been completely rewritten in Java (PPL is no longer used). Some features are therefore no longer available, some will be added again later. - + However, there are only 2 minor changes related to the PML [i syntax]: the [c !] symbol and the [c caption] attribute are no longer supported, as explained below. Before deciding to upgrade to version 3.0, have a look at the changes described below. @@ -17,7 +17,7 @@ Please refer to the [link url=[u:get pml_docs_url]commands_manual/index.html text="Commands Reference Manual"] to see the updated list of commands and arguments. Most important breaking changes: - + [list [el The [c convert] command has been renamed to [c PML_to_HTML] (shortcut: [c p2h]) and is used as follows: @@ -64,7 +64,7 @@ [el The following two fields have been removed from the [c pml_tags.json] file (created by the [c export_tags] command): [c default_attribute_id] and [c closing_tag]. - + The [c position] field has been added to attributes as a replacement for [c default_attribute_id], which is more versatile for future improvements. ] ] @@ -110,7 +110,7 @@ [el Semantic node validation is now implemented (but not yet applied to all nodes). - + For example, [c list] nodes can only contain [c el] nodes, and each [c el] node must be a child of a [c list] node. ] @@ -128,4 +128,4 @@ All known bugs have been fixed. ] -] \ No newline at end of file +] diff --git a/qwe.rtf b/qwe.rtf deleted file mode 100644 index a597887..0000000 --- a/qwe.rtf +++ /dev/null @@ -1 +0,0 @@ -{\rtf1} From 0ea1aa66fc6cfd2cddeffe36f4cc07a8b0750f2c Mon Sep 17 00:00:00 2001 From: Christian Neumanns Date: Mon, 25 Jul 2022 09:27:03 +0700 Subject: [PATCH 5/5] added file VERSION --- VERSION | 1 + 1 file changed, 1 insertion(+) create mode 100644 VERSION diff --git a/VERSION b/VERSION new file mode 100644 index 0000000..56fea8a --- /dev/null +++ b/VERSION @@ -0,0 +1 @@ +3.0.0 \ No newline at end of file