You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+4-4Lines changed: 4 additions & 4 deletions
Original file line number
Diff line number
Diff line change
@@ -5,14 +5,14 @@ All other READMEs and related materials can be found in [README/][100]. Although
5
5
## Building HTML Tidy
6
6
7
7
- For build instructions please see [README/BUILD.md][115].
8
-
8
+
9
9
## Branches and Versions
10
10
11
11
Learn about which branches are available, which branch you should use, and how HTML Tidy’s versioning scheme works.
12
12
13
13
- Learn about version numbering in [README/VERSION.md][160].
14
14
- Learn about our repository branches in [README/BRANCHES.md][110].
15
-
15
+
16
16
## Contributing and Development Guides
17
17
18
18
We gladly accept PRs! Read about some of our contribution guidelines, and check out some of the additional explanatory documents that will aid your understanding of how to accomplish certain things in HTML Tidy.
@@ -63,7 +63,7 @@ Tidy supports localization, and welcomes translations into various languages. Pl
63
63
This repository should be considered canonical for HTML Tidy as of 2015-January-15.
64
64
65
65
- This repository originally transferred from [w3c.github.com/tidy-html5][20], now redirected to the current site.
66
-
66
+
67
67
- First moved to Github from [tidy.sourceforge.net][21]. Note, this site is kept only for historic reasons, and is not now well maintained.
68
68
69
69
**Tidy is the granddaddy of HTML tools, with support for modern standards.** Have fun...
@@ -93,4 +93,4 @@ HTML Tidy and LibTidy are free and open source software with a permissive licens
Copy file name to clipboardExpand all lines: README/ATTRIBUTES.md
+2-2Lines changed: 2 additions & 2 deletions
Original file line number
Diff line number
Diff line change
@@ -14,9 +14,9 @@ So, to add a new `attribute=value`, on one or more existing tags, consists of th
14
14
1.`tidyenum.h` - Give the attribute an internal name, like `TidyAttr_XXXX`, and thus a value. Please try to keep this enumeration in alphabetical order.
15
15
16
16
2.`attrs.c` - Assign the string value of the attribute. Of course this must be unique. And then assign a `function` to verify the attribute value. There are already a considerable number of defined functions to verify specific attribute values, but maybe this new attribute requires a new function, so that should be written, and defined.
17
-
17
+
18
18
3.`attrdict.c` - If this attribute only relates to specific tags, then it should be added to their list. There are some general attributes that are allowed on every, or most tags, so this new attribute and value should be added accordingly.
19
-
19
+
20
20
4.`tags.c` - Now the new attribute will be verified for each tag it is associated with in the `tag_defs[]` table. Like for example the `<button ...>`, `{ TidyTag_BUTTON, ...` has `&TY_(W3CAttrsFor_BUTTON)[0]` assigned.
21
21
22
22
So, normally, just changing 3 files, `tidyenum.h`, `attrs.c`, and `attrdict.c`, will already adjust `tags.c` to accept a new `attribute=value` for any tag, or all tags. Simple...
4. the [xsltproc][3] tool is required to build and install the `tidy.1` man page on Unix-like platforms.
12
-
12
+
13
13
CMake comes in two forms - command line and GUI. Some installations only install one or the other, but sometimes both. The build commands below are only for command line use.
14
14
15
15
Also the actual build tools vary for each platform. But that is one of the great features of CMake, it can generate various 'native' build files. Running `cmake --help` should list the generators available on that platform. For sure one of the common ones is "Unix Makefiles", which needs autotools make installed, but many other generators are supported.
@@ -23,11 +23,11 @@ In Windows CMake offers various versions for MSVC. Again below only the command
By default cmake sets the install path to `/usr/local/bin` in Unix. If you wanted the binary in say `/usr/bin` instead, then in 2. above use `-DCMAKE_INSTALL_PREFIX=/usr`.
Copy file name to clipboardExpand all lines: README/CONTRIBUTING.md
+4-4Lines changed: 4 additions & 4 deletions
Original file line number
Diff line number
Diff line change
@@ -16,7 +16,7 @@ In either place please start with a short subject to describe the issue. If it i
16
16
- the output
17
17
- the _expected_ output
18
18
- some sample code (if an API question).
19
-
19
+
20
20
This information will make replication of your issue much simpler for us.
21
21
22
22
If you do add sample HTML input, then it can also be very helpful if that sample **passes** the W3C [validator](https://validator.w3.org/#validate_by_upload). Tidy attempts to follow all current W3C standards.
@@ -53,11 +53,11 @@ Concerning the “Tidy Code Style,” checkout [CODESTYLE.md](CODESTYLE.md), but
53
53
54
54
Item 2., SSH Key, is optional, and only required if you want to use `clone [email protected]...`. And if you generate the ssh without a `passphrase`, things like `git push` can be done without a password. Just convenience. Alternatively you can use the `HTTPS` protocol...
55
55
56
-
Concerning 5., editing and committing your changes, **generally** it is better to `commit` changes often, adding an appropriate commit message to each, like `$ git commit -m "Is. #NNN - reason for change" <file[s]>`. This also aids in the **PR** review.
56
+
Concerning 5., editing and committing your changes, **generally** it is better to `commit` changes often, adding an appropriate commit message to each, like `$ git commit -m "Is. #NNN - reason for change" <file[s]>`. This also aids in the **PR** review.
57
57
58
58
But the situation varies. Like adding say an option, which can mean several files have to be edited, where it is likely appropriate to combine a considerable number of edits into one commit. There can be no hard and fast rules on this.
59
59
60
-
Please note, if you want to change **multiple** things that don't depend on each other, use **different**`branches`, and make sure you check the `next` branch back out, before making more changes in a **new** branch name. That way we can take in each **change** separately, otherwise Github will **combine** all your branch commits into one **PR**.
60
+
Please note, if you want to change **multiple** things that don't depend on each other, use **different**`branches`, and make sure you check the `next` branch back out, before making more changes in a **new** branch name. That way we can take in each **change** separately, otherwise Github will **combine** all your branch commits into one **PR**.
61
61
62
62
See below on keeping your forks `next` fully in sync with here, called `upstream` - **this is important**.
Use folder `tools-cmd` for windows. Run `alltest.bat --help`.
88
+
Use folder `tools-cmd` for windows. Run `alltest.bat --help`.
89
89
90
90
If the `tests` shows a different exit value, or there are differences between the `expects` and `results`, these **must** be studied, and checked, very carefully. There may be cases where the **new**`results` are correct, in which case a simultaneous **PR** for the forked `tests`**must** be created to match your forked source **PR**.
0 commit comments