SitecoreAnnotatable

A Library for automatically adding annotations to the markup of Sitecore Websites.

• About this Project
• Install with Nuget
• Getting Started
• Compatibility
• Roadmap
• Contributing
• Contact Me

About The Project

SitecoreAnnoatable is a library that can be added to Sitecore installations with little configuration that will generate annotation in the HTML markup of your different Sitecore artifacts. With SitecoreAnnotatable you will:

• Annotate Sitecore Renderings in HTML.
• Identify the Name, Type, and Datasource of each Rendering.
• Provides OOTB 'Sitecore Markers' to annotate in either XML style tags or HTML style comments.
• Markers are easilably extensible and can be swapped out with your own custom implementation.

Install with NuGet

You can install the framework via NuGet:

PM> Install-Package dglambert.SitecoreAnnotatable.Infrastructure

For information about configuring, see the Getting Started section below.

Getting Started

Setting up Dependencies

In your IOC container, you will need to register two additional services, IGetDataSourceQuery and IRenderingMakerFactory.

    public class RegisterDependencies : IServicesConfigurator
    {
        public void Configure(IServiceCollection serviceCollection)
        {
            Database database = Glass.Mapper.Sc.IoC.SitecoreContextFactory.Default.GetSitecoreContext().Database;

            serviceCollection.AddSingleton<dglambert.SitecoreAnnotatable.Infrastructure.Queries.IGetDataSourceQuery>(service => new dglambert.SitecoreAnnotatable.Infrastructure.Queries.GetDataSourceQuery(database));
            serviceCollection.AddSingleton<dglambert.SitecoreAnnotatable.Infrastructure.Factories.IRenderingMarkerFactory, dglambert.SitecoreAnnotatable.Infrastructure.Factories.RenderingMarkerFactory>();
        }
    }

Compatibility

As the original intention of this project was for my own use, I did not spend time testing this on any installations other than 8.2.7.

• Sitecore 8.2.7 [Verified Working]

If you are interested in testing it out and would like to contribute, please let me know if it works and I will update this list as additional users report expanded compatibility.

Roadmap

See the open issues for a list of proposed features and known issues.

Contributing

If you encounter a bug or have a feature request, please use the Issue Tracker. The project is also open to contributions, so feel free to fork the project and open pull requests.

Contact Me

If you have a question or comment you can DM me on the Sitecore Community Slack Channel, Twitter, or LinkedIn