From cf4bdb2969a472ecdedeb81afd0bf0089f574957 Mon Sep 17 00:00:00 2001 From: Doug Kearns Date: Thu, 27 Aug 2009 14:34:35 +1000 Subject: [PATCH] Fix help file validation errors. --- common/Makefile.doc | 18 ++++++++++-------- common/asciidoc.conf | 14 +++++++------- vimperator/locale/en-US/autocommands.txt | 2 +- vimperator/locale/en-US/buffer.txt | 2 +- vimperator/locale/en-US/developer.txt | 4 ++-- vimperator/locale/en-US/intro.txt | 10 ++++++---- vimperator/locale/en-US/map.txt | 3 ++- vimperator/locale/en-US/tutorial.txt | 10 ++++++---- vimperator/locale/en-US/xhtml11.css | 2 +- xulmus/locale/en-US/autocommands.txt | 2 +- xulmus/locale/en-US/buffer.txt | 2 +- xulmus/locale/en-US/developer.txt | 4 ++-- xulmus/locale/en-US/intro.txt | 2 +- xulmus/locale/en-US/map.txt | 3 ++- xulmus/locale/en-US/xhtml11.css | 2 +- 15 files changed, 44 insertions(+), 36 deletions(-) diff --git a/common/Makefile.doc b/common/Makefile.doc index 4750585d..3b62ed7d 100644 --- a/common/Makefile.doc +++ b/common/Makefile.doc @@ -2,17 +2,17 @@ #### configuration -ASCIIDOC = asciidoc -AWK = awk +ASCIIDOC = asciidoc +AWK = awk -LOCALE = $(shell basename `pwd`) -DOCLANG = $(shell basename `pwd` | $(AWK) -F- '{ print ($$1 ~ /^[a-z][a-z]$$/) ? $$1 : "en" }') +LOCALE = $(shell basename `pwd`) +DOCLANG = $(shell basename `pwd` | $(AWK) -F- '{ print ($$1 ~ /^[a-z][a-z]$$/) ? $$1 : "en" }') SRC_FILES = $(wildcard *.txt) FILES = $(SRC_FILES:%.txt=%.html) -DEPS = $(wildcard asciidoc.conf lang-$(DOCLANG).conf) +DEPS = $(wildcard lang-$(DOCLANG).conf) ${BASE}/asciidoc.conf $(BASE)/Makefile.doc -DOC_FILES = $(FILES) version.html +DOC_FILES = $(FILES) version.html .SILENT: @@ -50,7 +50,9 @@ check-asciidoc: @$(ASCIIDOC) --version | $(AWK) '{ exit $$2 !~ /^8\.4\./ }' || \ echo >&2 "Warning: asciidoc versions other than 8.4.x are unsupported" -version.html: ../../NEWS $(BASE)/Makefile.doc $(DEPS) +all.html: $(SRC_FILES) + +version.html: ../../NEWS $(DEPS) @echo "DOC locale/$(LOCALE)/$@" # NOTE: asciidoc doesn't source the conf file implicitly when processing stdin sed -e '1i\ @@ -60,7 +62,7 @@ heading:Version{nbsp}information[version-information]' \ /' ../../NEWS | \ ${ASCIIDOC} -f $(BASE)/asciidoc.conf -a doctitle=version.html -o version.html - -$(FILES): %.html: %.txt $(BASE)/Makefile.doc $(DEPS) +$(FILES): %.html: %.txt $(DEPS) @echo "DOC locale/$(LOCALE)/$@" $(ASCIIDOC) -f $(BASE)/asciidoc.conf -a configname=$(NAME) --unsafe -a linkcss -a quirks! -a lang=$(DOCLANG) -a doctitle="$$(basename $@)" -o $@ $< diff --git a/common/asciidoc.conf b/common/asciidoc.conf index ea8020dc..fb39c80a 100644 --- a/common/asciidoc.conf +++ b/common/asciidoc.conf @@ -33,14 +33,14 @@ email=stubenschrott@vimperator.org (?u)^(?Psection)::(?P\S*?)(\[(?P.*?)\])$=# # subsection:Title[tag1,tag2] (?u)^(?Psubsection)::(?P\S*?)(\[(?P.*?)\])$=# +# logo:[,] # FIXME: this is a bit silly +(?su)(?logo):(?P\S*?)\[(?P.*?)\]=# # help:helptext[href] (?su)(?help):(?P\S*?)\[(?P.*?)\]= -# logo:[,] # FIXME: this is a bit silly -(?su)(?logo):(?P\S*?)\[(?P.*?)\]= # FIXME: this logo/donation banner is really ugly. --djk [heading-blockmacro] -{outfile@.*(intro|all).html::
} +{outfile@.*(intro|all).html::
} @@ -77,12 +77,12 @@ email=stubenschrott@vimperator.org
<{outfile@.*all.html:h2:h1 style="border\: none"}>{target}
+[logo-blockmacro] +
+ [help-inlinemacro] {target} -[logo-inlinemacro] -
- [quotes] ||=key |=tag @@ -101,7 +101,7 @@ email=stubenschrott@vimperator.org [tags] tag=| -key=
|
+key=| option=| option2='|' command=| diff --git a/vimperator/locale/en-US/autocommands.txt b/vimperator/locale/en-US/autocommands.txt index 3d0f9ece..e47169d8 100644 --- a/vimperator/locale/en-US/autocommands.txt +++ b/vimperator/locale/en-US/autocommands.txt @@ -91,6 +91,6 @@ Enable _passthrough_ mode on *some* Google sites: Set the filetype to mail when editing email at Gmail: \{nbsp}[c]:autocmd LocationChange .* :set editor=gvim\ -f[c] + -\{nbsp}[c]:autocmd LocationChange mail\.google\.com :set editor="gvim -f -c 'set ft=mail'"[c] +\{nbsp}[c]:autocmd LocationChange mail\.google\.com :set editor="gvim -f -c $$'set ft=mail'$$"[c] // vim: set filetype=asciidoc: diff --git a/vimperator/locale/en-US/buffer.txt b/vimperator/locale/en-US/buffer.txt index 8956b14a..4ca63010 100644 --- a/vimperator/locale/en-US/buffer.txt +++ b/vimperator/locale/en-US/buffer.txt @@ -23,7 +23,7 @@ ________________________________________________________________________________ |:pa| |:pageinfo| + ||:pa[geinfo]|| ________________________________________________________________________________ -Show various page information. See [c]:help 'pageinfo'[c] for available options. +Show various page information. See [c]:help $$'pageinfo'$$[c] for available options. ________________________________________________________________________________ diff --git a/vimperator/locale/en-US/developer.txt b/vimperator/locale/en-US/developer.txt index e6a323f5..469d01d0 100644 --- a/vimperator/locale/en-US/developer.txt +++ b/vimperator/locale/en-US/developer.txt @@ -30,8 +30,8 @@ is displayed as: class="hiddentag">:help :h help -
:h[elp] {subject}

