tsai
/
abp
mirror of https://github.com/abpframework/abp.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
Browse Source

Merge branch 'salihozkara/docsImprovements' into salihozkara/abpUnited

pull/19876/head
Salih 3 years ago
parent
2f06f7d639 fc1fea54fe
commit
c071463daa
5 changed files with 72 additions and 63 deletions
Whitespace
Show all changes Ignore whitespace when comparing lines Ignore changes in amount of whitespace Ignore changes in whitespace at EOL
Unified View
Diff Options
Show Stats Download Patch File Download Diff File
  1. 19
      modules/docs/src/Volo.Docs.Web/Areas/Documents/TagHelpers/TreeTagHelper.cs
  2. 25
      modules/docs/src/Volo.Docs.Web/Markdown/MarkdownDocumentToHtmlConverter.cs
  3. 54
      modules/docs/src/Volo.Docs.Web/Pages/Documents/Project/Index.cshtml.cs
  4. 31
      modules/docs/src/Volo.Docs.Web/Utils/DefaultDocsLinkGenerator.cs
  5. 6
      modules/docs/src/Volo.Docs.Web/Utils/IDocsLinkGenerator.cs

19
modules/docs/src/Volo.Docs.Web/Areas/Documents/TagHelpers/TreeTagHelper.cs
View File

@ -1,15 +1,11 @@
using System; using System;
using System.Collections.Generic;
using System.Linq; using System.Linq;
using System.Text; using System.Text;
using Microsoft.AspNetCore.Mvc;
using Microsoft.AspNetCore.Razor.TagHelpers; using Microsoft.AspNetCore.Razor.TagHelpers;
using Microsoft.AspNetCore.Routing;
using Microsoft.Extensions.Localization; using Microsoft.Extensions.Localization;
using Microsoft.Extensions.Options; using Microsoft.Extensions.Options;
using Volo.Docs.Documents; using Volo.Docs.Documents;
using Volo.Docs.Localization; using Volo.Docs.Localization;
using Volo.Docs.Pages.Documents.Project;
using Volo.Docs.Utils; using Volo.Docs.Utils;
namespace Volo.Docs.Areas.Documents.TagHelpers namespace Volo.Docs.Areas.Documents.TagHelpers
@ -23,7 +19,7 @@ namespace Volo.Docs.Areas.Documents.TagHelpers
private readonly IStringLocalizer<DocsResource> _localizer; private readonly IStringLocalizer<DocsResource> _localizer;
private readonly LinkGenerator _linkGenerator; private readonly IDocsLinkGenerator _docsLinkGenerator;
private readonly Func<DocsUrlNormalizerContext, string> _urlNormalizer; private readonly Func<DocsUrlNormalizerContext, string> _urlNormalizer;
@ -55,11 +51,11 @@ namespace Volo.Docs.Areas.Documents.TagHelpers
[HtmlAttributeName("language")] [HtmlAttributeName("language")]
public string LanguageCode { get; set; } public string LanguageCode { get; set; }
public TreeTagHelper(IOptions<DocsUiOptions> urlOptions, IStringLocalizer<DocsResource> localizer, LinkGenerator linkGenerator, IServiceProvider serviceProvider) public TreeTagHelper(IOptions<DocsUiOptions> urlOptions, IStringLocalizer<DocsResource> localizer, IDocsLinkGenerator docsLinkGenerator, IServiceProvider serviceProvider)
{ {
_localizer = localizer; _localizer = localizer;
_uiOptions = urlOptions.Value; _uiOptions = urlOptions.Value;
_linkGenerator = linkGenerator; _docsLinkGenerator = docsLinkGenerator;
_urlNormalizer = _uiOptions.UrlNormalizer ?? (context => context.Url); _urlNormalizer = _uiOptions.UrlNormalizer ?? (context => context.Url);
_serviceProvider = serviceProvider; _serviceProvider = serviceProvider;
} }
@ -183,14 +179,7 @@ namespace Volo.Docs.Areas.Documents.TagHelpers
if (!UrlHelper.IsExternalLink(path)) if (!UrlHelper.IsExternalLink(path))
{ {
var routeValues = new Dictionary<string, object> { path = _docsLinkGenerator.GenerateLink(ProjectName, LanguageCode, Version, pathWithoutFileExtension);
{ nameof(IndexModel.LanguageCode), LanguageCode },
{ nameof(IndexModel.Version), Version },
{ nameof(IndexModel.DocumentName), pathWithoutFileExtension },
{ nameof(IndexModel.ProjectName), ProjectName }
};
path = _linkGenerator.GetPathByPage("/Documents/Project/Index", values: routeValues);
} }

