Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
27 commits
Select commit Hold shift + click to select a range
bdb24af
Added new structure for reference documentation. Updated Wyam
Jul 31, 2019
bdecc30
Some small fixes
Jul 31, 2019
45dff3a
Added docs for Properties > Core
Aug 4, 2019
9b21d89
Added docs for importer
Aug 4, 2019
b81cbee
Added docs for JS specific properties
Aug 4, 2019
3de6f69
Fixed broken test
Aug 4, 2019
e55b474
Added docs for layout settings
Aug 4, 2019
4f50292
Added docs for player properties
Aug 4, 2019
0720ba3
Added docs for rendering resources
Aug 4, 2019
bf739e9
Added staves docs
Aug 4, 2019
d6e41ad
Auto generate rendering resources table, added docs for vibrato
Aug 11, 2019
fb65a0c
Added docs for core API + some API extension for consistency.
Aug 11, 2019
cc7ea0f
Fixed compilation issues.
Danielku15 Aug 11, 2019
ec1e98c
Fixed compilation issues.
Danielku15 Aug 11, 2019
bd334c7
Docs for player api added.
Danielku15 Aug 11, 2019
43438d8
Moved loadsoundfont to correct section
Danielku15 Aug 11, 2019
ccd4c9c
Docs for the api props
Danielku15 Aug 11, 2019
3858102
Some type infos for API props
Danielku15 Aug 11, 2019
52c9ca4
Remove from sidebar again
Danielku15 Aug 11, 2019
f3fe8ef
Docs for jQuery, made jQuery plugin consistent with API
Danielku15 Aug 11, 2019
b4a9df2
Removed separate jquery docs
Danielku15 Aug 11, 2019
0c7fd8f
Added jQuery event listening to docs.
Danielku15 Aug 11, 2019
d0c1d6e
Added played api methods and docs to be consistent with current version.
Danielku15 Aug 11, 2019
b18ee64
Fixed compilation issues
Danielku15 Aug 11, 2019
ba6a71e
Fixed minor issue and updated player sample after "autoscroll" removal
Danielku15 Aug 11, 2019
8671d67
Add version tag to docs, bump to 0.9.4
Danielku15 Aug 11, 2019
3e07ddb
Corrected wrong number
Danielku15 Aug 11, 2019
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions Directory.Build.props
Original file line number Diff line number Diff line change
Expand Up @@ -3,15 +3,15 @@
<DebugType>full</DebugType>
<DebugSymbols>true</DebugSymbols>

<Version>0.9.3</Version>
<AssemblyVersion>0.9.3.0</AssemblyVersion>
<FileVersion>0.9.3.0</FileVersion>
<Version>0.9.4</Version>
<AssemblyVersion>0.9.4.0</AssemblyVersion>
<FileVersion>0.9.4.0</FileVersion>
<Authors>Danielku15</Authors>
<Company>CoderLine</Company>
<Product>AlphaTab</Product>
<NeutralLanguage>en</NeutralLanguage>
<Description>alphaTab is a cross platform music notation and guitar tablature rendering library.</Description>
<Copyright>Copyright © 2017, Daniel Kuschny and Contributors</Copyright>
<Copyright>Copyright © 2019, Daniel Kuschny and Contributors</Copyright>
<PackageLicenseExpression>MPL-2.0</PackageLicenseExpression>
<PackageProjectUrl>https://www.alphatab.net</PackageProjectUrl>
<RepositoryUrl>https://github.com/CoderLine/alphaTab</RepositoryUrl>
Expand Down
177 changes: 104 additions & 73 deletions Documentation/config.wyam.packages.xml

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion Documentation/generate.bat
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

pushd %~dp0

SET WYAM=%USERPROFILE%\.nuget\packages\wyam\2.1.1\tools\netcoreapp2.1\Wyam.dll
SET WYAM=%USERPROFILE%\.nuget\packages\wyam\2.2.5\tools\netcoreapp2.1\Wyam.dll
SET GitBranch=%APPVEYOR_REPO_BRANCH%
git rev-parse HEAD > head.txt
set /p GitRevision=<head.txt
Expand Down
2 changes: 1 addition & 1 deletion Documentation/generatelocal.bat
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
pushd %~dp0

