You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@isis.apache.org by da...@apache.org on 2015/04/16 09:53:34 UTC
[2/3] isis git commit: ISIS-1133: updates to documentation.
http://git-wip-us.apache.org/repos/asf/isis/blob/9ccb95ab/adocs/documentation/src/main/asciidoc/user-guide/user-guide-reference.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/user-guide/user-guide-reference.adoc b/adocs/documentation/src/main/asciidoc/user-guide/user-guide-reference.adoc
index 9d7d33b..f94a77a 100644
--- a/adocs/documentation/src/main/asciidoc/user-guide/user-guide-reference.adoc
+++ b/adocs/documentation/src/main/asciidoc/user-guide/user-guide-reference.adoc
@@ -1,31 +1,21 @@
-= User Guide: Reference
+= Reference
:Notice: 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.
:_basedir: ../
:_imagesdir: images/
-NOTE: TODO
-
-## Recognized Methods
+IMPORTANT: TODO
include::user-guide-reference-recognized-methods.adoc[leveloffset=+1]
-## Recognized Annotations
-
include::user-guide-reference-recognized-annotations.adoc[leveloffset=+1]
-## Domain Services
-
include::user-guide-reference-domain-services.adoc[leveloffset=+1]
-## Value Types
-
-include::user-guide-reference-domain-services.adoc[leveloffset=+1]
+include::user-guide-reference-value-types.adoc[leveloffset=+1]
## Applib Utility Classes
-include::user-guide-reference-domain-services.adoc[leveloffset=+1]
-
-## Convenience Superclasses
+include::user-guide-reference-applib-utility-classes.adoc[leveloffset=+1]
include::user-guide-reference-convenience-superclasses.adoc[leveloffset=+1]
http://git-wip-us.apache.org/repos/asf/isis/blob/9ccb95ab/adocs/documentation/src/main/asciidoc/user-guide/user-guide-restful-viewer.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/user-guide/user-guide-restful-viewer.adoc b/adocs/documentation/src/main/asciidoc/user-guide/user-guide-restful-viewer.adoc
index 01a9593..460c570 100644
--- a/adocs/documentation/src/main/asciidoc/user-guide/user-guide-restful-viewer.adoc
+++ b/adocs/documentation/src/main/asciidoc/user-guide/user-guide-restful-viewer.adoc
@@ -3,7 +3,7 @@
:_basedir: ../
:_imagesdir: images/
-NOTE: TODO
+IMPORTANT: TODO
## Features
http://git-wip-us.apache.org/repos/asf/isis/blob/9ccb95ab/adocs/documentation/src/main/asciidoc/user-guide/user-guide-testing.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/user-guide/user-guide-testing.adoc b/adocs/documentation/src/main/asciidoc/user-guide/user-guide-testing.adoc
index f1ab535..e4d69b5 100644
--- a/adocs/documentation/src/main/asciidoc/user-guide/user-guide-testing.adoc
+++ b/adocs/documentation/src/main/asciidoc/user-guide/user-guide-testing.adoc
@@ -1,9 +1,9 @@
-= User Guide: Testing
+= Testing
:Notice: 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.
:_basedir: ../
:_imagesdir: images/
-NOTE: TODO
+IMPORTANT: TODO
## Unit Test Support
http://git-wip-us.apache.org/repos/asf/isis/blob/9ccb95ab/adocs/documentation/src/main/asciidoc/user-guide/user-guide-troubleshooting-datanucleus-logging.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/user-guide/user-guide-troubleshooting-datanucleus-logging.adoc b/adocs/documentation/src/main/asciidoc/user-guide/user-guide-troubleshooting-datanucleus-logging.adoc
index c74c626..b6023b0 100644
--- a/adocs/documentation/src/main/asciidoc/user-guide/user-guide-troubleshooting-datanucleus-logging.adoc
+++ b/adocs/documentation/src/main/asciidoc/user-guide/user-guide-troubleshooting-datanucleus-logging.adoc
@@ -1,9 +1,9 @@
-= User Guide: How-tos: Trouble Shooting: DataNucleus Logging
+= Trouble Shooting: DataNucleus Logging
:Notice: 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.
:_basedir: ../
:_imagesdir: images/
-NOTE: TODO
+IMPORTANT: TODO
http://git-wip-us.apache.org/repos/asf/isis/blob/9ccb95ab/adocs/documentation/src/main/asciidoc/user-guide/user-guide-troubleshooting.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/user-guide/user-guide-troubleshooting.adoc b/adocs/documentation/src/main/asciidoc/user-guide/user-guide-troubleshooting.adoc
index a7365a4..b8a8c22 100644
--- a/adocs/documentation/src/main/asciidoc/user-guide/user-guide-troubleshooting.adoc
+++ b/adocs/documentation/src/main/asciidoc/user-guide/user-guide-troubleshooting.adoc
@@ -1,9 +1,9 @@
-= User Guide: How-tos: Trouble Shooting
+= Trouble Shooting
:Notice: 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.
:_basedir: ../
:_imagesdir: images/
-NOTE: TODO
+IMPORTANT: TODO
## JDO/DataNucleus Logging
http://git-wip-us.apache.org/repos/asf/isis/blob/9ccb95ab/adocs/documentation/src/main/asciidoc/user-guide/user-guide-wicket-viewer.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/user-guide/user-guide-wicket-viewer.adoc b/adocs/documentation/src/main/asciidoc/user-guide/user-guide-wicket-viewer.adoc
index bbb16ff..73fb31c 100644
--- a/adocs/documentation/src/main/asciidoc/user-guide/user-guide-wicket-viewer.adoc
+++ b/adocs/documentation/src/main/asciidoc/user-guide/user-guide-wicket-viewer.adoc
@@ -3,7 +3,7 @@
:_basedir: ../
:_imagesdir: images/
-NOTE: TODO
+IMPORTANT: TODO
## Features/end-user usage
http://git-wip-us.apache.org/repos/asf/isis/blob/9ccb95ab/adocs/documentation/src/main/asciidoc/user-guide/user-guide.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/user-guide/user-guide.adoc b/adocs/documentation/src/main/asciidoc/user-guide/user-guide.adoc
index 89865a3..7857ea4 100644
--- a/adocs/documentation/src/main/asciidoc/user-guide/user-guide.adoc
+++ b/adocs/documentation/src/main/asciidoc/user-guide/user-guide.adoc
@@ -4,57 +4,25 @@
:_imagesdir: images/
:numbered:
-## Core Concepts
-
include::user-guide-core-concepts.adoc[leveloffset=+1]
-
-## How-tos
-
include::user-guide-how-tos.adoc[leveloffset=+1]
-
-## Reference
-
include::user-guide-reference.adoc[leveloffset=+1]
-
-## Testing
-
include::user-guide-testing.adoc[leveloffset=+1]
-
-## Wicket Viewer
-
include::user-guide-wicket-viewer.adoc[leveloffset=+1]
-
-## Restful Objects Viewer
-
include::user-guide-restful-viewer.adoc[leveloffset=+1]
-
-## Configuration and Deployment
-
include::user-guide-config-and-deployment.adoc[leveloffset=+1]
-
-## Isis Addons (Modules)
-
include::user-guide-isis-addons.adoc[leveloffset=+1]
-
-## Integrating with other Systems
-
include::user-guide-integrating-with-other-systems.adoc[leveloffset=+1]
-
-## Extending
-
include::user-guide-extending.adoc[leveloffset=+1]
-
-## Troubleshooting
-
include::user-guide-troubleshooting.adoc[leveloffset=+1]
http://git-wip-us.apache.org/repos/asf/isis/blob/9ccb95ab/adocs/template/document.html.erb
----------------------------------------------------------------------
diff --git a/adocs/template/document.html.erb b/adocs/template/document.html.erb
index 8c28612..7f1201f 100644
--- a/adocs/template/document.html.erb
+++ b/adocs/template/document.html.erb
@@ -30,72 +30,37 @@
<meta http-equiv="pragma" content="no-cache" />
<meta http-equiv="expires" content="-1" />
-
- <link rel="stylesheet" href="<%= (attr :_basedir) %>css/foundation/5.5.1/foundation.css"/>
+ <link href="<%= (attr :_basedir) %>css/foundation/5.5.1/foundation.css" rel="stylesheet" />
<script src="<%= (attr :_basedir) %>js/foundation/5.5.1/vendor/modernizr.js"></script>
-
- <link href="<%= (attr :_basedir) %>css/asciidoctor/stylesheets/foundation-potion.css" rel="stylesheet">
-
+ <link href="<%= (attr :_basedir) %>css/asciidoctor/colony.css" rel="stylesheet">
<link href="<%= (attr :_basedir) %>css/font-awesome/4.3.0/css/font-awesome.min.css" rel="stylesheet">
+ <link href="<%= (attr :_basedir) %>css/github-fork-ribbon-css/0.1.1/gh-fork-ribbon.css" rel="stylesheet" />
+ <!--[if lt IE 9]>
+ <link href="<%= (attr :_basedir) %>css/github-fork-ribbon-css/0.1.1/gh-fork-ribbon.ie.css" rel="stylesheet" />
+ <![endif]-->
+
<style type="text/css">
- #forkongithub a{
- display: none;
- background:#090;
- color:#fff;
- text-decoration:none;
- font-family:arial, sans-serif;
- text-align:center;
- font-weight:bold;
- padding:5px 40px;
- font-size:1rem;
- line-height:2rem;
- position:relative;
- transition:0.5s;
- }
- #forkongithub a:hover{
- background:#0D0;
- color:#fff;
- }
- #forkongithub a::before,
- #forkongithub a::after{
- content:"";width:100%;
- display:block;
- position:fixed;
- top:1px;
- left:0;
- height:1px;
- background:#fff;
- z-index: 9999;
- }
- #forkongithub a::after{
- bottom:1px;
- top:auto;
- }
- @media screen and (min-width:768px){
- #forkongithub{
- position:fixed;
- display:block;
- top:0;
- right:0;
- width:250px;
- overflow:hidden;
- height:250px;
- z-index: 9999;
- }
- #forkongithub a{
- display:inherit;
- width:250px;
- position:fixed;
- font-size:small;
- top:40px;
- right:-60px;
- transform:rotate(45deg);
- -webkit-transform:rotate(45deg);
- -ms-transform:rotate(45deg);
- box-shadow:4px 4px 10px rgba(0,0,0,0.8);
- }
+ <%= ::Asciidoctor::Stylesheets.instance.coderay_stylesheet_data %>
+
+ pre.CodeRay code {
+ background-color: inherit;
+ border-style: none;
}
+ <style>
+
+ <style>
+ .github-fork-ribbon-wrapper.right {
+ position: fixed;
+ }
+ .github-fork-ribbon {
+ background: #090;
+ }
+ .github-fork-ribbon a:hover {
+ background:#0D0;
+ color:#fff;
+ font-size: 1.1em;
+ }
</style>
<style>
@@ -127,21 +92,30 @@
body div#toc.toc2 {
position: fixed;
left: auto;
- padding-top: 120px;
+ padding-top: 80px;
z-index: auto;
background-color: white;
border-left-color: #eee;
border-left-style: solid;
border-right: none;
+ min-height: 2000px;
+ }
+ </style>
+
+ <style>
+ footer {
+ margin-top: 1000px;
}
</style>
</head>
<body>
- <span id="forkongithub">
- <a href="https://github.com/apache/isis">Fork me on GitHub</a>
- </span>
+<div class="github-fork-ribbon-wrapper right" style="position: fixed;">
+ <div class="github-fork-ribbon">
+ <a href="https://github.com/apache/isis/fork">Fork me on GitHub</a>
+ </div>
+</div>
<div class="row">
@@ -246,8 +220,8 @@
<%= document.content %>
</div>
- <hr>
<footer>
+ <hr>
<p class="small">
Copyright © 2010~2015 The Apache Software Foundation, licensed under the Apache License, v2.0.
<br/>
@@ -259,15 +233,15 @@
<div class="large-4 medium-4 columns">
<!-- the 'hide' class is removed by Javascript -->
- <div id="toc" class="<%= attr 'toc-class', 'toc2' %> hide">
- <%= converter.convert_with_options @document, 'outline', :toclevels => 4 %>
+ <div id="toc" class="<%= attr 'toc-class', 'toc2' %>">
+ <%= converter.convert_with_options @document, 'outline', :toclevels => 6 %>
</div>
</div>
</div>
- <script src="<%= (attr :_basedir) %>js/foundation/5.5.1/vendor/jquery.js"></script>
- <script src="<%= (attr :_basedir) %>js/foundation/5.5.1/foundation.min.js"></script>
+<script src="<%= (attr :_basedir) %>js/foundation/5.5.1/vendor/jquery.js"></script>
+<script src="<%= (attr :_basedir) %>js/foundation/5.5.1/foundation.min.js"></script>
<script type="text/javascript">
@@ -312,11 +286,11 @@
var id = cur && cur.length ? cur[0].id : "";
- //console.log("id = " + id + ", lastId = " + lastId);
-
if (lastId !== id && id) {
scrollTo(id);
}
+
+ window.history.pushState({}, "", window.location.origin + window.location.pathname + "#" + id);
});
scrollTo = function(id) {
@@ -371,8 +345,6 @@
syncMenuItem = menuItems[0];
}
- $("#toc").removeClass("hide");
-
$(syncMenuItem).click();
});