Removed unnecessary README.html (redundant).

Updated README.md for legibility. Will add deleted credits to documentation.
This commit is contained in:
Jim Derry 2015-01-31 18:09:33 +08:00
parent e2cbd9e89f
commit e112abfea2
8 changed files with 361 additions and 144 deletions

View File

@ -1,125 +0,0 @@
<!DOCTYPE html>
<html>
<head>
<meta charset="utf8">
<title>
About tidy-html5
</title>
<meta name="author"
content="geoff mclane">
<style>
body { margin: 1cm 1cm 1cm 1cm; }
li span.note { display: block; }
</style>
</head>
<body>
<h1>
HTML Tidy for HTML5
</h1>
<p>
This repo is an experimental fork of the code from <a href="http://tidy.sourceforge.net"
target="_blank">tidy.sourceforge.net</a>. This source code in this version supports
processing of HTML5 documents.
</p>
<p>
The changes for HTML5 support started from a <a href=
"http://lists.w3.org/Archives/Public/www-archive/2011Nov/0007.html"
target="_blank">patch developed by Björn Höhrmann</a>. A copy of this patch is also
maintained on this site, but naturally a LOT more has been changed in this fork.
</p>
<p>
For more information, also see <a href="http://w3c.github.com/tidy-html5/"
target="_blank">w3c.github.com/tidy-html5</a>
</p>
<h2>
Building tidy with cmake
</h2>
<p>
For all platforms, you can build and install the <code>tidy</code> command-line tool from the
source code using the following steps.
</p>
<ul>
<li>
<code>cd build/cmake</code>
</li>
<li>
<strong>Configuration and Generation</strong>
</li>
<li>
<code>cmake ../.. [-G "generator of choice"] [-DCMAKE_INSTALL_PREFIX=/install/path]</code>
</li>
<li>
<strong>Building - Compile and Link</strong>
</li>
<li>Unix: <code>make</code>
</li>
<li>Windows: <code>cmake --build . --config Release</code>
</li>
<li>
<strong>Install</strong>
</li>
<li>Unix: <code>[sudo] make install</code>
</li>
<li>Windows: <code>cmake --build . --config Release --target INSTALL</code>
</li>
</ul>
<p>
Alternatively the CMake GUI can be used. CMake options can be read from their <a href=
"http://www.cmake.org/"
target="_blank">site</a>, and/or running # cmake --help to get help, and view the
'generators' supported on your platform.
<br>
The build/cmake folder contains sample windows (batch) and unix (sh) scripts which can be
adjusted to suit your choices.
</p>
<p>
This document has been tidied using tidy5.exe, using a configuration file, tidy5.cfg containing
-
</p>
<pre>
tidy-mark: no
indent: yes
break-before-br: yes
indent-attributes: yes
vertical-space: yes
indent-spaces: 1
indent-cdata: no
wrap-asp: no
wrap-attributes: no
wrap-jste: no
wrap-php: no
wrap-script-literals: no
wrap-sections: no
tab-size: 4
show-info: no
</pre>
<p>
Using the following command
<br>
tidy5 -o README5.html -config tidy5.cfg README.html
<br>
then after checking README.html is deleted, and README5.html renamed to README.html
</p>
<p align="right">
README.html 20141205
</p>
</body>
</html>

View File

@ -1,31 +1,37 @@
# HTML Tidy with HTML5 support
This repo is a fork of the code from [w3c.github.com/tidy-html5][3], which itself
is a fork of [tidy.sourceforge.net][1].
This repository consists of the stable and development branches of HTML Tidy.
This source code in this version supports processing of HTML5 documents. The
changes for HTML5 support started from a [patch developed by Björn Höhrmann][2].
- branch **develop-\*\*\*** consists of the current development and release candidate
for **HTML Tidy**. Release Candidates can be identified with git tags.
[1]: http://tidy.sourceforge.net
[2]: http://lists.w3.org/Archives/Public/www-archive/2011Nov/0007.html
For more information, see [w3c.github.com/tidy-html5][3]
[3]: http://w3c.github.com/tidy-html5/
- branch **master** consists of the current, stable release of **HTML Tidy**.
## Build the tidy library and command line tool
1. cd build/cmake
1. `cd build/cmake`
2. cmake ../.. [-DCMAKE_INSTALL_PREFIX=/path/for/install]
2. `cmake ../.. [-DCMAKE_INSTALL_PREFIX=/path/for/install]`
3. Windows: cmake --build . --config Release
Unix/OSX: make
3. Windows: `cmake --build . --config Release`
Unix/OS X: `make`
4. Install, if desired
Windows: cmake --build . --config Release --target INSTALL
UNix/OSX: [sudo] make install
4. Install, if desired:
Windows: `cmake --build . --config Release --target INSTALL`
Unix/OS X: `[sudo] make install`
## History
This repository should be considered canonical for HTML Tidy as of 2015-January-15.
- This repository originally transferred from [w3c.github.com/tidy-html5][1].
- First moved to Github from [tidy.sourceforge.net][2].
[1]: http://w3c.github.com/tidy-html5/
[2]: http://tidy.sourceforge.net
;eof

