You are viewing a plain text version of this content. The canonical link for it is here.
Posted to notifications@freemarker.apache.org by dd...@apache.org on 2016/01/26 23:05:21 UTC
incubator-freemarker git commit: Chinese Manual: Added copyright
headers to the XML and the CJSON. Updated CJSON. Deleted non-localized image
sources and README-like texts.
Repository: incubator-freemarker
Updated Branches:
refs/heads/2.3-gae 8bab1aabb -> 5f9292fb9
Chinese Manual: Added copyright headers to the XML and the CJSON. Updated CJSON. Deleted non-localized image sources and README-like texts.
Project: http://git-wip-us.apache.org/repos/asf/incubator-freemarker/repo
Commit: http://git-wip-us.apache.org/repos/asf/incubator-freemarker/commit/5f9292fb
Tree: http://git-wip-us.apache.org/repos/asf/incubator-freemarker/tree/5f9292fb
Diff: http://git-wip-us.apache.org/repos/asf/incubator-freemarker/diff/5f9292fb
Branch: refs/heads/2.3-gae
Commit: 5f9292fb98bfdcb000c3f0d77cc67b2d895c5da8
Parents: 8bab1aa
Author: ddekany <dd...@apache.org>
Authored: Tue Jan 26 23:04:43 2016 +0100
Committer: ddekany <dd...@apache.org>
Committed: Tue Jan 26 23:04:43 2016 +0100
----------------------------------------------------------------------
src/manual/zh_CN/book.xml | 18 ++++
src/manual/zh_CN/docgen-help/README | 2 +
src/manual/zh_CN/docgen-help/editors-readme.txt | 105 -------------------
.../zh_CN/docgen-originals/figures/README | 2 +
.../figures/model2sketch_with_alpha.png | Bin 61463 -> 0 bytes
.../figures/odg-convert-howto.txt | 24 -----
.../zh_CN/docgen-originals/figures/overview.odg | Bin 11939 -> 0 bytes
.../figures/tree_with_alpha.png | Bin 10304 -> 0 bytes
src/manual/zh_CN/docgen.cjson | 28 +++--
src/manual/zh_CN/placeholder.txt | 24 -----
10 files changed, 42 insertions(+), 161 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/incubator-freemarker/blob/5f9292fb/src/manual/zh_CN/book.xml
----------------------------------------------------------------------
diff --git a/src/manual/zh_CN/book.xml b/src/manual/zh_CN/book.xml
index f092b95..327b239 100644
--- a/src/manual/zh_CN/book.xml
+++ b/src/manual/zh_CN/book.xml
@@ -1,4 +1,22 @@
<?xml version="1.0" encoding="UTF-8"?>
+<!--
+ Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+-->
<book conformance="docgen" version="5.0" xml:lang="en"
xmlns="http://docbook.org/ns/docbook"
xmlns:xlink="http://www.w3.org/1999/xlink"
http://git-wip-us.apache.org/repos/asf/incubator-freemarker/blob/5f9292fb/src/manual/zh_CN/docgen-help/README
----------------------------------------------------------------------
diff --git a/src/manual/zh_CN/docgen-help/README b/src/manual/zh_CN/docgen-help/README
new file mode 100644
index 0000000..6ebc928
--- /dev/null
+++ b/src/manual/zh_CN/docgen-help/README
@@ -0,0 +1,2 @@
+Put the locale-specific or translated guides to editors here.
+For the non-localized guides see the similar folder of the en_US Manual.
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/incubator-freemarker/blob/5f9292fb/src/manual/zh_CN/docgen-help/editors-readme.txt
----------------------------------------------------------------------
diff --git a/src/manual/zh_CN/docgen-help/editors-readme.txt b/src/manual/zh_CN/docgen-help/editors-readme.txt
deleted file mode 100644
index 5280d97..0000000
--- a/src/manual/zh_CN/docgen-help/editors-readme.txt
+++ /dev/null
@@ -1,105 +0,0 @@
-Guide to FreeMarker Manual for Editors
-======================================
-
-Non-technical
--------------
-
-- The Template Author's Guide is for Web designers. Assume that a
- designer is not a programmer, (s)he doesn't even know what is Java.
- Forget that FM is implemented in Java when you edit the Template
- Author's Guide. Try to avoid technical writing.
-
-- In the Guide chapters, be careful not to mention things that were
- not explained earlier. The Guide chapters should be understandable
- if you read them continuously.
-
-- If you add a new topic or term, don't forget to add it to the Index.
- Also, consider adding entries for it to the Glossary.
-
-- Don't use too sophisticated English. Use basic words and grammar.
-
-
-Technical
----------
-
-- For the editing use XXE (XMLmind XML Editor), with its default XML
- *source* formatting settings (identation, max line length and like).
- You should install the "DocBook 5 for Freemarker" addon, which you can
- find inside the "docgen" top-level SVN module.
-
-- The HTML is generated with Docgen (docgen.jar), which will check some
- of the rules described here. To invoke it, issue "ant manual" from
- the root of the "freemarker" module. (Note: you may need to check out
- and build "docgen" first.)
-
-- Understand all document conventions in the Preface chapter. Note that
- all "programlisting"-s should have a "role" attribute with a value that
- is either: "template", "dataModel", "output", "metaTemplate" or
- "unspecified". (If you miss this, the XXE addon will show the
- "programlisting" in red.)
-
-- Verbatim content in flow text:
-
- * In flow text, all data object names, class names, FTL fragments,
- HTML fragments, and all other verbatim content is inside "literal"
- element.
-
- * Use replaceable element inside literal element for replaceable
- parts and meta-variables like:
- <literal<if <replaceable>condition</replaceable>></literal>
- <literal><replaceable>templateDir</replaceable>/copyright.ftl</literal>
-
-- Hierarchy:
-
- * The hierarchy should look like:
-
- book -> part -> chapter -> section -> section -> section -> section
-
- where the "part" and the "section"-s are optional.
- Instead of chapter you may have "preface" or "appendix".
-
- * Don't use "sect1", "sect2", etc. Instead nest "section"-s into each other,
- but not deeper than 3 levels.
-
- * Use "simplesect" if you want to divide up something visually, but
- you don't want those sections to appear in the ToC, or go into their own
- HTML page. "simplesect"-s can appear under all "section" nesting
- levels, and they always look the same regardless of the "section"
- nesting levels.
-
-- Lists:
-
- * When you have list where the list items are short (a few words),
- you should give spacing="compact" to the "itemizedlist" or
- "orderedlist" element.
-
- * Don't putting listings inside "para"-s. Put them between "para"-s instead.
-
-- Xrefs, id-s, links:
-
- * id-s of parts, chapters, sections and similar elements must
- contain US-ASCII lower case letters, US-ASCII numbers, and
- underscore only. id-s of parts and chapters are used as the
- filenames of HTML-s generated for that block.
- When you find out the id, deduce it from the position in the ToC
- hierarchy. The underscore is used as the separator between the path
- steps.
-
- * All other id-s must use prefix:
- - example: E.g.: id="example.foreach"
- - ref: Reference information...
- * directive: about a directive. E.g.: "ref.directive.foreach"
- * builtin
- - gloss: Term in the Glossary
- - topic: The recommended point of document in a certain topic
- * designer: for designers.
- E.g.: id="topic.designer.methodDataObject"
- * programmer: for programmers
- * or omit the secondary category if it is for everybody
- - misc: Anything doesn't fit in the above categories
-
- * When you refer to a part, chapter or section, often you should use
- xref, not link. The xreflabel attribute of the link-end should not be set;
- then it's deduced from the titles.
-
-- The "book" element must have this attribute: conformance="docgen"
http://git-wip-us.apache.org/repos/asf/incubator-freemarker/blob/5f9292fb/src/manual/zh_CN/docgen-originals/figures/README
----------------------------------------------------------------------
diff --git a/src/manual/zh_CN/docgen-originals/figures/README b/src/manual/zh_CN/docgen-originals/figures/README
new file mode 100644
index 0000000..f3a8221
--- /dev/null
+++ b/src/manual/zh_CN/docgen-originals/figures/README
@@ -0,0 +1,2 @@
+Put the translated originals (sources) of the figures used in the manual here.
+For figures that aren't translated, see the similar folder of the en_US Manual.
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/incubator-freemarker/blob/5f9292fb/src/manual/zh_CN/docgen-originals/figures/model2sketch_with_alpha.png
----------------------------------------------------------------------
diff --git a/src/manual/zh_CN/docgen-originals/figures/model2sketch_with_alpha.png b/src/manual/zh_CN/docgen-originals/figures/model2sketch_with_alpha.png
deleted file mode 100644
index ce120cc..0000000
Binary files a/src/manual/zh_CN/docgen-originals/figures/model2sketch_with_alpha.png and /dev/null differ
http://git-wip-us.apache.org/repos/asf/incubator-freemarker/blob/5f9292fb/src/manual/zh_CN/docgen-originals/figures/odg-convert-howto.txt
----------------------------------------------------------------------
diff --git a/src/manual/zh_CN/docgen-originals/figures/odg-convert-howto.txt b/src/manual/zh_CN/docgen-originals/figures/odg-convert-howto.txt
deleted file mode 100644
index 1db294c..0000000
--- a/src/manual/zh_CN/docgen-originals/figures/odg-convert-howto.txt
+++ /dev/null
@@ -1,24 +0,0 @@
-Converting to SVG:
-1. Open the ODG file with Libeoffice/OpenOffice Draw
-2. Ctrl+A to select all objects
-3. File/Export..., chose SVG format, and then tick "Selection"
-4. Check the result. If contour lines at the right and bottom edge of the
- figure are partically clipped (stroke width is halved), set a stroke with
- other than 0 for all shapes.
-
-Converting to a decent quality (though non-transparent) PNG:
-1. Open the ODG file with Libeoffice/OpenOffice Draw
-2. Export to PDF
-3. Open PDF in Adobe Acrobat Reader
-4. Go to Adobe Acrobat Reader preferences and set it to not use subpixel
- anti-aliasing, just normal anti-aliasing. They used to call this LCD vs
- Monitor mode.
-5. Zoom in/out until you get the desired size in pixels, take a
- screen shot, crop it in some image editor, save it as PNG.
-
-Converting to transparent but somewhat ugly PNG:
-1. Convert to SVG as described earlier
-2. Use Apache Batik Rasterizer command line utility like:
- $BARIK_INSTALLATION\batik-rasterizer-1.8.jar -dpi 72 -m image/png ${FIGURE}.svg
- If Batik fails (as it doesn't support all SVG features), use Inkscape.
- Of course avoid supixel anti-aliasing, as it's not device independent.
http://git-wip-us.apache.org/repos/asf/incubator-freemarker/blob/5f9292fb/src/manual/zh_CN/docgen-originals/figures/overview.odg
----------------------------------------------------------------------
diff --git a/src/manual/zh_CN/docgen-originals/figures/overview.odg b/src/manual/zh_CN/docgen-originals/figures/overview.odg
deleted file mode 100644
index 0533b7c..0000000
Binary files a/src/manual/zh_CN/docgen-originals/figures/overview.odg and /dev/null differ
http://git-wip-us.apache.org/repos/asf/incubator-freemarker/blob/5f9292fb/src/manual/zh_CN/docgen-originals/figures/tree_with_alpha.png
----------------------------------------------------------------------
diff --git a/src/manual/zh_CN/docgen-originals/figures/tree_with_alpha.png b/src/manual/zh_CN/docgen-originals/figures/tree_with_alpha.png
deleted file mode 100644
index dc4fba8..0000000
Binary files a/src/manual/zh_CN/docgen-originals/figures/tree_with_alpha.png and /dev/null differ
http://git-wip-us.apache.org/repos/asf/incubator-freemarker/blob/5f9292fb/src/manual/zh_CN/docgen.cjson
----------------------------------------------------------------------
diff --git a/src/manual/zh_CN/docgen.cjson b/src/manual/zh_CN/docgen.cjson
index 7bd3a78..ecff859 100644
--- a/src/manual/zh_CN/docgen.cjson
+++ b/src/manual/zh_CN/docgen.cjson
@@ -1,5 +1,22 @@
//charset: UTF-8
+// Licensed to the Apache Software Foundation (ASF) under one
+// or more contributor license agreements. See the NOTICE file
+// distributed with this work for additional information
+// regarding copyright ownership. The ASF licenses this file
+// to you under the Apache License, Version 2.0 (the
+// "License"); you may not use this file except in compliance
+// with the License. You may obtain a copy of the License at
+//
+// http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing,
+// software distributed under the License is distributed on an
+// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+// KIND, either express or implied. See the License for the
+// specific language governing permissions and limitations
+// under the License.
+
deployUrl: "http://freemarker.org/docs/"
onlineTrackerHTML: "docgen-misc/googleAnalytics.html"
searchKey: "014728049242975963158:8awjt03uofm"
@@ -16,8 +33,9 @@ generateEclipseTOC
removeNodesWhenOnline: [ "preface" ]
-copyrightHolder: "The FreeMarker Project"
+copyrightHolder: "The Apache Software Foundation"
copyrightStartYear: 1999
+copyrightCommentFile: "../en_US/docgen-misc/copyrightComment.txt"
seoMeta: {
"dgui_quickstart": {
@@ -42,15 +60,9 @@ olinks: {
freemarkerdownload: "http://freemarker.org/freemarkerdownload.html"
contribute: "http://freemarker.org/contribute.html"
history: "http://freemarker.org/history.html"
- what-is-freemarker: "http://freemarker.org/index.html"
+ what-is-freemarker: "http://freemarker.org/"
mailing-lists: "http://freemarker.org/mailing-lists.html"
- // Manual links:
- templateAuthorsGuide: "id:dgui_quickstart_basics"
- license: "id:app_license"
- versionHistory: "id:app_versions"
- freemarkerServlet: "id:pgui_misc_servlet"
-
// External URL-s:
onlineTemplateTester: "http://freemarker-online.kenshoo.com/"
twitter: "https://twitter.com/freemarker"
http://git-wip-us.apache.org/repos/asf/incubator-freemarker/blob/5f9292fb/src/manual/zh_CN/placeholder.txt
----------------------------------------------------------------------
diff --git a/src/manual/zh_CN/placeholder.txt b/src/manual/zh_CN/placeholder.txt
deleted file mode 100644
index a33e358..0000000
--- a/src/manual/zh_CN/placeholder.txt
+++ /dev/null
@@ -1,24 +0,0 @@
-/*
- * Licensed to the Apache Software Foundation (ASF) under one
- * or more contributor license agreements. See the NOTICE file
- * distributed with this work for additional information
- * regarding copyright ownership. The ASF licenses this file
- * to you under the Apache License, Version 2.0 (the
- * "License"); you may not use this file except in compliance
- * with the License. You may obtain a copy of the License at
- *
- * http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing,
- * software distributed under the License is distributed on an
- * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
- * KIND, either express or implied. See the License for the
- * specific language governing permissions and limitations
- * under the License.
- */
-
-Add the Chinese Manual here, then delete this file.
-You can use these to test if the Manual is generated succesfully:
-
- ant manualOffline_zh_CN
- ant manualFreemarkerOrg_zh_CN