-
<F1>

+:h[elp] {subject}
+<F1>

Open help window. diff --git a/vimperator/locale/en-US/intro.txt b/vimperator/locale/en-US/intro.txt index 49ef0d96..65a67379 100644 --- a/vimperator/locale/en-US/intro.txt +++ b/vimperator/locale/en-US/intro.txt @@ -1,10 +1,12 @@ logo:[] -+++

+++ -*First there was a Navigator, then there was an Explorer. +++++++ +

+First there was a Navigator, then there was an Explorer. Later it was time for a Konqueror. Now it's time for an Imperator, the -VIMperator :)* -+++

+++ +VIMperator :) +

+++++++ heading::Introduction[intro] diff --git a/vimperator/locale/en-US/map.txt b/vimperator/locale/en-US/map.txt index a8ebcce5..48563e19 100644 --- a/vimperator/locale/en-US/map.txt +++ b/vimperator/locale/en-US/map.txt @@ -129,7 +129,8 @@ Below is an overview of which modes each map command applies to: :imap :inoremap :iunmap :imapclear - Insert mode :cmap :cnoremap :cunmap :cmapclear - Command-line mode -subsection::Key{nbsp}sequences[:<>,key-sequence] +// |<>| breaks doc validation +subsection::Key{nbsp}sequences[key-notation,key-sequence] For most keys, the key-sequence is the same as the character you see when you type that key, however there are some exceptions which allow for a much larger diff --git a/vimperator/locale/en-US/tutorial.txt b/vimperator/locale/en-US/tutorial.txt index 25158e28..fc3a7250 100644 --- a/vimperator/locale/en-US/tutorial.txt +++ b/vimperator/locale/en-US/tutorial.txt @@ -2,10 +2,12 @@ heading::Quick-start{nbsp}tutorial[tutorial] -+++
+++ -*This is a quickstart tutorial to help get new users up and running in -Vimperator. It is not intended as a full reference explaining all features.* -+++
+++ +++++++ +