View File

@ -0,0 +1,239 @@
// !$*UTF8*$!
{
archiveVersion = 1;
classes = {
};
objectVersion = 46;
objects = {
/* Begin PBXBuildFile section */
D03019FF1A7CAEEF00D9DCB5 /* main.c in Sources */ = {isa = PBXBuildFile; fileRef = D03019FE1A7CAEEF00D9DCB5 /* main.c */; };
/* End PBXBuildFile section */
/* Begin PBXCopyFilesBuildPhase section */
D03019F91A7CAEEF00D9DCB5 /* CopyFiles */ = {
isa = PBXCopyFilesBuildPhase;
buildActionMask = 2147483647;
dstPath = /usr/share/man/man1/;
dstSubfolderSpec = 0;
files = (
);
runOnlyForDeploymentPostprocessing = 1;
};
/* End PBXCopyFilesBuildPhase section */
/* Begin PBXFileReference section */
D03019FB1A7CAEEF00D9DCB5 /* tidy */ = {isa = PBXFileReference; explicitFileType = "compiled.mach-o.executable"; includeInIndex = 0; path = tidy; sourceTree = BUILT_PRODUCTS_DIR; };
D03019FE1A7CAEEF00D9DCB5 /* main.c */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.c; path = main.c; sourceTree = "<group>"; };
/* End PBXFileReference section */
/* Begin PBXFrameworksBuildPhase section */
D03019F81A7CAEEF00D9DCB5 /* Frameworks */ = {
isa = PBXFrameworksBuildPhase;
buildActionMask = 2147483647;
files = (
);
runOnlyForDeploymentPostprocessing = 0;
};
/* End PBXFrameworksBuildPhase section */
/* Begin PBXGroup section */
D03019F21A7CAEEF00D9DCB5 = {
isa = PBXGroup;
children = (
D03019FD1A7CAEEF00D9DCB5 /* tidy */,
D03019FC1A7CAEEF00D9DCB5 /* Products */,
);
sourceTree = "<group>";
};
D03019FC1A7CAEEF00D9DCB5 /* Products */ = {
isa = PBXGroup;
children = (
D03019FB1A7CAEEF00D9DCB5 /* tidy */,
);
name = Products;
sourceTree = "<group>";
};
D03019FD1A7CAEEF00D9DCB5 /* tidy */ = {
isa = PBXGroup;
children = (
D03019FE1A7CAEEF00D9DCB5 /* main.c */,
);
path = tidy;
sourceTree = "<group>";
};
/* End PBXGroup section */
/* Begin PBXNativeTarget section */
D03019FA1A7CAEEF00D9DCB5 /* tidy */ = {
isa = PBXNativeTarget;
buildConfigurationList = D0301A021A7CAEEF00D9DCB5 /* Build configuration list for PBXNativeTarget "tidy" */;
buildPhases = (
D03019F71A7CAEEF00D9DCB5 /* Sources */,
D03019F81A7CAEEF00D9DCB5 /* Frameworks */,
D03019F91A7CAEEF00D9DCB5 /* CopyFiles */,
);
buildRules = (
);
dependencies = (
);
name = tidy;
productName = tidy;
productReference = D03019FB1A7CAEEF00D9DCB5 /* tidy */;
productType = "com.apple.product-type.tool";
};
/* End PBXNativeTarget section */
/* Begin PBXProject section */
D03019F31A7CAEEF00D9DCB5 /* Project object */ = {
isa = PBXProject;
attributes = {
LastUpgradeCheck = 0610;
ORGANIZATIONNAME = HTACG;
TargetAttributes = {
D03019FA1A7CAEEF00D9DCB5 = {
CreatedOnToolsVersion = 6.1.1;
};
};
};
buildConfigurationList = D03019F61A7CAEEF00D9DCB5 /* Build configuration list for PBXProject "tidy" */;
compatibilityVersion = "Xcode 3.2";
developmentRegion = English;
hasScannedForEncodings = 0;
knownRegions = (
en,
);
mainGroup = D03019F21A7CAEEF00D9DCB5;
productRefGroup = D03019FC1A7CAEEF00D9DCB5 /* Products */;
projectDirPath = "";
projectRoot = "";
targets = (
D03019FA1A7CAEEF00D9DCB5 /* tidy */,
);
};
/* End PBXProject section */
/* Begin PBXSourcesBuildPhase section */
D03019F71A7CAEEF00D9DCB5 /* Sources */ = {
isa = PBXSourcesBuildPhase;
buildActionMask = 2147483647;
files = (
D03019FF1A7CAEEF00D9DCB5 /* main.c in Sources */,
);
runOnlyForDeploymentPostprocessing = 0;
};
/* End PBXSourcesBuildPhase section */
/* Begin XCBuildConfiguration section */
D0301A001A7CAEEF00D9DCB5 /* Debug */ = {
isa = XCBuildConfiguration;
buildSettings = {
ALWAYS_SEARCH_USER_PATHS = NO;
CLANG_CXX_LANGUAGE_STANDARD = "gnu++0x";
CLANG_CXX_LIBRARY = "libc++";
CLANG_ENABLE_MODULES = YES;
CLANG_ENABLE_OBJC_ARC = YES;
CLANG_WARN_BOOL_CONVERSION = YES;
CLANG_WARN_CONSTANT_CONVERSION = YES;
CLANG_WARN_DIRECT_OBJC_ISA_USAGE = YES_ERROR;
CLANG_WARN_EMPTY_BODY = YES;
CLANG_WARN_ENUM_CONVERSION = YES;
CLANG_WARN_INT_CONVERSION = YES;
CLANG_WARN_OBJC_ROOT_CLASS = YES_ERROR;
CLANG_WARN_UNREACHABLE_CODE = YES;
CLANG_WARN__DUPLICATE_METHOD_MATCH = YES;
COPY_PHASE_STRIP = NO;
ENABLE_STRICT_OBJC_MSGSEND = YES;
GCC_C_LANGUAGE_STANDARD = gnu99;
GCC_DYNAMIC_NO_PIC = NO;
GCC_OPTIMIZATION_LEVEL = 0;
GCC_PREPROCESSOR_DEFINITIONS = (
"DEBUG=1",
"$(inherited)",
);
GCC_SYMBOLS_PRIVATE_EXTERN = NO;
GCC_WARN_64_TO_32_BIT_CONVERSION = YES;
GCC_WARN_ABOUT_RETURN_TYPE = YES_ERROR;
GCC_WARN_UNDECLARED_SELECTOR = YES;
GCC_WARN_UNINITIALIZED_AUTOS = YES_AGGRESSIVE;
GCC_WARN_UNUSED_FUNCTION = YES;
GCC_WARN_UNUSED_VARIABLE = YES;
MACOSX_DEPLOYMENT_TARGET = 10.10;
MTL_ENABLE_DEBUG_INFO = YES;
ONLY_ACTIVE_ARCH = YES;
SDKROOT = macosx;
};
name = Debug;
};
D0301A011A7CAEEF00D9DCB5 /* Release */ = {
isa = XCBuildConfiguration;
buildSettings = {
ALWAYS_SEARCH_USER_PATHS = NO;
CLANG_CXX_LANGUAGE_STANDARD = "gnu++0x";
CLANG_CXX_LIBRARY = "libc++";
CLANG_ENABLE_MODULES = YES;
CLANG_ENABLE_OBJC_ARC = YES;
CLANG_WARN_BOOL_CONVERSION = YES;
CLANG_WARN_CONSTANT_CONVERSION = YES;
CLANG_WARN_DIRECT_OBJC_ISA_USAGE = YES_ERROR;
CLANG_WARN_EMPTY_BODY = YES;
CLANG_WARN_ENUM_CONVERSION = YES;
CLANG_WARN_INT_CONVERSION = YES;
CLANG_WARN_OBJC_ROOT_CLASS = YES_ERROR;
CLANG_WARN_UNREACHABLE_CODE = YES;
CLANG_WARN__DUPLICATE_METHOD_MATCH = YES;
COPY_PHASE_STRIP = YES;
DEBUG_INFORMATION_FORMAT = "dwarf-with-dsym";
ENABLE_NS_ASSERTIONS = NO;
ENABLE_STRICT_OBJC_MSGSEND = YES;
GCC_C_LANGUAGE_STANDARD = gnu99;
GCC_WARN_64_TO_32_BIT_CONVERSION = YES;
GCC_WARN_ABOUT_RETURN_TYPE = YES_ERROR;
GCC_WARN_UNDECLARED_SELECTOR = YES;
GCC_WARN_UNINITIALIZED_AUTOS = YES_AGGRESSIVE;
GCC_WARN_UNUSED_FUNCTION = YES;
GCC_WARN_UNUSED_VARIABLE = YES;
MACOSX_DEPLOYMENT_TARGET = 10.10;
MTL_ENABLE_DEBUG_INFO = NO;
SDKROOT = macosx;
};
name = Release;
};
D0301A031A7CAEEF00D9DCB5 /* Debug */ = {
isa = XCBuildConfiguration;
buildSettings = {
PRODUCT_NAME = "$(TARGET_NAME)";
};
name = Debug;
};
D0301A041A7CAEEF00D9DCB5 /* Release */ = {
isa = XCBuildConfiguration;
buildSettings = {
PRODUCT_NAME = "$(TARGET_NAME)";
};
name = Release;
};
/* End XCBuildConfiguration section */
/* Begin XCConfigurationList section */
D03019F61A7CAEEF00D9DCB5 /* Build configuration list for PBXProject "tidy" */ = {
isa = XCConfigurationList;
buildConfigurations = (
D0301A001A7CAEEF00D9DCB5 /* Debug */,
D0301A011A7CAEEF00D9DCB5 /* Release */,
);
defaultConfigurationIsVisible = 0;
defaultConfigurationName = Release;
};
D0301A021A7CAEEF00D9DCB5 /* Build configuration list for PBXNativeTarget "tidy" */ = {
isa = XCConfigurationList;
buildConfigurations = (
D0301A031A7CAEEF00D9DCB5 /* Debug */,
D0301A041A7CAEEF00D9DCB5 /* Release */,
);
defaultConfigurationIsVisible = 0;
};
/* End XCConfigurationList section */
};
rootObject = D03019F31A7CAEEF00D9DCB5 /* Project object */;
}

