From d6af0c0c450f1329a2a52501195fec51ee3abf84 Mon Sep 17 00:00:00 2001 From: Bradley Sepos Date: Fri, 25 Mar 2016 18:01:22 -0400 Subject: [PATCH] template: Wrap content in article and add header and footer tags. --- build-docs | 18 +++++--- .../get-handbrake/check-for-updates.html | 9 ++++ .../get-handbrake/download-and-install.html | 9 ++++ .../get-handbrake/where-to-get-handbrake.html | 9 ++++ docs/en/latest/help/community-support.html | 9 ++++ docs/en/latest/introduction/about.html | 9 ++++ docs/en/latest/introduction/quick-start.html | 9 ++++ docs/en/latest/table-of-contents.html | 9 ++++ docs/en/latest/technical/source-formats.html | 9 ++++ docs/en/latest/workflow/adjust-quality.html | 9 ++++ docs/en/latest/workflow/open-video.html | 9 ++++ docs/en/latest/workflow/preview-settings.html | 9 ++++ docs/en/latest/workflow/select-preset.html | 9 ++++ docs/en/latest/workflow/start-encoding.html | 9 ++++ docs/license-summary.html | 9 ++++ docs/license.html | 9 ++++ docs/style/style.css | 42 +++++++++++++------ templates/mark1/document.html | 9 ++++ templates/mark1/style/style.css | 42 +++++++++++++------ 19 files changed, 214 insertions(+), 32 deletions(-) diff --git a/build-docs b/build-docs index 74ed63bc..9bddebcc 100755 --- a/build-docs +++ b/build-docs @@ -81,12 +81,18 @@ function build_source { touch "${BASE}.html" while IFS='' read TEMPLATE || [[ -n "${TEMPLATE}" ]]; do echo "${TEMPLATE//$VAR_Content/$DOCUMENT_Content}" \ - | sed -E 's:{{[ ]*meta\.language-code[ ]*}}:'"${META_Language_Code:-}"':g' \ - | sed -E 's:{{[ ]*meta\.text-encoding[ ]*}}:'"${META_Text_Encoding:-}"':g' \ - | sed -E 's:{{[ ]*meta\.authors[ ]*}}:'"${META_Authors:-}"':g' \ - | sed -E 's:{{[ ]*meta\.project[ ]*}}:'"${META_Project:-}"':g' \ - | sed -E 's:{{[ ]*meta\.title[ ]*}}:'"${META_Title:-}"':g' \ - | sed -E 's:{{[ ]*base\.relpath[ ]*}}:'"${BASE_RELPATH:-}"':g' \ + | sed -E 's|{{[ ]*meta\.title[ ]*}}|'"${META_Title:-}"'|g' \ + | sed -E 's|{{[ ]*meta\.project[ ]*}}|'"${META_Project:-}"'|g' \ + | sed -E 's|{{[ ]*meta\.project-url[ ]*}}|'"${META_Project_URL:-}"'|g' \ + | sed -E 's|{{[ ]*meta\.project-version[ ]*}}|'"${META_Project_Version:-}"'|g' \ + | sed -E 's|{{[ ]*meta\.language[ ]*}}|'"${META_Language:-}"'|g' \ + | sed -E 's|{{[ ]*meta\.language-code[ ]*}}|'"${META_Language_Code:-}"'|g' \ + | sed -E 's|{{[ ]*meta\.text-encoding[ ]*}}|'"${META_Text_Encoding:-}"'|g' \ + | sed -E 's|{{[ ]*meta\.authors[ ]*}}|'"${META_Authors:-}"'|g' \ + | sed -E 's|{{[ ]*meta\.copyright[ ]*}}|'"${META_Copyright:-}"'|g' \ + | sed -E 's|{{[ ]*meta\.license[ ]*}}|'"${META_License:-}"'|g' \ + | sed -E 's|{{[ ]*meta\.license-url[ ]*}}|'"${META_License_URL:-}"'|g' \ + | sed -E 's|{{[ ]*base\.relpath[ ]*}}|'"${BASE_RELPATH:-}"'|g' \ >> "${BASE}.html" done < "${TEMPLATE_DIR}/document.html" diff --git a/docs/en/latest/get-handbrake/check-for-updates.html b/docs/en/latest/get-handbrake/check-for-updates.html index fa8f47ee..45310055 100644 --- a/docs/en/latest/get-handbrake/check-for-updates.html +++ b/docs/en/latest/get-handbrake/check-for-updates.html @@ -10,6 +10,10 @@ +
+
+
English Docs > HandBrake Latest > Checking for updates
+

Checking for updates

HandBrake can let you know when a newer version is available, and even automatically download and install available updates.

@@ -27,5 +31,10 @@

Next steps

Continue to Opening a video.

+ +
diff --git a/docs/en/latest/get-handbrake/download-and-install.html b/docs/en/latest/get-handbrake/download-and-install.html index 6facae02..db7cf66d 100644 --- a/docs/en/latest/get-handbrake/download-and-install.html +++ b/docs/en/latest/get-handbrake/download-and-install.html @@ -10,6 +10,10 @@ +
+
+
English Docs > HandBrake Latest > Downloading and installing HandBrake
+

Downloading and installing HandBrake

HandBrake is available for Linux, OS X, and Windows, at the official HandBrake website.

@@ -64,5 +68,10 @@

These instructions are taken directly from Apple’s OS X Gatekeeper support documents. You can learn more about Gatekeeper here and here.↩

+ +
diff --git a/docs/en/latest/get-handbrake/where-to-get-handbrake.html b/docs/en/latest/get-handbrake/where-to-get-handbrake.html index 60914331..b7f12584 100644 --- a/docs/en/latest/get-handbrake/where-to-get-handbrake.html +++ b/docs/en/latest/get-handbrake/where-to-get-handbrake.html @@ -10,6 +10,10 @@ +
+
+
English Docs > HandBrake Latest > Where to get HandBrake
+

Where to get HandBrake

HandBrake releases and nightly builds

@@ -41,5 +45,10 @@

Next steps

Continue to Downloading and installing HandBrake.

+ +
diff --git a/docs/en/latest/help/community-support.html b/docs/en/latest/help/community-support.html index ec609a82..60afc848 100644 --- a/docs/en/latest/help/community-support.html +++ b/docs/en/latest/help/community-support.html @@ -10,6 +10,10 @@ +
+
+
English Docs > HandBrake Latest > Community support
+

Community support

If you run into problems using HandBrake, first take a look at this documentation’s Table of contents—the information you need may be just a click away.

@@ -39,5 +43,10 @@

Next steps

Continue to (TODO: link).

+ +
diff --git a/docs/en/latest/introduction/about.html b/docs/en/latest/introduction/about.html index 0ef77e2f..ee57627f 100644 --- a/docs/en/latest/introduction/about.html +++ b/docs/en/latest/introduction/about.html @@ -10,6 +10,10 @@ +
+
+
English Docs > HandBrake Latest > About HandBrake
+

About HandBrake

What HandBrake is

@@ -61,5 +65,10 @@

Next steps

Continue to Where to get HandBrake.

+ +
diff --git a/docs/en/latest/introduction/quick-start.html b/docs/en/latest/introduction/quick-start.html index 48cf7852..c999d970 100644 --- a/docs/en/latest/introduction/quick-start.html +++ b/docs/en/latest/introduction/quick-start.html @@ -10,6 +10,10 @@ +
+
+
English Docs > HandBrake Latest > Quick start
+

Quick start

HandBrake takes videos you already have and makes new ones that work on your mobile phone, tablet, TV media player, game console, computer, or web browser—nearly anything that supports modern video formats.

@@ -79,5 +83,10 @@

If you didn’t get a video file as expected, encountered an error, or had some other trouble, you can continue reading to learn more about how HandBrake works or jump right to Getting help.

Continue to About HandBrake.

+ +
diff --git a/docs/en/latest/table-of-contents.html b/docs/en/latest/table-of-contents.html index b2ccd22d..ca7507ad 100644 --- a/docs/en/latest/table-of-contents.html +++ b/docs/en/latest/table-of-contents.html @@ -10,6 +10,10 @@ +
+
+
English Docs > HandBrake Latest > Table of contents
+

Table of contents

Introduction

@@ -285,5 +289,10 @@
  • Advanced preferences
    • + +
    diff --git a/docs/en/latest/technical/source-formats.html b/docs/en/latest/technical/source-formats.html index 95359c9e..afb21ba0 100644 --- a/docs/en/latest/technical/source-formats.html +++ b/docs/en/latest/technical/source-formats.html @@ -10,6 +10,10 @@ +
    +
    +
    English Docs > HandBrake Latest > Source formats
    +

    Source formats

    One of HandBrake’s strengths is its ability to open a wide variety of video formats. HandBrake uses Libav under the hood and generally can open whatever Libav will, in addition to disc-based formats like DVD and Blu-ray.

    @@ -62,5 +66,10 @@

    Without special software, it is not possible to directly copy VIDEO_TS and BDMV folders from copy-protected discs.↩

    + +
    diff --git a/docs/en/latest/workflow/adjust-quality.html b/docs/en/latest/workflow/adjust-quality.html index 0115ea56..3eaf0ccb 100644 --- a/docs/en/latest/workflow/adjust-quality.html +++ b/docs/en/latest/workflow/adjust-quality.html @@ -10,6 +10,10 @@ +
    +
    +
    English Docs > HandBrake Latest > Adjusting quality
    +

    Adjusting quality

    HandBrake’s default settings and built-in Presets use a constant quality encoding method. This makes your new video look consistent from start to finish. Always use constant quality unless you have a specific reason not to.

    @@ -63,5 +67,10 @@

    Learn more about optimum viewing distances for high definition TV displays.↩

    + +
    diff --git a/docs/en/latest/workflow/open-video.html b/docs/en/latest/workflow/open-video.html index b0bdd8b4..5015658b 100644 --- a/docs/en/latest/workflow/open-video.html +++ b/docs/en/latest/workflow/open-video.html @@ -10,6 +10,10 @@ +
    +
    +
    English Docs > HandBrake Latest > Opening a video
    +

    Opening a video

    In HandBrake terms, the original video you already have is called the Source. One of HandBrake’s strengths is its ability to open Sources in a wide variety of video formats, including but not limited to:

    @@ -64,5 +68,10 @@

    HD-DVD playlists are not fully supported. Individual files/streams may work.↩

    + +
    diff --git a/docs/en/latest/workflow/preview-settings.html b/docs/en/latest/workflow/preview-settings.html index 92f40cc9..14bd51ff 100644 --- a/docs/en/latest/workflow/preview-settings.html +++ b/docs/en/latest/workflow/preview-settings.html @@ -10,6 +10,10 @@ +
    +
    +
    English Docs > HandBrake Latest > Previewing your settings
    +

    Previewing your settings

    Video encoding requires a lot of computer resources and can take awhile to complete. Exactly how long depends on a number of factors, including the duration, resolution, and complexity of your Source, and the settings for making your new video.

    @@ -61,5 +65,10 @@

    If the Preview you created was lacking in quality or otherwise not as expected, you may need to adjust quality or select a different Preset, after which you can create another Preview to see any changes.

    Once you are satisfied, continue to Starting encoding.

    + +
    diff --git a/docs/en/latest/workflow/select-preset.html b/docs/en/latest/workflow/select-preset.html index 5b6241a0..da5566cc 100644 --- a/docs/en/latest/workflow/select-preset.html +++ b/docs/en/latest/workflow/select-preset.html @@ -10,6 +10,10 @@ +
    +
    +
    English Docs > HandBrake Latest > Selecting a preset
    +

    Selecting a preset

    Presets, presets, presets.

    @@ -35,5 +39,10 @@

    Next steps

    Continue to Adjusting quality.

    + +
    diff --git a/docs/en/latest/workflow/start-encoding.html b/docs/en/latest/workflow/start-encoding.html index dea8ff67..60f76e69 100644 --- a/docs/en/latest/workflow/start-encoding.html +++ b/docs/en/latest/workflow/start-encoding.html @@ -10,6 +10,10 @@ +
    +
    +
    English Docs > HandBrake Latest > Starting encoding
    +

    Starting encoding

    Now that you’ve got all your settings just right, it’s time to make your new video!

    @@ -43,5 +47,10 @@

    If you didn’t get a video file as expected, encountered an error, or had some other trouble, you can continue reading to learn more about how HandBrake works or jump right to Getting help.

    Continue to (TODO: add link).

    + +
    diff --git a/docs/license-summary.html b/docs/license-summary.html index 41877c1c..172cc230 100644 --- a/docs/license-summary.html +++ b/docs/license-summary.html @@ -10,6 +10,10 @@ +
    +
    +
    English Docs > HandBrake Latest > License Summary
    +

    License Summary

    HandBrake Documentation (this work) is licensed under the Creative Commons Attribution-ShareAlike 4.0 International License.

    @@ -43,5 +47,10 @@

    The license prohibits application of effective technological measures, defined with reference to Article 11 of the WIPO Copyright Treaty. More info on application of effective technological measures.↩

    + +
    diff --git a/docs/license.html b/docs/license.html index 396c96bb..834dc613 100644 --- a/docs/license.html +++ b/docs/license.html @@ -10,6 +10,10 @@ +
    +
    +
    English Docs > HandBrake Latest > License
    +

    Creative Commons Attribution-ShareAlike 4.0 International Public License

    By exercising the Licensed Rights (defined below), You accept and agree to be bound by the terms and conditions of this Creative Commons Attribution-ShareAlike 4.0 International Public License (“Public License”). To the extent this Public License may be interpreted as a contract, You are granted the Licensed Rights in consideration of Your acceptance of these terms and conditions, and the Licensor grants You such rights in consideration of benefits the Licensor receives from making the Licensed Material available under these terms and conditions.

    @@ -159,5 +163,10 @@ For the avoidance of doubt, this Section 6(b) does not affect any right the Lice
  • No term or condition of this Public License will be waived and no failure to comply consented to unless expressly agreed to by the Licensor.
  • Nothing in this Public License constitutes or may be interpreted as a limitation upon, or waiver of, any privileges and immunities that apply to the Licensor or You, including from the legal processes of any jurisdiction or authority.
    • + +
    diff --git a/docs/style/style.css b/docs/style/style.css index fbfa46ed..31bd9c37 100644 --- a/docs/style/style.css +++ b/docs/style/style.css @@ -48,63 +48,79 @@ src: local('Open Sans Bold Italic'), local('OpenSans-BoldItalic'), url('../fonts/opensans-bolditalic-1.10.woff2') format('woff2'), url('../fonts/opensans-bolditalic-1.10.woff') format('woff'); } -body { - margin: 40px auto; - padding: 0 10px; +article.docs { + margin: 0 auto; + padding: 40px 150px; max-width: 650px; - color: rgb(68,68,68); - background-color: rgb(252,252,252); font-family: 'Open Sans'; font-size: 15px; line-height: 25px; } -h1, h2, h3, h4, h5, h6 { +article.docs h1, +article.docs h2, +article.docs h3, +article.docs h4, +article.docs h5, +article.docs h6 { font-family: 'Ropa Sans'; font-weight: 400; text-rendering: geometricPrecision; color: rgb(60,60,60); } -h1 { +article.docs h1 { font-size: 40px; line-height: 1; letter-spacing: -0.035em; } -h2 { +article.docs h2 { font-size: 28px; line-height: 30px; letter-spacing: -0.025em; } -h3 { +article.docs h3 { font-size: 21px; line-height: 25px; text-transform: uppercase; letter-spacing: -0.018em; } -h4 { +article.docs h4 { font-size: 19px; line-height: 20px; letter-spacing: -0.02em; } -h5 { +article.docs h5 { font-size: 17px; line-height: 20px; text-transform: uppercase; letter-spacing: -0.01em; } -h6 { +article.docs h6 { font-size: 14px; line-height: 15px; text-transform: uppercase; letter-spacing: -0.005em; } -p, body > ol, body > ul { +article.docs header .breadcrumbs { + font-size: 12px; +} + +article.docs footer p { + font-style: italic; +} + +article.docs p, +article.docs > ol, +article.docs > ul, +article.docs header .breadcrumbs, +article.docs footer p, +article.docs footer small { margin: 1.33333em 0; } diff --git a/templates/mark1/document.html b/templates/mark1/document.html index 06fa8e14..eb66f23e 100644 --- a/templates/mark1/document.html +++ b/templates/mark1/document.html @@ -10,6 +10,15 @@ +
    +
    +
    {{ meta.language }} Docs > {{ meta.project }} {{ meta.project-version }} > {{ meta.title }}
    +
    {{ document.content }} + +
    diff --git a/templates/mark1/style/style.css b/templates/mark1/style/style.css index fbfa46ed..31bd9c37 100644 --- a/templates/mark1/style/style.css +++ b/templates/mark1/style/style.css @@ -48,63 +48,79 @@ src: local('Open Sans Bold Italic'), local('OpenSans-BoldItalic'), url('../fonts/opensans-bolditalic-1.10.woff2') format('woff2'), url('../fonts/opensans-bolditalic-1.10.woff') format('woff'); } -body { - margin: 40px auto; - padding: 0 10px; +article.docs { + margin: 0 auto; + padding: 40px 150px; max-width: 650px; - color: rgb(68,68,68); - background-color: rgb(252,252,252); font-family: 'Open Sans'; font-size: 15px; line-height: 25px; } -h1, h2, h3, h4, h5, h6 { +article.docs h1, +article.docs h2, +article.docs h3, +article.docs h4, +article.docs h5, +article.docs h6 { font-family: 'Ropa Sans'; font-weight: 400; text-rendering: geometricPrecision; color: rgb(60,60,60); } -h1 { +article.docs h1 { font-size: 40px; line-height: 1; letter-spacing: -0.035em; } -h2 { +article.docs h2 { font-size: 28px; line-height: 30px; letter-spacing: -0.025em; } -h3 { +article.docs h3 { font-size: 21px; line-height: 25px; text-transform: uppercase; letter-spacing: -0.018em; } -h4 { +article.docs h4 { font-size: 19px; line-height: 20px; letter-spacing: -0.02em; } -h5 { +article.docs h5 { font-size: 17px; line-height: 20px; text-transform: uppercase; letter-spacing: -0.01em; } -h6 { +article.docs h6 { font-size: 14px; line-height: 15px; text-transform: uppercase; letter-spacing: -0.005em; } -p, body > ol, body > ul { +article.docs header .breadcrumbs { + font-size: 12px; +} + +article.docs footer p { + font-style: italic; +} + +article.docs p, +article.docs > ol, +article.docs > ul, +article.docs header .breadcrumbs, +article.docs footer p, +article.docs footer small { margin: 1.33333em 0; }