25
modules/docs/src/Volo.Docs.Web/Markdown/MarkdownDocumentToHtmlConverter.cs
View File

@ -19,16 +19,16 @@ namespace Volo.Docs.Markdown
private readonly IMarkdownConverter _markdownConverter; private readonly IMarkdownConverter _markdownConverter;
private readonly DocsUiOptions _uiOptions; private readonly DocsUiOptions _uiOptions;
private readonly LinkGenerator _linkGenerator; private readonly IDocsLinkGenerator _docsLinkGenerator;
private readonly IServiceProvider _serviceProvider; private readonly IServiceProvider _serviceProvider;
private readonly Func<DocsUrlNormalizerContext, string> _urlNormalizer; private readonly Func<DocsUrlNormalizerContext, string> _urlNormalizer;
public MarkdownDocumentToHtmlConverter(IMarkdownConverter markdownConverter, public MarkdownDocumentToHtmlConverter(IMarkdownConverter markdownConverter,
IOptions<DocsUiOptions> urlOptions, LinkGenerator linkGenerator, IOptions<DocsUiOptions> urlOptions, IDocsLinkGenerator docsLinkGenerator,
IServiceProvider serviceProvider) IServiceProvider serviceProvider)
{ {
_markdownConverter = markdownConverter; _markdownConverter = markdownConverter;
_linkGenerator = linkGenerator; _docsLinkGenerator = docsLinkGenerator;
_serviceProvider = serviceProvider; _serviceProvider = serviceProvider;
_uiOptions = urlOptions.Value; _uiOptions = urlOptions.Value;
_urlNormalizer = _uiOptions.UrlNormalizer ?? (context => context.Url); _urlNormalizer = _uiOptions.UrlNormalizer ?? (context => context.Url);
@ -126,7 +126,7 @@ namespace Volo.Docs.Markdown
return NormalizeLink( return NormalizeLink(
displayText, displayText,
MdLinkFormat, MdLinkFormat,
GenerateUrl(languageCode, $"{version}{documentLocalDirectoryNormalized}", documentName, projectShortName), _docsLinkGenerator.GenerateLink(projectShortName, languageCode, $"{version}{documentLocalDirectoryNormalized}", documentName),
projectShortName, projectShortName,
version, version,
documentName, documentName,
@ -151,8 +151,8 @@ namespace Volo.Docs.Markdown
{ {
documentLocalDirectoryNormalized = "/" + documentLocalDirectoryNormalized; documentLocalDirectoryNormalized = "/" + documentLocalDirectoryNormalized;
} }
link = GenerateUrl(languageCode, $"{version}{documentLocalDirectoryNormalized}", documentName, projectShortName); link = _docsLinkGenerator.GenerateLink(projectShortName, languageCode, $"{version}{documentLocalDirectoryNormalized}", documentName);
} }
return NormalizeLink(displayText, MdLinkFormat, link,projectShortName, return NormalizeLink(displayText, MdLinkFormat, link,projectShortName,
@ -193,18 +193,5 @@ namespace Volo.Docs.Markdown
return documentName.Left(documentName.Length - Type.Length - 1); return documentName.Left(documentName.Length - Type.Length - 1);
} }
private string GenerateUrl(string languageCode, string version, string documentName, string projectShortName)
{
var routeValues = new Dictionary<string, object> {
{ nameof(IndexModel.LanguageCode), languageCode },
{ nameof(IndexModel.Version), version },
{ nameof(IndexModel.DocumentName), documentName },
{ nameof(IndexModel.ProjectName), projectShortName }
};
var encodedUrl = _linkGenerator.GetPathByPage("/Documents/Project/Index", values: routeValues);
return WebUtility.UrlDecode(encodedUrl); //Document name can contain path separators like /, so we need to decode it
}
} }
} }

