README files are not shown on the summary page by default

Change-Id: I421a6b8f8c8eaa5d34b7629858de76fc96458cd3

diff --git a/releases.moxie b/releases.moxie
index a3b5ee4b974f70cd2057b2f151c6719e0438ef17..d66dba668dc3f9e2296f5cef9cd29f2a9697efbc 100644 (file)
--- a/releases.moxie
+++ b/releases.moxie
@@ -25,6 +25,7 @@ r20: {
        - Change the WAR baseFolder context parameter to a JNDI env-entry to improve enterprise deployments
        - Removed internal Gitblit ref exclusions in the upload pack
        - Removed "show readme" setting in favor of automatic detection
+       - README files are not shown on the summary page by default, this can be changed with web.summaryShowReadme
        - Support plain text, markdown, confluence, mediawiki, textile, tracwiki, or twiki "readme" files
        - Determine best commit id (e.g. "master") for the tree and docs pages and use that in links
        - By default GO will now bind to all interfaces for both http and https connectors.  This simplifies setup for first-time users.        
@@ -54,6 +55,7 @@ r20: {
        - { name: 'git.mirrorPeriod', defaultValue: '30 mins' }
        - { name: 'web.commitMessageRenderer', defaultValue: 'plain' }
        - { name: 'web.showBranchGraph', defaultValue: 'true' }
+       - { name: 'web.summaryShowReadme', defaultValue: 'false' }
        - { name: 'server.redirectToHttpsPort', defaultValue: 'true' }
     contributors:
        - James Moger

diff --git a/src/main/distrib/data/gitblit.properties b/src/main/distrib/data/gitblit.properties
index 2823c4de2ea0172163080525c11ee411a90fed97..92427e5191ca4262858a8bd35804d8416c1a535c 100644 (file)
--- a/src/main/distrib/data/gitblit.properties
+++ b/src/main/distrib/data/gitblit.properties
@@ -1007,6 +1007,11 @@ web.summaryCommitCount = 16
 # SINCE 0.5.0\r
 web.summaryRefsCount = 5\r
 \r
+# Show a README file, if available, on the summary page.\r
+#\r
+# SINCE 1.4.0\r
+web.summaryShowReadme = false\r
+\r
 # The number of items to show on a page before showing the first, prev, next\r
 # pagination links.  A default of 50 is used for any invalid value.\r
 #\r
@@ -1025,6 +1030,16 @@ web.overviewReflogCount = 5
 # SINCE 1.3.0\r
 web.reflogChangesPerPage = 10\r
 \r
+# Specify the names of documents in the root of your repository to be displayed\r
+# in tabs on your repository docs page.  If the name is not found in the root\r
+# then no tab is added.  The order specified is the order displayed.  Do not\r
+# specify a file extension as the aggregation of markup extensions + txt are used\r
+# in the search algorithm.\r
+#\r
+# SPACE-DELIMITED\r
+# SINCE 1.4.0\r
+web.documents = readme home index changelog contributing submitting_patches copying license notice authors\r
+\r
 # Registered file extensions to ignore during Lucene indexing\r
 #\r
 # SPACE-DELIMITED\r

diff --git a/src/main/java/com/gitblit/wicket/pages/SummaryPage.html b/src/main/java/com/gitblit/wicket/pages/SummaryPage.html
index 69cd390392d0662d998cdea2b55f727e31075468..42c59c483b5135550f7435fc101c1b120c32e892 100644 (file)
--- a/src/main/java/com/gitblit/wicket/pages/SummaryPage.html
+++ b/src/main/java/com/gitblit/wicket/pages/SummaryPage.html
@@ -54,7 +54,7 @@
                        <i style="vertical-align: middle;" class="icon-book"></i>\r
                        <span style="font-weight:bold;vertical-align:middle;" wicket:id="readmeFile"></span>\r
                </div>\r
-               <div style="border:1px solid #ddd;border-radius: 0 0 3px 3px;padding: 20px;">\r
+               <div style="border:1px solid #ddd;border-radius: 0 0 3px 3px;padding: 15px 20px;">\r
                        <div wicket:id="readmeContent"></div>\r
                </div>\r
        </wicket:fragment>      \r

diff --git a/src/main/java/com/gitblit/wicket/pages/SummaryPage.java b/src/main/java/com/gitblit/wicket/pages/SummaryPage.java
index 872f038cc22e24b543add54e7e82133d765ca9df..6f9d3a4490cd0da469b3827063f9c6aad6196a2e 100644 (file)
--- a/src/main/java/com/gitblit/wicket/pages/SummaryPage.java
+++ b/src/main/java/com/gitblit/wicket/pages/SummaryPage.java
@@ -138,18 +138,24 @@ public class SummaryPage extends RepositoryPage {
                add(new TagsPanel("tagsPanel", repositoryName, r, numberRefs).hideIfEmpty());\r
                add(new BranchesPanel("branchesPanel", getRepositoryModel(), r, numberRefs, false).hideIfEmpty());\r
 \r
-               RevCommit head = JGitUtils.getCommit(r, null);\r
-               MarkupProcessor processor = new MarkupProcessor(GitBlit.getSettings());\r
-               MarkupDocument markupDoc = processor.parseReadme(r, repositoryName, getBestCommitId(head));\r
-               if (markupDoc.markup == null) {\r
-                       add(new Label("readme").setVisible(false));\r
+               if (GitBlit.getBoolean(Keys.web.summaryShowReadme, false)) {\r
+                       // show a readme on the summary page\r
+                       RevCommit head = JGitUtils.getCommit(r, null);\r
+                       MarkupProcessor processor = new MarkupProcessor(GitBlit.getSettings());\r
+                       MarkupDocument markupDoc = processor.parseReadme(r, repositoryName, getBestCommitId(head));\r
+                       if (markupDoc == null || markupDoc.markup == null) {\r
+                               add(new Label("readme").setVisible(false));\r
+                       } else {\r
+                               Fragment fragment = new Fragment("readme", MarkupSyntax.PLAIN.equals(markupDoc.syntax) ? "plaintextPanel" : "markdownPanel", this);\r
+                               fragment.add(new Label("readmeFile", markupDoc.documentPath));\r
+                               // Add the html to the page\r
+                               Component content = new Label("readmeContent", markupDoc.html).setEscapeModelStrings(false);\r
+                               fragment.add(content.setVisible(!StringUtils.isEmpty(markupDoc.html)));\r
+                               add(fragment);\r
+                       }\r
                } else {\r
-                       Fragment fragment = new Fragment("readme", MarkupSyntax.PLAIN.equals(markupDoc.syntax) ? "plaintextPanel" : "markdownPanel", this);\r
-                       fragment.add(new Label("readmeFile", markupDoc.documentPath));\r
-                       // Add the html to the page\r
-                       Component content = new Label("readmeContent", markupDoc.html).setEscapeModelStrings(false);\r
-                       fragment.add(content.setVisible(!StringUtils.isEmpty(markupDoc.html)));\r
-                       add(fragment);\r
+                       // global, no readme on summary page\r
+                       add(new Label("readme").setVisible(false));\r
                }\r
 \r
                // Display an activity line graph\r