Commenting guide (1477d30b) · Commits · extjs / jsduck

template/app/controller/Comments.js

+6 −9

Original line number	Diff line number	Diff line
		@@ -65,18 +65,9 @@ Ext.define('Docs.controller.Comments', {
		delegate: delegate[0]
		});
		}, this);
		},

		afterload: function() {
		Docs.view.Comments.renderHoverMenuMeta()
		}
		},

		'classoverview toolbar hovermenubutton': {
		afterrender: function(cmp) {
		// console.log("Button rendered")
		}
		},
		'classoverview toolbar': {
		afterrender: function(cmp) {
		cmp.el.addListener('click', function() {
		@@ -87,6 +78,12 @@ Ext.define('Docs.controller.Comments', {
		delegate: '.comment-btn'
		});
		}
		},

		'hovermenu': {
		viewready : function(cmp) {
		Docs.view.Comments.renderHoverMenuMeta(cmp.el)
		}
		}
		});

template/app/view/Comments.js

+43 −39

Original line number	Diff line number	Diff line
		@@ -11,7 +11,7 @@ Ext.define('Docs.view.Comments', {
		'<a href="#" class="name expandComments">View {[values.num == 1 ? "1 comment" : values.num + " comments"]}</a>',
		'</tpl>',
		'<tpl if="num == 0">',
		'<a href="#" class="name expandComments">No comments</a>',
		'<a href="#" class="name expandComments">No comments. Click to add</a>',
		'</tpl>',
		'</div>'
		];
		@@ -83,22 +83,48 @@ Ext.define('Docs.view.Comments', {
		'<input type="submit" class="newCommentSubmit" value="Post comment" />',
		'</div>',
		'<div class="commentGuideTxt" style="display: none">',
		'<h4>Commenting Guide</h4>',
		'<ul>',
		'<li>Comments should be an <strong>extension</strong> of the documentation.</li>',
		'<li>For any <em>questions</em> about code or usage, please use the <a href="http://www.sencha.com/forum" target="_blank">Forum</a>.</li>',
		'<li>Comments may be edited or deleted at any time by a moderator.</li>',
		'<li>Comments will be formatted using the Markdown syntax:',
		'<ul>',
		'<li>Code snippets should be indented with 4 spaces</li>',
		'<li>Unordered list items should start with a dash, <code> - like this</code></li>',
		'<li>Ordered list items should start with a number, <code> 1. like this</code></li>',
		'<li>Italic items should be surrounded with an underscore, <code>_like this_</code></li>',
		'<li>Bold items should be surrounded with two stars, <code>like this</code></li>',
		'<li>Comments will be formatted using the Markdown syntax, eg:</li>',
		'</ul>',
		'</li>',
		'<div class="markdown preview">',
		'<h4>Markdown</h4>',
		'<pre>',
		"Here is a bold item\n",
		"Here is an _italic_ item\n",
		"Here is an `inline` code snippet\n",
		"\n",
		" Indent with 4 spaces\n",
		" for a code snippet\n",
		"\n",
		"1. Here is a numbered list\n",
		"2. Second numbered list item\n",
		"\n",
		"- Here is an unordered list\n",
		"- Second unordered list item\n",
		'</pre>',
		'</div>',
		'<div class="markdown result">',
		'<h4>Result</h4>',
		'Here is a <strong>bold</strong> item<br/>',
		'Here is an <em>italic</em> item<br/>',
		'Here is an <code>inline</code> code snippet<br/>',
		'<pre>',
		"Indent with 4 spaces\n",
		"for a code snippet",
		'</pre>',
		'<ol>',
		'<li>Here is a numbered list</li>',
		'<li>Second numbered list item</li>',
		'</ol>',
		'<ul>',
		'<li>Here is an unordered list</li>',
		'<li>Second unordered list item</li>',
		'</ul>',
		'</div>',
		'</div>',
		'</form>',
		'</div>'
		);
		@@ -161,38 +187,16 @@ Ext.define('Docs.view.Comments', {
		}, this);
		},

		renderHoverMenuMeta: function() {
		renderHoverMenuMeta: function(cmp) {

		return;
		var commentsMeta = Docs.App.getController('Comments').commentMeta;

		var clsName = Docs.App.getController('Classes').currentCls.name,
		elId = clsName.replace(/\./g, '-'),
		commentsMeta = Docs.App.getController('Comments').commentMeta,
		commentsMetaTotals = Docs.App.getController('Comments').commentMetaTotals;

		console.log(Ext.query('.hover-menu')[0].innerHTML);

		Ext.Array.each(Ext.query('.member a.name'), function(a) {

		var memberId = a.getAttribute('href').replace(/^.*\//, ''),
		memberEl = Ext.get(a).up('.member'),
		descriptionEl = memberEl.down('.long'),
		id = ('class-' + memberId).replace(/\./g, '-');


		var hoverMember = Ext.query('.hover-menu a[rel="' + memberId + '"]')
		console.log(memberId, '.hover-menu a[rel="' + memberId + '"]', hoverMember);

		// Add to hover menu too
		if (hoverMember && hoverMember[0]) {
		this.memberCommentsTpl.append(hoverMember[0], {
		num: commentsMeta[memberId] \|\| 0,
		id: id
		});
		Ext.Array.each(cmp.query('a.docClass'), function(a) {
		var memberId = a.getAttribute('rel');
		if (commentsMeta[memberId]) {
		this.memberCommentsTpl.append(a, [commentsMeta[memberId] \|\| 0]);
		}

		}, this);

		},

		updateCommentMeta: function() {

template/app/view/HoverMenu.js

+1 −0

Original line number	Diff line number	Diff line
		@@ -4,6 +4,7 @@
		Ext.define('Docs.view.HoverMenu', {
		extend: 'Ext.view.View',

		alias: 'widget.hovermenu',
		componentCls: 'hover-menu',
		itemSelector: 'div.item',
		deferEmptyText: false,

template/resources/sass/viewport.scss

+23 −0

Original line number	Diff line number	Diff line
		@@ -750,6 +750,29 @@ a {
		border-top: 1px solid #C7D1D9;
		margin-top: 15px;
		padding-top: 10px;
		.markdown.preview {
		float: left;
		width: 310px;
		pre {
		border: 0;
		padding: 0;
		margin: 0;
		line-height: 1.5em;
		background: transparent; } }
		.markdown.result {
		margin-left: 320px;
		width: 260px; }
		.markdown {
		background: #fff;
		padding: 20px;
		position: relative;
		@include border-radius(5px);
		h4 {
		position: absolute;
		top: 0px;
		right: 0px;
		padding: 5px 10px;
		background: rgba(0,0,0,0.05); } }
		code {
		padding-left: 5px; }
		ul {