54
modules/docs/src/Volo.Docs.Web/Pages/Documents/Project/Index.cshtml.cs
View File

@ -21,6 +21,7 @@ using Volo.Docs.Models;
using Volo.Docs.Projects; using Volo.Docs.Projects;
using Volo.Docs.GitHub.Documents.Version; using Volo.Docs.GitHub.Documents.Version;
using Volo.Docs.Localization; using Volo.Docs.Localization;
using Volo.Docs.Utils;
namespace Volo.Docs.Pages.Documents.Project namespace Volo.Docs.Pages.Documents.Project
{ {
@ -90,6 +91,8 @@ namespace Volo.Docs.Pages.Documents.Project
private readonly IProjectAppService _projectAppService; private readonly IProjectAppService _projectAppService;
private readonly IDocumentSectionRenderer _documentSectionRenderer; private readonly IDocumentSectionRenderer _documentSectionRenderer;
private readonly DocsUiOptions _uiOptions; private readonly DocsUiOptions _uiOptions;
protected IDocsLinkGenerator DocsLinkGenerator => LazyServiceProvider.LazyGetRequiredService<IDocsLinkGenerator>();
public IndexModel( public IndexModel(
IDocumentAppService documentAppService, IDocumentAppService documentAppService,
@ -249,59 +252,52 @@ namespace Volo.Docs.Pages.Documents.Project
new StringBuilder() new StringBuilder()
.Append("/Abp/Languages/Switch?culture=") .Append("/Abp/Languages/Switch?culture=")
.Append(LanguageCode).Append("&uiCulture=") .Append(LanguageCode).Append("&uiCulture=")
.Append(LanguageCode).Append("&returnUrl=").Append(BuildDocumentUrl(ProjectName, LanguageCode, .Append(LanguageCode).Append("&returnUrl=").Append(DocsLinkGenerator.GenerateLink(ProjectName, LanguageCode,
LatestVersionInfo.IsSelected ? DocsAppConsts.Latest : Version, DocumentName)).ToString()); LatestVersionInfo.IsSelected ? DocsAppConsts.Latest : Version, DocumentName)).ToString());
} }
public string GetFullUrlOfTheLatestDocument() public string GetFullUrlOfTheLatestDocument()
{ {
return Request.Scheme + Uri.SchemeDelimiter + Request.Host.Value + Request.PathBase + BuildDocumentUrl(ProjectName, LanguageCode, DocsAppConsts.Latest, DocumentName); return Request.Scheme + Uri.SchemeDelimiter + Request.Host.Value + Request.PathBase + DocsLinkGenerator.GenerateLink(ProjectName, LanguageCode, DocsAppConsts.Latest, DocumentName);
} }
public string CreateDocumentLink(string documentName) public string CreateDocumentLink(string documentName)
{ {
return BuildDocumentUrl(ProjectName, LanguageCode, LatestVersionInfo.IsSelected ? DocsAppConsts.Latest : Version, documentName); return DocsLinkGenerator.GenerateLink(ProjectName, LanguageCode, LatestVersionInfo.IsSelected ? DocsAppConsts.Latest : Version, documentName);
} }
public string BuildDocumentUrl(string projectName, string languageCode, string version, string documentName) public string BuildDocumentUrl(string projectName, string languageCode, string version, string documentName)
{ {
var routeValues = new Dictionary<string, object> { return DocsLinkGenerator.GenerateLink(projectName, languageCode, version, documentName);
{ nameof(LanguageCode), languageCode },
{ nameof(Version), version },
{ nameof(DocumentName), documentName },
{ nameof(ProjectName), projectName }
};
return Url.Page("/Documents/Project/Index", routeValues);
} }
private IActionResult RedirectToDefaultLanguage() private IActionResult RedirectToDefaultLanguage()
{ {
return Redirect(BuildDocumentUrl( return Redirect(DocsLinkGenerator.GenerateLink(
projectName : ProjectName, ProjectName,
version : (LatestVersionInfo.IsSelected ? DocsAppConsts.Latest : Version), DefaultLanguageCode,
languageCode : DefaultLanguageCode, LatestVersionInfo.IsSelected ? DocsAppConsts.Latest : Version,
documentName : DocumentName DocumentName
)); ));
} }
private IActionResult RedirectToDefaultVersion() private IActionResult RedirectToDefaultVersion()
{ {
return Redirect(BuildDocumentUrl( return Redirect(DocsLinkGenerator.GenerateLink(
projectName : ProjectName, ProjectName,
version : DocsAppConsts.Latest, LanguageCode,
languageCode : LanguageCode, DocsAppConsts.Latest,
documentName : DocumentName DocumentName
)); ));
} }
private IActionResult RedirectToDefaultDocument() private IActionResult RedirectToDefaultDocument()
{ {
return Redirect(BuildDocumentUrl ( return Redirect(DocsLinkGenerator.GenerateLink (
projectName : ProjectName, ProjectName,
version : (LatestVersionInfo.IsSelected ? DocsAppConsts.Latest : Version), DefaultLanguageCode,
documentName : "", LatestVersionInfo.IsSelected ? DocsAppConsts.Latest : Version,
languageCode : DefaultLanguageCode ""
)); ));
} }
@ -323,7 +319,7 @@ namespace Volo.Docs.Pages.Documents.Project
{ {
return null; return null;
} }
return BuildDocumentUrl(project.ShortName, LanguageCode, Version, null); return DocsLinkGenerator.GenerateLink(project.ShortName, LanguageCode, Version, null);
} }
private async Task<bool> TrySetVersionAsync() private async Task<bool> TrySetVersionAsync()
@ -467,7 +463,7 @@ namespace Volo.Docs.Pages.Documents.Project
version = DocsAppConsts.Latest; version = DocsAppConsts.Latest;
} }
return BuildDocumentUrl(ProjectName, LanguageCode, version, documentName); return DocsLinkGenerator.GenerateLink(ProjectName, LanguageCode, version, documentName);
} }
public string GetSpecificVersionOrLatest() public string GetSpecificVersionOrLatest()
@ -526,7 +522,7 @@ namespace Volo.Docs.Pages.Documents.Project
LanguageSelectListItems.Add( LanguageSelectListItems.Add(
new SelectListItem( new SelectListItem(
language.DisplayName, language.DisplayName,
BuildDocumentUrl(ProjectName, language.Code, LatestVersionInfo.IsSelected ? DocsAppConsts.Latest : Version, DocumentName), DocsLinkGenerator.GenerateLink(ProjectName, language.Code, LatestVersionInfo.IsSelected ? DocsAppConsts.Latest : Version, DocumentName),
language.Code.Equals(LanguageCode, StringComparison.OrdinalIgnoreCase) language.Code.Equals(LanguageCode, StringComparison.OrdinalIgnoreCase)
) )
); );