+This is a quickstart tutorial to help get new users up and running in +Vimperator. It is not intended as a full reference explaining all features. +

+++++++ If you've started using Vimperator from scratch (i.e., without any customization), you should be looking at this help page in a relatively diff --git a/vimperator/locale/en-US/xhtml11.css b/vimperator/locale/en-US/xhtml11.css index e2345287..8cff8b94 100644 --- a/vimperator/locale/en-US/xhtml11.css +++ b/vimperator/locale/en-US/xhtml11.css @@ -304,7 +304,7 @@ td span.tag { padding-top: 25px !important; } -div.key { +span.key { color: rgb(255, 0, 255); /* magenta */ min-width: 120px; /* with 20px padding actually 140px */ /*padding-bottom: 5px;*/ diff --git a/xulmus/locale/en-US/autocommands.txt b/xulmus/locale/en-US/autocommands.txt index 6af6b60e..efe67988 100644 --- a/xulmus/locale/en-US/autocommands.txt +++ b/xulmus/locale/en-US/autocommands.txt @@ -100,6 +100,6 @@ Enable _passthrough_ mode on *some* Google sites: Set the filetype to mail when editing email at Gmail: \{nbsp}[c]:autocmd LocationChange .* :set editor=gvim\ -f[c] + -\{nbsp}[c]:autocmd LocationChange mail\.google\.com :set editor="gvim -f -c 'set ft=mail'"[c] +\{nbsp}[c]:autocmd LocationChange mail\.google\.com :set editor="gvim -f -c $$'set ft=mail'$$"[c] // vim: set filetype=asciidoc: diff --git a/xulmus/locale/en-US/buffer.txt b/xulmus/locale/en-US/buffer.txt index 0dfd8bd8..e5930161 100644 --- a/xulmus/locale/en-US/buffer.txt +++ b/xulmus/locale/en-US/buffer.txt @@ -23,7 +23,7 @@ ________________________________________________________________________________ |:pa| |:pageinfo| + ||:pa[geinfo]|| ________________________________________________________________________________ -Show various page information. See [c]:help 'pageinfo'[c] for available options. +Show various page information. See [c]:help $$'pageinfo'$$[c] for available options. ________________________________________________________________________________ diff --git a/xulmus/locale/en-US/developer.txt b/xulmus/locale/en-US/developer.txt index 23ae25b5..bac28572 100644 --- a/xulmus/locale/en-US/developer.txt +++ b/xulmus/locale/en-US/developer.txt @@ -30,8 +30,8 @@ is displayed as: class="hiddentag">:help :h help -
:h[elp] {subject}

-
<F1>

+:h[elp] {subject}
+<F1>

Open help window. diff --git a/xulmus/locale/en-US/intro.txt b/xulmus/locale/en-US/intro.txt index 729dea72..63c856af 100644 --- a/xulmus/locale/en-US/intro.txt +++ b/xulmus/locale/en-US/intro.txt @@ -1,4 +1,4 @@ -LOGO +logo:[] section::Introduction[intro] diff --git a/xulmus/locale/en-US/map.txt b/xulmus/locale/en-US/map.txt index 32725502..0fe64b36 100644 --- a/xulmus/locale/en-US/map.txt +++ b/xulmus/locale/en-US/map.txt @@ -141,7 +141,8 @@ Below is an overview of which modes each map command applies to: :imap :inoremap :iunmap :imapclear - Insert mode :cmap :cnoremap :cunmap :cmapclear - Command-line mode -subsection::Key{nbsp}sequences[:<>,key-sequence] +// |<>| breaks doc validation +subsection::Key{nbsp}sequences[key-notation,key-sequence] For most keys, the key-sequence is the same as the character you see when you type that key, however there are some exceptions which allow for a much larger diff --git a/xulmus/locale/en-US/xhtml11.css b/xulmus/locale/en-US/xhtml11.css index e2345287..8cff8b94 100644 --- a/xulmus/locale/en-US/xhtml11.css +++ b/xulmus/locale/en-US/xhtml11.css @@ -304,7 +304,7 @@ td span.tag { padding-top: 25px !important; } -div.key { +span.key { color: rgb(255, 0, 255); /* magenta */ min-width: 120px; /* with 20px padding actually 140px */ /*padding-bottom: 5px;*/