View File

@ -0,0 +1,7 @@
<?xml version="1.0" encoding="UTF-8"?>
<Workspace
version = "1.0">
<FileRef
location = "self:tidy.xcodeproj">
</FileRef>
</Workspace>

View File

@ -0,0 +1,43 @@
<?xml version="1.0" encoding="UTF-8"?>
<Scheme
LastUpgradeVersion = "0610"
version = "1.3">
<BuildAction
parallelizeBuildables = "YES"
buildImplicitDependencies = "YES">
</BuildAction>
<TestAction
selectedDebuggerIdentifier = "Xcode.DebuggerFoundation.Debugger.LLDB"
selectedLauncherIdentifier = "Xcode.DebuggerFoundation.Launcher.LLDB"
shouldUseLaunchSchemeArgsEnv = "YES"
buildConfiguration = "Debug">
<Testables>
</Testables>
</TestAction>
<LaunchAction
selectedDebuggerIdentifier = "Xcode.DebuggerFoundation.Debugger.LLDB"
selectedLauncherIdentifier = "Xcode.DebuggerFoundation.Launcher.LLDB"
launchStyle = "0"
useCustomWorkingDirectory = "NO"
buildConfiguration = "Debug"
ignoresPersistentStateOnLaunch = "NO"
debugDocumentVersioning = "YES"
allowLocationSimulation = "YES">
<AdditionalOptions>
</AdditionalOptions>
</LaunchAction>
<ProfileAction
shouldUseLaunchSchemeArgsEnv = "YES"
savedToolIdentifier = ""
useCustomWorkingDirectory = "NO"
buildConfiguration = "Release"
debugDocumentVersioning = "YES">
</ProfileAction>
<AnalyzeAction
buildConfiguration = "Debug">
</AnalyzeAction>
<ArchiveAction
buildConfiguration = "Release"
revealArchiveInOrganizer = "YES">
</ArchiveAction>
</Scheme>