SET GitBranch=%APPVEYOR_REPO_BRANCH%
SET WYAM=%USERPROFILE%\.nuget\packages\wyam\2.1.1\tools\netcoreapp2.1\Wyam.dll
SET WYAM=%USERPROFILE%\.nuget\packages\wyam\2.2.5\tools\netcoreapp2.1\Wyam.dll
IF "%GitBranch%"=="" (
git rev-parse HEAD > head.txt
set /p GitRevision=<head.txt
Expand Down
59 changes: 59 additions & 0 deletions Documentation/input/Shared/Sidebar/_ChildPagesMenu.cshtml
Original file line number Diff line number Diff line change
@@ -0,0 +1,59 @@
@model IReadOnlyList<IDocument>

@functions
{
IDocument[] FilterChildren(IEnumerable<IDocument> children)
{
return children
.Where(x => x.Bool(DocsKeys.ShowInSidebar, true))
.OrderBy(x => x.Get<int>(DocsKeys.Order, 1000))
.ThenBy(x => x.WithoutSettings.String(Keys.Title))
.ToArray();
}
}

@{
// Group by category
IList<IGrouping<string, IDocument>> categoryGroups = Model
.GroupBy(x => x.String(DocsKeys.Category))
.OrderBy(x => x.Key)
.ToList();
foreach(IGrouping<string, IDocument> categoryGroup in categoryGroups)
{
IDocument[] children = FilterChildren(categoryGroup);

if(children.Length > 0)
{
if(!string.IsNullOrWhiteSpace(categoryGroup.Key))
{
<li class="header">@categoryGroup.Key</li>
}

// Iterate documents in this category
foreach(IDocument child in children)
{
object[] currentTreePath = Document.Get<object[]>(Keys.TreePath);
object[] childTreePath = child.Get<object[]>(Keys.TreePath);
string childTitle = child.WithoutSettings.String(Keys.Title, childTreePath.Last().ToString());
string parentActive = currentTreePath.Take(childTreePath.Length).SequenceEqual(childTreePath) ? "active" : null;
string childSelected = parentActive != null && currentTreePath.Length == childTreePath.Length ? "selected" : null;
IDocument[] subChildren = FilterChildren(child.DocumentList(Keys.Children) ?? (IEnumerable<IDocument>)new IDocument[0]);
if(subChildren.Length > 0)
{
// Parent
<li class="treeview @parentActive @childSelected">
<a href="@Context.GetLink(child)">@childTitle</a> <a href="#" class="expand"></a>
<ul class="treeview-menu">
@Html.Partial("Sidebar/_ChildPagesMenu", subChildren)
</ul>
</li>
}
else
{
// Leaf
<li class="@childSelected"><a href="@Context.GetLink(child)">@childTitle</a></li>
}
}
}
}
}
57 changes: 0 additions & 57 deletions Documentation/input/Shared/Sitebar/_ChildPagesMenu.cshtml

This file was deleted.

7 changes: 7 additions & 0 deletions Documentation/input/Shared/_SinceHeader.cshtml
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
@{
string since = Model.String("Since", "");
}

@if(!string.IsNullOrEmpty(since)) {
<span class="since">Since AlphaTab @since</span>
}
39 changes: 39 additions & 0 deletions Documentation/input/_Bottom.cshtml
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
<script src="https://cdnjs.cloudflare.com/ajax/libs/prism/1.6.0/prism.min.js"></script>
<script src="https://cdnjs.cloudflare.com/ajax/libs/prism/1.6.0/plugins/line-numbers/prism-line-numbers.js"></script>
<script src="https://cdnjs.cloudflare.com/ajax/libs/prism/1.6.0/plugins/normalize-whitespace/prism-normalize-whitespace.js"></script>
<script>
window.texSample = @(Model.Bool("TexSample", false).ToString().ToLower());

// Close the sidebar if we select an anchor link
$(".main-sidebar a[href^='#']:not('.expand')").click(function(){
$(document.body).removeClass('sidebar-open');
});

$(document).load(function() {
mermaid.initialize(
{
flowchart:
{
htmlLabels: false,
useMaxWidth:false
}
});
mermaid.init(undefined, ".mermaid")
$('svg').addClass('img-responsive');
});

// Back to top
$(window).scroll(function() {
if ($(this).scrollTop() >= 200) { // If page is scrolled more than 50px
$('#return-to-top').fadeIn(1000); // Fade in the arrow
} else {
$('#return-to-top').fadeOut(1000); // Else fade out the arrow
}
});
$('#return-to-top').click(function() { // When arrow is clicked
$('body,html').animate({
scrollTop : 0 // Scroll to top of body
}, 500);
});
</script>
<script src="@Context.GetLink("/assets/js/examples.js")"></script>
3 changes: 3 additions & 0 deletions Documentation/input/_Head.cshtml
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/prism/1.6.0/themes/prism.min.css" />
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/prism/1.6.0/plugins/line-numbers/prism-line-numbers.min.css" />
<script src="@Context.GetLink("/assets/js/alphaTab/alphaTab.min.js")"></script>
46 changes: 46 additions & 0 deletions Documentation/input/_Layout.cshtml
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
@{
Layout = "/_Master.cshtml";
ViewData[Keys.Title] = @Model.WithoutSettings.String(Keys.Title);
}

@section Infobar {
@if (IsSectionDefined("Infobar")) {
RenderSection("Infobar");
}
else {
@Html.Partial("_Infobar")
}
}

@section Search {
@if (IsSectionDefined("Search")) {
RenderSection("Search");
}
}

@section Sidebar {
@if (IsSectionDefined("Sidebar")) {
RenderSection("Sidebar");
}
else {
@Html.Partial("Sidebar/_ChildPages")
}
}

@if(Model.Bool(DocsKeys.NoContainer, false))
{
@RenderBody()
}
else
{
@if(!Model.Bool(DocsKeys.NoTitle, false))
{
<section class="content-header">
<h1>@ViewData[Keys.Title]</h1>
@Html.Partial("_SinceHeader")
</section>
}
<section class="content">
@RenderBody()
</section>
}
Loading