{"id":20027103,"url":"https://github.com/unic/sitecorereferenception","last_synced_at":"2025-09-20T05:33:37.461Z","repository":{"id":13581355,"uuid":"16273977","full_name":"unic/SitecoreReferenception","owner":"unic","description":"The module should give the content authors the possibility to view many different types of references on a Item in the Content Editor.","archived":false,"fork":false,"pushed_at":"2014-05-26T14:59:59.000Z","size":2084,"stargazers_count":2,"open_issues_count":0,"forks_count":1,"subscribers_count":23,"default_branch":"master","last_synced_at":"2025-01-09T20:51:37.122Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"http://marketplace.sitecore.net/en/Modules/Referenception.aspx","language":"C#","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":"hirak/prestissimo","license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/unic.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.txt","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2014-01-27T08:58:35.000Z","updated_at":"2014-11-14T03:26:12.000Z","dependencies_parsed_at":"2022-09-12T10:30:28.715Z","dependency_job_id":null,"html_url":"https://github.com/unic/SitecoreReferenception","commit_stats":null,"previous_names":[],"tags_count":2,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/unic%2FSitecoreReferenception","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/unic%2FSitecoreReferenception/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/unic%2FSitecoreReferenception/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/unic%2FSitecoreReferenception/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/unic","download_url":"https://codeload.github.com/unic/SitecoreReferenception/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":233634086,"owners_count":18705953,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-13T09:09:03.269Z","updated_at":"2025-09-20T05:33:37.001Z","avatar_url":"https://github.com/unic.png","language":"C#","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Sitecore Referenception Module\n\nThis module was created during the [First Sitecore Hackathon](http://sitecorehackathon.org/first-ever-sitecore-hackathon/) with the idea **Best Authoring Experience Enhancement Module (Content Editor/Media Library)**. The module should give the content authors the possibility to view many different types of references on a Item in the Content Editor. The module can be started with a right click on any item in the Content Editor:\n\n![](misc/doc/referenception_contextmenu.png)\n\nA new tab is opened with different types of references, so called Providers. It is possible to add as many custom Providers as you like. Each provider can have a set of columns, data rows and additional informations for each row:\n\n![](misc/doc/referenception_tab.png)\n\nThis documentation is also available under *misc/doc/readme.pdf*.\n\n## Installation\n### Manual Installation\nYou can clone the repository and build the source code. You need to copy all assemblies listed in the README.md in the *lib* directory, otherwise you won't be able to build because of missing references. There are some MSBuild targets which copy all needed files into a directory defined in the *build/deploy.txt* file. Just create the *build/deploy.txt* file and insert the directory where you want to copy all the files to. You also need to copy the *misc/serialization* folder into your data folder and update the Core database.\n\n### Installation Package\nThere is a package to install the module via the Sitecore Package Manager. The package is located under *misc/installation/Sitecore Referenception-1.0.0.zip*.\n\n### Sample Package\nThere is also a sample package available, which provides a new template with some items to show how the module works. The sample package is located under *misc/installation/Sitecore Referenception Example Data-1.0.0.zip*.\n\n## Configuration\nThere is a configuration file `Referenception.config` in the `App_Config/Include` folder. The config includes some module settings and all the providers. All the providers are configured under `/sitecore/referenception/providers` with the following minimal structure (as an example):\n    \n    \u003cprovider type=\"Referenception.Common.CloneReferencesProvider, Referenception.Providers\"\u003e\n      \u003ctitle\u003eShow Clone References\u003c/title\u003e\n      \u003ctemplates hint=\"list\"\u003e\n        \u003ctemplate\u003eStandard template\u003c/template\u003e\n      \u003c/templates\u003e\n    \u003c/provider\u003e\n\n- `type`: Implementation type of the provider.\n- `title`: Title for the provider in the references tab.\n- `templates`: List of template names. This provider is shown for all items which either have this template directly or as one of the base templates.\n\nEach provider can have additional configuration elements.\n\n## Available Providers\nThe module is shipped with the reference implementations.\n\n### FieldReferencesProvider\nThis provider displays all fields of the current item which references another item. For each field, the referenced items are displayed. This provider is available for all items by default.\n\n### CloneReferencesProvider\nThis provider displays all clones of the current item and is available for all items by default.\n\n### UsageReferencesProvider\nThis provider displays all items, which reference the current item in any field. This provider is available for all items by default.\n\n## Custom Providers\nIt's easy to create custom providers. You have to follow these steps to create your own provider:\n\n1. Create a custom class and inherit from the abstract class `ReferenceProviderBase`. This means you have to override the method `GetData(Item sourceItem)` and return a `DataTable` object with all the data you want to display in the references tab.\n2. If you want to add additional information, add a column of type `IDictionary\u003cstring, string\u003e `to your DataTable and override the method `GetTooltip(DataRow row)`.\n3. If you want to make a link to the item in the table row, you have to override the method `GetLinkItemId(DataRow row)` and return the ID of the target item.\n4. Configure your provider in the config file. The minimal config is described under *Configuration*. It's also possible to add custom configurations, see `FieldReferencesProvider` for an example.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Funic%2Fsitecorereferenception","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Funic%2Fsitecorereferenception","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Funic%2Fsitecorereferenception/lists"}