Shows the list of documents that transclude content from the current document.

Repository
list-transcluding-documents.js

This bookmarklet provides information on pages transcluding from the current projectdoc document shown in the browser.

Bookmarklet

The bookmarklet is ready to use. Simply drag and drop the bookmarklet button to the bookmarks in your browser.

Ready to use!

Error rendering macro 'projectdoc-bookmarklet-button-macro'

org/apache/commons/lang/StringUtils

Code

The code is available on the resource repository.

list-transcluding-documents.js
AJS.toInit(function () {
  const pageId = AJS.Meta.get('page-id');
  const locale = AJS.Meta.get('user-locale');
  const baseUrl = AJS.Meta.get('base-url');

  function createPage(i18n, currentDocument, documents) {
    const htmlTitle = "Transcluding Documents for " + currentDocument[i18n.name];
    let html = "<html lang='" + locale + "'><head><title>" + htmlTitle + "</title><style>" +
      " body {margin: 1rem !important;}" +
      " .table-sm td, .table-sm th {padding: .1rem !important;}" +
      " .table td, .table th { font-size: .8rem !important;}" +
      "</style>" +
      "<link rel=\"stylesheet\"" +
      " href=\"https://stackpath.bootstrapcdn.com/bootstrap/4.3.1/css/bootstrap.min.css\"" +
      " integrity=\"sha384-ggOyR0iXCbMQv3Xipma34MD+dH/1fQ784/j6cY/iJTQUOhcWr7x9JvoRxT2MZw1T\"" +
      " crossorigin=\"anonymous\">" +
      "</head><body><h3>" + htmlTitle + "</h3>";
    html += "<table class=\"table table-sm table-bordered table-striped\">";

    const hitCount = documents.document.length;
    const tinyUrlNamePlain = i18n["tinyUrl"] + '\u00a7';
    html += "<p>Content of document '<a href='" + currentDocument[tinyUrlNamePlain] + "'>" + currentDocument[i18n.name] + "</a>' is transcluded by ";
    if (hitCount === 0) {
      html += "no document.</p>";
    } else if (hitCount === 1) {
      html += "one document.</p>";
    } else {
      html += hitCount + " documents.</p>";
    }

    $.each(documents.document, function (index, doc) {
        const current = {};
        $.each(doc.property, function (i, property) {
          current[property.name] = property.value;
        });
        const name = current[i18n.name];
        const shortDescription = current[i18n.shortDescription];
        const url = current[tinyUrlNamePlain];
        html = html + "<tr><th><a href='" + url + "'>" + name + "</a></th><td>" + shortDescription + "</td></tr>";
      }
    );

    html += "</table></body></html>";
    return html;
  }

  const i18n = PDBMLS.fetchI18n(baseUrl, ["title", "spaceKey", "name", "shortDescription", "tinyUrl"]);
  const tinyUrlNamePlain = i18n["tinyUrl"] + '\u00a7';
  const currentDocument = PDBMLS.fetchDocument(baseUrl, pageId, [i18n.spaceKey, i18n.title, i18n.name, tinyUrlNamePlain]);

  if (currentDocument) {
    const spaceKey = currentDocument[i18n.spaceKey];
    const title = currentDocument[i18n.title];
    const pageReference = spaceKey + "." + title;
    const where = "$<TranscludedDocumentTitles>=[" + pageReference + "]";

    const documents = PDBMLS.fetchDocuments(baseUrl, [i18n.name, i18n.shortDescription, tinyUrlNamePlain], where);
    let html = createPage(i18n, currentDocument, documents);

    const container = window.open('', '', 'width=600,height=800,location=no,toolbar=0');
    container.document.body.innerHTML = html;
  }
});