31
modules/docs/src/Volo.Docs.Web/Utils/DefaultDocsLinkGenerator.cs
View File

@ -0,0 +1,31 @@
using System.Collections.Generic;
using System.Net;
using Microsoft.AspNetCore.Routing;
using Volo.Abp.DependencyInjection;
using Volo.Docs.Pages.Documents.Project;
namespace Volo.Docs.Utils;
public class DefaultDocsLinkGenerator : IDocsLinkGenerator, ITransientDependency
{
protected LinkGenerator LinkGenerator { get; }
public DefaultDocsLinkGenerator(LinkGenerator linkGenerator)
{
LinkGenerator = linkGenerator;
}
public string GenerateLink(string projectName, string languageCode, string version, string documentName)
{
var routeValues = new Dictionary<string, object> {
{ nameof(IndexModel.LanguageCode), languageCode },
{ nameof(IndexModel.Version), version },
{ nameof(IndexModel.DocumentName), documentName },
{ nameof(IndexModel.ProjectName), projectName }
};
var encodedUrl = LinkGenerator.GetPathByPage("/Documents/Project/Index", values: routeValues);
return WebUtility.UrlDecode(encodedUrl); //Document name can contain path separators like /, so we need to decode it
}
}

6
modules/docs/src/Volo.Docs.Web/Utils/IDocsLinkGenerator.cs
View File

@ -0,0 +1,6 @@
namespace Volo.Docs.Utils;
public interface IDocsLinkGenerator
{
string GenerateLink(string projectName, string languageCode, string version, string documentName);
}
Write Preview
Loading…
Cancel
Save