View File

@ -0,0 +1,28 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
<plist version="1.0">
<dict>
<key>CFBundleDevelopmentRegion</key>
<string>en</string>
<key>CFBundleExecutable</key>
<string>$(EXECUTABLE_NAME)</string>
<key>CFBundleIdentifier</key>
<string>org.htacg.$(PRODUCT_NAME:rfc1034identifier)</string>
<key>CFBundleInfoDictionaryVersion</key>
<string>6.0</string>
<key>CFBundleName</key>
<string>$(PRODUCT_NAME)</string>
<key>CFBundlePackageType</key>
<string>FMWK</string>
<key>CFBundleShortVersionString</key>
<string>1.0</string>
<key>CFBundleSignature</key>
<string>????</string>
<key>CFBundleVersion</key>
<string>$(CURRENT_PROJECT_VERSION)</string>
<key>NSHumanReadableCopyright</key>
<string>Copyright © 2015 HTACG. All rights reserved.</string>
<key>NSPrincipalClass</key>
<string></string>
</dict>
</plist>

View File

@ -0,0 +1,19 @@
//
// tidylib.h
// tidylib
//
// Created by Jim Derry on 1/31/15.
// Copyright (c) 2015 HTACG. All rights reserved.
//
#import <Cocoa/Cocoa.h>
//! Project version number for tidylib.
FOUNDATION_EXPORT double tidylibVersionNumber;
//! Project version string for tidylib.
FOUNDATION_EXPORT const unsigned char tidylibVersionString[];
// In this header, you should import all the public headers of your framework using statements like #import <tidylib/PublicHeader.h>