Skip to content

Home

Jump to bottom
Sahar Mehrpour edited this page Sep 28, 2023 · 14 revisions

ActiveDocumentation is implemented as IntelliJ plugin. This tool has 2 components. The IDE connector and the Main component. The IDE connector must be installed as a plugin for IntelliJ. The Main component is a web-application and is executable in the browser.

Installing srcML

Install srcML version 0.9.5 from http://131.123.42.38/lmcrs/beta/

macOs

If the operating system is macOS and the installation failed with incompatible version errors, use the following instruction:

  1. Install the following packages with homebrew:
    • antlr2
    • boost
    • cmake
  2. Then from the El Capitan package (also available in this package), put the executable srcml file in /usr/local/bin and libsrcml.dylib in /usr/local/lib.

Windows

  1. Make sure you are installing srcML 0.9.5. The current srcML version is 1.0.0, so you will have to go to the "previous releases" link at the bottom of the "srcML Download" page.
  2. On Windows, use the installation wizard to install srcML.
  3. Make sure the path that is selected for installation is "C:\Program Files\srcML 0.9.5". On Windows, this is likely not the default installation path, so be sure to change it if not.

In the case that you install srcML, but run the console and get the error: Cannot run program “C:\Program Files\srcML 0.9.5\bin\srcml” Because the system cannot find the file specified In the bin folder there is a srcml.exe, it is likely that you have not:

  • installed the right version of srcML 0.9.5, and/or
  • installed srcML in the right path

Uninstall all places where srcML has been installed. Make sure you have the right srcML version. Follow the installation wizard and be sure to select the correct path for installation: "C:\Program Files\srcML 0.9.5".

Linux

When installing srcml, you may encounter the following error message: srcml: error while loading shared libraries: libcrypto.so.1.1: cannot open shared object file: No such file or directory.

This issue may arise due to differences in OpenSSL versions on modern Linux systems. To resolve this problem, please follow these steps:

  1. Download the required libssl package: wget http://nz2.archive.ubuntu.com/ubuntu/pool/main/o/openssl/libssl1.1_1.1.1f-1ubuntu2.19_amd64.deb

  2. Install the downloaded package using dpkg (replace libssl1.1_1.1.1f-1ubuntu2.19_amd64.deb with the actual filename if it has changed): sudo dpkg -i libssl1.1_1.1.1f-1ubuntu2.19_amd64.deb

Ensure that you are using the most up-to-date .deb files.

To verify the successful installation of the correct version of srcml and check its version:

  1. Use the following command to list the installed srcml packages: apt list --installed | grep srcml

  2. To confirm whether srcml is correctly installed and functioning, run: srcml <supported_file_name>

Preparing the Environment for using the tool

Download the crowdCode source code to play with the app (learningDR branch): https://github.com/devuxd/CrowdCoding-ActiveDocumentation

There might be some errors in code (unknown libraries). As we are not going to run CrowdCode (at least for now), you can ignore them.

(Note the 3 files: ruleTable.json, tagTable.json, and spmf.jar)

Installing the IntelliJ plugin

Download the latest version of ActiveDocumentation plugin: https://github.com/devuxd/ActiveDocumentation/blob/version4-learning-DR/ActiveDocumentationPlugin.zip

ActiveDocumentationPlugin.zip is the plugin file (Do NOT unzip the file).

Install ActiveDocumentationPlugin.zip as instructed in the official website. https://www.jetbrains.com/help/idea/managing-plugins.html#install_plugin_from_disk

After installing the plugin, the tool starts upon opening projects in the IDE.

Installing the Web App

Download the web app of ActiveDocumentation: (learningDR branch) https://github.com/devuxd/active-doc-client

Install the dependencies (node modules) for the app: npm install --legacy-peer-deps

Run the app:

  • Mac: npm run start-Mac
  • Linux: npm run start-Linux
  • Windows: npm run start-Windows

Notes

  • Only one project should be open in IntelliJ.
  • There should be 2 files in the root directory of the project: ruleTable.json and tagTable.json.
  • To work with mining rules, place a copy of spmf.jar in the root directory of the project.

Troubleshooting

Error in ChromePossible solution
npm run start* takes too long to startOpen active-doc-client project in Webstorm or Visual Studio (not IntelliJ) and run the script from the IDE terminal - Restart the system (to free ports)
The tool fails to connect to the IDE WebSocket connection to 'ws://localhost:8887/' failed: Error in connection establishment: net::ERR_CONNECTION_REFUSEDCheck if a project is open in IntelliJ - Restart IntelliJ - Restart the system (to free ports)
The tool doesn't show rules and tagsCheck the open project in the IDE - Restart the IDE and refresh the web app
The rules are shown, but no match or violation is detectedCheck whether srcML created the ASTs - Check the srcML version
The mined rules are not shownCheck if srcMl works properly - Check if spmf.jar library exists in the root directory of the project

Clone this wiki locally

, 'i'); if (__m === '*' || __re.test(location.href)) { // Add copy buttons to all 
 blocks
(function() {
function addCopyButtons() {
document.querySelectorAll('pre code').forEach(function(codeBlock) {
if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;
codeBlock.parentElement.setAttribute('data-copy-added', 'true');
var btn = document.createElement('button');
btn.textContent = 'Copy';
btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';
btn.onmouseover = function() { this.style.opacity = '1'; };
btn.onmouseout = function() { this.style.opacity = '0.7'; };
btn.onclick = function() {
navigator.clipboard.writeText(codeBlock.textContent).then(function() {
btn.textContent = 'Copied!';
setTimeout(function() { btn.textContent = 'Copy'; }, 1500);
});
};
codeBlock.parentElement.style.position = 'relative';
codeBlock.parentElement.appendChild(btn);
});
}
addCopyButtons();
// Re-run on dynamic content
var observer = new MutationObserver(addCopyButtons);
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '
Home · devuxd/active-doc-client Wiki · GitHub
Skip to content
Home
Jump to bottom

Sahar Mehrpour edited this page Sep 28, 2023
·
14 revisions
ActiveDocumentation is implemented as IntelliJ plugin.
This tool has 2 components. The IDE connector and the Main component.
The IDE connector must be installed as a plugin for IntelliJ.
The Main component is a web-application and is executable in the browser.
Installing srcML
Install srcML version 0.9.5 from http://131.123.42.38/lmcrs/beta/
macOs
If the operating system is macOS and the installation failed with incompatible version errors, use the following instruction:
  1. Install the following packages with homebrew:

    • antlr2
    • boost
    • cmake
  2. Then from the El Capitan package (also available in this package), put the executable srcml file in /usr/local/bin and libsrcml.dylib in /usr/local/lib.
Windows
  1. Make sure you are installing srcML 0.9.5. The current srcML version is 1.0.0, so you will have to go to the "previous releases" link at the bottom of the "srcML Download" page.
  2. On Windows, use the installation wizard to install srcML.
  3. Make sure the path that is selected for installation is "C:\Program Files\srcML 0.9.5". On Windows, this is likely not the default installation path, so be sure to change it if not.
In the case that you install srcML, but run the console and get the error:
Cannot run program “C:\Program Files\srcML 0.9.5\bin\srcml” 
Because the system cannot find the file specified
In the bin folder there is a srcml.exe, it is likely that you have not:
  • installed the right version of srcML 0.9.5, and/or
  • installed srcML in the right path
Uninstall all places where srcML has been installed. Make sure you have the right srcML version. Follow the installation wizard and be sure to select the correct path for installation: "C:\Program Files\srcML 0.9.5".
Linux
When installing srcml, you may encounter the following error message: srcml: error while loading shared libraries: libcrypto.so.1.1: cannot open shared object file: No such file or directory.
This issue may arise due to differences in OpenSSL versions on modern Linux systems. To resolve this problem, please follow these steps:
  1. Download the required libssl package:
wget http://nz2.archive.ubuntu.com/ubuntu/pool/main/o/openssl/libssl1.1_1.1.1f-1ubuntu2.19_amd64.deb
  2. Install the downloaded package using dpkg (replace libssl1.1_1.1.1f-1ubuntu2.19_amd64.deb with the actual filename if it has changed):
sudo dpkg -i libssl1.1_1.1.1f-1ubuntu2.19_amd64.deb
Ensure that you are using the most up-to-date .deb files.
To verify the successful installation of the correct version of srcml and check its version:
  1. Use the following command to list the installed srcml packages:
apt list --installed | grep srcml
  2. To confirm whether srcml is correctly installed and functioning, run:
srcml <supported_file_name>
Preparing the Environment for using the tool
Download the crowdCode source code to play with the app (learningDR branch):
https://github.com/devuxd/CrowdCoding-ActiveDocumentation
There might be some errors in code (unknown libraries). As we are not going to run CrowdCode (at least for now), you can ignore them.
(Note the 3 files: ruleTable.json, tagTable.json, and spmf.jar)
Installing the IntelliJ plugin
Download the latest version of ActiveDocumentation plugin:
https://github.com/devuxd/ActiveDocumentation/blob/version4-learning-DR/ActiveDocumentationPlugin.zip
ActiveDocumentationPlugin.zip is the plugin file (Do NOT unzip the file).
Install ActiveDocumentationPlugin.zip as instructed in the official website.
https://www.jetbrains.com/help/idea/managing-plugins.html#install_plugin_from_disk
After installing the plugin, the tool starts upon opening projects in the IDE.
Installing the Web App
Download the web app of ActiveDocumentation: (learningDR branch)
https://github.com/devuxd/active-doc-client
Install the dependencies (node modules) for the app: npm install --legacy-peer-deps
Run the app:
  • Mac: npm run start-Mac
  • Linux: npm run start-Linux
  • Windows: npm run start-Windows
Notes
  • Only one project should be open in IntelliJ.
  • There should be 2 files in the root directory of the project: ruleTable.json and tagTable.json.
  • To work with mining rules, place a copy of spmf.jar in the root directory of the project.
Troubleshooting
Error in ChromePossible solution
npm run start* takes too long to startOpen active-doc-client project in Webstorm or Visual Studio (not IntelliJ) and run the script from the IDE terminal - Restart the system (to free ports)
The tool fails to connect to the IDE WebSocket connection to 'ws://localhost:8887/' failed: Error in connection establishment: net::ERR_CONNECTION_REFUSEDCheck if a project is open in IntelliJ - Restart IntelliJ - Restart the system (to free ports)
The tool doesn't show rules and tagsCheck the open project in the IDE - Restart the IDE and refresh the web app
The rules are shown, but no match or violation is detectedCheck whether srcML created the ASTs - Check the srcML version
The mined rules are not shownCheck if srcMl works properly - Check if spmf.jar library exists in the root directory of the project
Clone this wiki locally

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Force GitHub README to respect dark mode
(function() {
var style = document.createElement('style');
style.textContent = '
.markdown-body {
color-scheme: dark light;
}
.markdown-body pre { background: #161b22 !important; }
.markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }
.markdown-body table th, .markdown-body table td { border-color: #30363d !important; }
.markdown-body img { background: #0d1117; }
.markdown-body blockquote { border-left-color: #8b949e; }
.markdown-body hr { border-color: #30363d; }
';
document.head.appendChild(style);
})();
}
} catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
Home · devuxd/active-doc-client Wiki · GitHub
Skip to content
Home
Jump to bottom

Sahar Mehrpour edited this page Sep 28, 2023
·
14 revisions
ActiveDocumentation is implemented as IntelliJ plugin.
This tool has 2 components. The IDE connector and the Main component.
The IDE connector must be installed as a plugin for IntelliJ.
The Main component is a web-application and is executable in the browser.
Installing srcML
Install srcML version 0.9.5 from http://131.123.42.38/lmcrs/beta/
macOs
If the operating system is macOS and the installation failed with incompatible version errors, use the following instruction:
  1. Install the following packages with homebrew:

    • antlr2
    • boost
    • cmake
  2. Then from the El Capitan package (also available in this package), put the executable srcml file in /usr/local/bin and libsrcml.dylib in /usr/local/lib.
Windows
  1. Make sure you are installing srcML 0.9.5. The current srcML version is 1.0.0, so you will have to go to the "previous releases" link at the bottom of the "srcML Download" page.
  2. On Windows, use the installation wizard to install srcML.
  3. Make sure the path that is selected for installation is "C:\Program Files\srcML 0.9.5". On Windows, this is likely not the default installation path, so be sure to change it if not.
In the case that you install srcML, but run the console and get the error:
Cannot run program “C:\Program Files\srcML 0.9.5\bin\srcml” 
Because the system cannot find the file specified
In the bin folder there is a srcml.exe, it is likely that you have not:
  • installed the right version of srcML 0.9.5, and/or
  • installed srcML in the right path
Uninstall all places where srcML has been installed. Make sure you have the right srcML version. Follow the installation wizard and be sure to select the correct path for installation: "C:\Program Files\srcML 0.9.5".
Linux
When installing srcml, you may encounter the following error message: srcml: error while loading shared libraries: libcrypto.so.1.1: cannot open shared object file: No such file or directory.
This issue may arise due to differences in OpenSSL versions on modern Linux systems. To resolve this problem, please follow these steps:
  1. Download the required libssl package:
wget http://nz2.archive.ubuntu.com/ubuntu/pool/main/o/openssl/libssl1.1_1.1.1f-1ubuntu2.19_amd64.deb
  2. Install the downloaded package using dpkg (replace libssl1.1_1.1.1f-1ubuntu2.19_amd64.deb with the actual filename if it has changed):
sudo dpkg -i libssl1.1_1.1.1f-1ubuntu2.19_amd64.deb
Ensure that you are using the most up-to-date .deb files.
To verify the successful installation of the correct version of srcml and check its version:
  1. Use the following command to list the installed srcml packages:
apt list --installed | grep srcml
  2. To confirm whether srcml is correctly installed and functioning, run:
srcml <supported_file_name>
Preparing the Environment for using the tool
Download the crowdCode source code to play with the app (learningDR branch):
https://github.com/devuxd/CrowdCoding-ActiveDocumentation
There might be some errors in code (unknown libraries). As we are not going to run CrowdCode (at least for now), you can ignore them.
(Note the 3 files: ruleTable.json, tagTable.json, and spmf.jar)
Installing the IntelliJ plugin
Download the latest version of ActiveDocumentation plugin:
https://github.com/devuxd/ActiveDocumentation/blob/version4-learning-DR/ActiveDocumentationPlugin.zip
ActiveDocumentationPlugin.zip is the plugin file (Do NOT unzip the file).
Install ActiveDocumentationPlugin.zip as instructed in the official website.
https://www.jetbrains.com/help/idea/managing-plugins.html#install_plugin_from_disk
After installing the plugin, the tool starts upon opening projects in the IDE.
Installing the Web App
Download the web app of ActiveDocumentation: (learningDR branch)
https://github.com/devuxd/active-doc-client
Install the dependencies (node modules) for the app: npm install --legacy-peer-deps
Run the app:
  • Mac: npm run start-Mac
  • Linux: npm run start-Linux
  • Windows: npm run start-Windows
Notes
  • Only one project should be open in IntelliJ.
  • There should be 2 files in the root directory of the project: ruleTable.json and tagTable.json.
  • To work with mining rules, place a copy of spmf.jar in the root directory of the project.
Troubleshooting
Error in ChromePossible solution
npm run start* takes too long to startOpen active-doc-client project in Webstorm or Visual Studio (not IntelliJ) and run the script from the IDE terminal - Restart the system (to free ports)
The tool fails to connect to the IDE WebSocket connection to 'ws://localhost:8887/' failed: Error in connection establishment: net::ERR_CONNECTION_REFUSEDCheck if a project is open in IntelliJ - Restart IntelliJ - Restart the system (to free ports)
The tool doesn't show rules and tagsCheck the open project in the IDE - Restart the IDE and refresh the web app
The rules are shown, but no match or violation is detectedCheck whether srcML created the ASTs - Check the srcML version
The mined rules are not shownCheck if srcMl works properly - Check if spmf.jar library exists in the root directory of the project
Clone this wiki locally

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Highlight search terms from Google/DuckDuckGo/Bing referrer
(function() {
var ref = document.referrer;
var terms = [];
if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {
var url = new URL(ref);
var q = url.searchParams.get('q') || url.searchParams.get('p');
if (q) {
terms = q.split(/\s+/).filter(function(t) { return t.length > 2; });
}
}
if (terms.length === 0) return;
var style = document.createElement('style');
style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';
document.head.appendChild(style);
function highlight(node) {
if (node.nodeType === 3) { // text node
var text = node.textContent;
var found = false;
terms.forEach(function(term) {
var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\]\\]/g, '\\') + ')', 'gi');
if (regex.test(text)) {
found = true;
var frag = document.createDocumentFragment();
var parts = text.split(regex);
parts.forEach(function(part, i) {
if (i % 2 === 0) {
frag.appendChild(document.createTextNode(part));
} else {
var span = document.createElement('span');
span.className = 'userscript-highlight';
span.textContent = part;
frag.appendChild(span);
}
});
node.parentNode.replaceChild(frag, node);
}
});
} else if (node.nodeType === 1 && node.childNodes) { // element
var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];
if (!skipTags.includes(node.tagName)) {
Array.from(node.childNodes).forEach(highlight);
}
}
}
highlight(document.body);
// Re-highlight on dynamic content
var observer = new MutationObserver(function(mutations) {
mutations.forEach(function(m) {
m.addedNodes.forEach(function(node) {
if (node.nodeType === 1 || node.nodeType === 3) highlight(node);
});
});
});
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
Home · devuxd/active-doc-client Wiki · GitHub
Skip to content
Home
Jump to bottom

Sahar Mehrpour edited this page Sep 28, 2023
·
14 revisions
ActiveDocumentation is implemented as IntelliJ plugin.
This tool has 2 components. The IDE connector and the Main component.
The IDE connector must be installed as a plugin for IntelliJ.
The Main component is a web-application and is executable in the browser.
Installing srcML
Install srcML version 0.9.5 from http://131.123.42.38/lmcrs/beta/
macOs
If the operating system is macOS and the installation failed with incompatible version errors, use the following instruction:
  1. Install the following packages with homebrew:

    • antlr2
    • boost
    • cmake
  2. Then from the El Capitan package (also available in this package), put the executable srcml file in /usr/local/bin and libsrcml.dylib in /usr/local/lib.
Windows
  1. Make sure you are installing srcML 0.9.5. The current srcML version is 1.0.0, so you will have to go to the "previous releases" link at the bottom of the "srcML Download" page.
  2. On Windows, use the installation wizard to install srcML.
  3. Make sure the path that is selected for installation is "C:\Program Files\srcML 0.9.5". On Windows, this is likely not the default installation path, so be sure to change it if not.
In the case that you install srcML, but run the console and get the error:
Cannot run program “C:\Program Files\srcML 0.9.5\bin\srcml” 
Because the system cannot find the file specified
In the bin folder there is a srcml.exe, it is likely that you have not:
  • installed the right version of srcML 0.9.5, and/or
  • installed srcML in the right path
Uninstall all places where srcML has been installed. Make sure you have the right srcML version. Follow the installation wizard and be sure to select the correct path for installation: "C:\Program Files\srcML 0.9.5".
Linux
When installing srcml, you may encounter the following error message: srcml: error while loading shared libraries: libcrypto.so.1.1: cannot open shared object file: No such file or directory.
This issue may arise due to differences in OpenSSL versions on modern Linux systems. To resolve this problem, please follow these steps:
  1. Download the required libssl package:
wget http://nz2.archive.ubuntu.com/ubuntu/pool/main/o/openssl/libssl1.1_1.1.1f-1ubuntu2.19_amd64.deb
  2. Install the downloaded package using dpkg (replace libssl1.1_1.1.1f-1ubuntu2.19_amd64.deb with the actual filename if it has changed):
sudo dpkg -i libssl1.1_1.1.1f-1ubuntu2.19_amd64.deb
Ensure that you are using the most up-to-date .deb files.
To verify the successful installation of the correct version of srcml and check its version:
  1. Use the following command to list the installed srcml packages:
apt list --installed | grep srcml
  2. To confirm whether srcml is correctly installed and functioning, run:
srcml <supported_file_name>
Preparing the Environment for using the tool
Download the crowdCode source code to play with the app (learningDR branch):
https://github.com/devuxd/CrowdCoding-ActiveDocumentation
There might be some errors in code (unknown libraries). As we are not going to run CrowdCode (at least for now), you can ignore them.
(Note the 3 files: ruleTable.json, tagTable.json, and spmf.jar)
Installing the IntelliJ plugin
Download the latest version of ActiveDocumentation plugin:
https://github.com/devuxd/ActiveDocumentation/blob/version4-learning-DR/ActiveDocumentationPlugin.zip
ActiveDocumentationPlugin.zip is the plugin file (Do NOT unzip the file).
Install ActiveDocumentationPlugin.zip as instructed in the official website.
https://www.jetbrains.com/help/idea/managing-plugins.html#install_plugin_from_disk
After installing the plugin, the tool starts upon opening projects in the IDE.
Installing the Web App
Download the web app of ActiveDocumentation: (learningDR branch)
https://github.com/devuxd/active-doc-client
Install the dependencies (node modules) for the app: npm install --legacy-peer-deps
Run the app:
  • Mac: npm run start-Mac
  • Linux: npm run start-Linux
  • Windows: npm run start-Windows
Notes
  • Only one project should be open in IntelliJ.
  • There should be 2 files in the root directory of the project: ruleTable.json and tagTable.json.
  • To work with mining rules, place a copy of spmf.jar in the root directory of the project.
Troubleshooting
Error in ChromePossible solution
npm run start* takes too long to startOpen active-doc-client project in Webstorm or Visual Studio (not IntelliJ) and run the script from the IDE terminal - Restart the system (to free ports)
The tool fails to connect to the IDE WebSocket connection to 'ws://localhost:8887/' failed: Error in connection establishment: net::ERR_CONNECTION_REFUSEDCheck if a project is open in IntelliJ - Restart IntelliJ - Restart the system (to free ports)
The tool doesn't show rules and tagsCheck the open project in the IDE - Restart the IDE and refresh the web app
The rules are shown, but no match or violation is detectedCheck whether srcML created the ASTs - Check the srcML version
The mined rules are not shownCheck if srcMl works properly - Check if spmf.jar library exists in the root directory of the project
Clone this wiki locally

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Strip utm_, fbclid, gclid, etc. from all links on page
(function() {
var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',
'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',
'ref', 'ref_src', 'source', 'medium', 'campaign'];
function cleanUrl(url) {
try {
var u = new URL(url, window.location.origin);
var changed = false;
trackingParams.forEach(function(p) {
if (u.searchParams.has(p)) {
u.searchParams.delete(p);
changed = true;
}
});
return changed ? u.toString() : url;
} catch (e) {
return url;
}
}
function cleanLinks() {
document.querySelectorAll('a[href]').forEach(function(a) {
var clean = cleanUrl(a.href);
if (clean !== a.href) a.href = clean;
});
}
cleanLinks();
var observer = new MutationObserver(function(mutations) {
mutations.forEach(function(m) {
m.addedNodes.forEach(function(node) {
if (node.nodeType === 1) {
if (node.tagName === 'A') cleanLinks();
node.querySelectorAll('a[href]').forEach(function(a) {
var clean = cleanUrl(a.href);
if (clean !== a.href) a.href = clean;
});
}
});
});
});
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); }
})();
(function(){
try {
var __m = "youtube.com";
var __re = new RegExp('^' + "youtube\\.com" + '
Home · devuxd/active-doc-client Wiki · GitHub
Skip to content
Home
Jump to bottom

Sahar Mehrpour edited this page Sep 28, 2023
·
14 revisions
ActiveDocumentation is implemented as IntelliJ plugin.
This tool has 2 components. The IDE connector and the Main component.
The IDE connector must be installed as a plugin for IntelliJ.
The Main component is a web-application and is executable in the browser.
Installing srcML
Install srcML version 0.9.5 from http://131.123.42.38/lmcrs/beta/
macOs
If the operating system is macOS and the installation failed with incompatible version errors, use the following instruction:
  1. Install the following packages with homebrew:

    • antlr2
    • boost
    • cmake
  2. Then from the El Capitan package (also available in this package), put the executable srcml file in /usr/local/bin and libsrcml.dylib in /usr/local/lib.
Windows
  1. Make sure you are installing srcML 0.9.5. The current srcML version is 1.0.0, so you will have to go to the "previous releases" link at the bottom of the "srcML Download" page.
  2. On Windows, use the installation wizard to install srcML.
  3. Make sure the path that is selected for installation is "C:\Program Files\srcML 0.9.5". On Windows, this is likely not the default installation path, so be sure to change it if not.
In the case that you install srcML, but run the console and get the error:
Cannot run program “C:\Program Files\srcML 0.9.5\bin\srcml” 
Because the system cannot find the file specified
In the bin folder there is a srcml.exe, it is likely that you have not:
  • installed the right version of srcML 0.9.5, and/or
  • installed srcML in the right path
Uninstall all places where srcML has been installed. Make sure you have the right srcML version. Follow the installation wizard and be sure to select the correct path for installation: "C:\Program Files\srcML 0.9.5".
Linux
When installing srcml, you may encounter the following error message: srcml: error while loading shared libraries: libcrypto.so.1.1: cannot open shared object file: No such file or directory.
This issue may arise due to differences in OpenSSL versions on modern Linux systems. To resolve this problem, please follow these steps:
  1. Download the required libssl package:
wget http://nz2.archive.ubuntu.com/ubuntu/pool/main/o/openssl/libssl1.1_1.1.1f-1ubuntu2.19_amd64.deb
  2. Install the downloaded package using dpkg (replace libssl1.1_1.1.1f-1ubuntu2.19_amd64.deb with the actual filename if it has changed):
sudo dpkg -i libssl1.1_1.1.1f-1ubuntu2.19_amd64.deb
Ensure that you are using the most up-to-date .deb files.
To verify the successful installation of the correct version of srcml and check its version:
  1. Use the following command to list the installed srcml packages:
apt list --installed | grep srcml
  2. To confirm whether srcml is correctly installed and functioning, run:
srcml <supported_file_name>
Preparing the Environment for using the tool
Download the crowdCode source code to play with the app (learningDR branch):
https://github.com/devuxd/CrowdCoding-ActiveDocumentation
There might be some errors in code (unknown libraries). As we are not going to run CrowdCode (at least for now), you can ignore them.
(Note the 3 files: ruleTable.json, tagTable.json, and spmf.jar)
Installing the IntelliJ plugin
Download the latest version of ActiveDocumentation plugin:
https://github.com/devuxd/ActiveDocumentation/blob/version4-learning-DR/ActiveDocumentationPlugin.zip
ActiveDocumentationPlugin.zip is the plugin file (Do NOT unzip the file).
Install ActiveDocumentationPlugin.zip as instructed in the official website.
https://www.jetbrains.com/help/idea/managing-plugins.html#install_plugin_from_disk
After installing the plugin, the tool starts upon opening projects in the IDE.
Installing the Web App
Download the web app of ActiveDocumentation: (learningDR branch)
https://github.com/devuxd/active-doc-client
Install the dependencies (node modules) for the app: npm install --legacy-peer-deps
Run the app:
  • Mac: npm run start-Mac
  • Linux: npm run start-Linux
  • Windows: npm run start-Windows
Notes
  • Only one project should be open in IntelliJ.
  • There should be 2 files in the root directory of the project: ruleTable.json and tagTable.json.
  • To work with mining rules, place a copy of spmf.jar in the root directory of the project.
Troubleshooting
Error in ChromePossible solution
npm run start* takes too long to startOpen active-doc-client project in Webstorm or Visual Studio (not IntelliJ) and run the script from the IDE terminal - Restart the system (to free ports)
The tool fails to connect to the IDE WebSocket connection to 'ws://localhost:8887/' failed: Error in connection establishment: net::ERR_CONNECTION_REFUSEDCheck if a project is open in IntelliJ - Restart IntelliJ - Restart the system (to free ports)
The tool doesn't show rules and tagsCheck the open project in the IDE - Restart the IDE and refresh the web app
The rules are shown, but no match or violation is detectedCheck whether srcML created the ASTs - Check the srcML version
The mined rules are not shownCheck if srcMl works properly - Check if spmf.jar library exists in the root directory of the project
Clone this wiki locally

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Auto-enable theater mode on YouTube
(function() {
function tryTheater() {
var btn = document.querySelector('button[aria-label="Theater mode"], ytd-player #player button[title="Theater mode"]');
if (btn && !btn.classList.contains('activated')) {
btn.click();
}
}
// Try immediately
tryTheater();
// Try after navigation (SPA)
var lastUrl = location.href;
setInterval(function() {
if (location.href !== lastUrl) {
lastUrl = location.href;
setTimeout(tryTheater, 500);
}
}, 1000);
// Also try on player load
var observer = new MutationObserver(tryTheater);
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
Home · devuxd/active-doc-client Wiki · GitHub
Skip to content
Home
Jump to bottom

Sahar Mehrpour edited this page Sep 28, 2023
·
14 revisions
ActiveDocumentation is implemented as IntelliJ plugin.
This tool has 2 components. The IDE connector and the Main component.
The IDE connector must be installed as a plugin for IntelliJ.
The Main component is a web-application and is executable in the browser.
Installing srcML
Install srcML version 0.9.5 from http://131.123.42.38/lmcrs/beta/
macOs
If the operating system is macOS and the installation failed with incompatible version errors, use the following instruction:
  1. Install the following packages with homebrew:

    • antlr2
    • boost
    • cmake
  2. Then from the El Capitan package (also available in this package), put the executable srcml file in /usr/local/bin and libsrcml.dylib in /usr/local/lib.
Windows
  1. Make sure you are installing srcML 0.9.5. The current srcML version is 1.0.0, so you will have to go to the "previous releases" link at the bottom of the "srcML Download" page.
  2. On Windows, use the installation wizard to install srcML.
  3. Make sure the path that is selected for installation is "C:\Program Files\srcML 0.9.5". On Windows, this is likely not the default installation path, so be sure to change it if not.
In the case that you install srcML, but run the console and get the error:
Cannot run program “C:\Program Files\srcML 0.9.5\bin\srcml” 
Because the system cannot find the file specified
In the bin folder there is a srcml.exe, it is likely that you have not:
  • installed the right version of srcML 0.9.5, and/or
  • installed srcML in the right path
Uninstall all places where srcML has been installed. Make sure you have the right srcML version. Follow the installation wizard and be sure to select the correct path for installation: "C:\Program Files\srcML 0.9.5".
Linux
When installing srcml, you may encounter the following error message: srcml: error while loading shared libraries: libcrypto.so.1.1: cannot open shared object file: No such file or directory.
This issue may arise due to differences in OpenSSL versions on modern Linux systems. To resolve this problem, please follow these steps:
  1. Download the required libssl package:
wget http://nz2.archive.ubuntu.com/ubuntu/pool/main/o/openssl/libssl1.1_1.1.1f-1ubuntu2.19_amd64.deb
  2. Install the downloaded package using dpkg (replace libssl1.1_1.1.1f-1ubuntu2.19_amd64.deb with the actual filename if it has changed):
sudo dpkg -i libssl1.1_1.1.1f-1ubuntu2.19_amd64.deb
Ensure that you are using the most up-to-date .deb files.
To verify the successful installation of the correct version of srcml and check its version:
  1. Use the following command to list the installed srcml packages:
apt list --installed | grep srcml
  2. To confirm whether srcml is correctly installed and functioning, run:
srcml <supported_file_name>
Preparing the Environment for using the tool
Download the crowdCode source code to play with the app (learningDR branch):
https://github.com/devuxd/CrowdCoding-ActiveDocumentation
There might be some errors in code (unknown libraries). As we are not going to run CrowdCode (at least for now), you can ignore them.
(Note the 3 files: ruleTable.json, tagTable.json, and spmf.jar)
Installing the IntelliJ plugin
Download the latest version of ActiveDocumentation plugin:
https://github.com/devuxd/ActiveDocumentation/blob/version4-learning-DR/ActiveDocumentationPlugin.zip
ActiveDocumentationPlugin.zip is the plugin file (Do NOT unzip the file).
Install ActiveDocumentationPlugin.zip as instructed in the official website.
https://www.jetbrains.com/help/idea/managing-plugins.html#install_plugin_from_disk
After installing the plugin, the tool starts upon opening projects in the IDE.
Installing the Web App
Download the web app of ActiveDocumentation: (learningDR branch)
https://github.com/devuxd/active-doc-client
Install the dependencies (node modules) for the app: npm install --legacy-peer-deps
Run the app:
  • Mac: npm run start-Mac
  • Linux: npm run start-Linux
  • Windows: npm run start-Windows
Notes
  • Only one project should be open in IntelliJ.
  • There should be 2 files in the root directory of the project: ruleTable.json and tagTable.json.
  • To work with mining rules, place a copy of spmf.jar in the root directory of the project.
Troubleshooting
Error in ChromePossible solution
npm run start* takes too long to startOpen active-doc-client project in Webstorm or Visual Studio (not IntelliJ) and run the script from the IDE terminal - Restart the system (to free ports)
The tool fails to connect to the IDE WebSocket connection to 'ws://localhost:8887/' failed: Error in connection establishment: net::ERR_CONNECTION_REFUSEDCheck if a project is open in IntelliJ - Restart IntelliJ - Restart the system (to free ports)
The tool doesn't show rules and tagsCheck the open project in the IDE - Restart the IDE and refresh the web app
The rules are shown, but no match or violation is detectedCheck whether srcML created the ASTs - Check the srcML version
The mined rules are not shownCheck if srcMl works properly - Check if spmf.jar library exists in the root directory of the project
Clone this wiki locally

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Remove or un-stick sticky/fixed headers that block content
(function() {
function unstick() {
document.querySelectorAll('header, nav, [role="banner"], .header, .navbar, .sticky, .fixed-top, [style*="position: fixed"], [style*="position:sticky"]').forEach(function(el) {
if (el.style.position === 'fixed' || el.style.position === 'sticky' || getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {
el.style.position = 'static';
el.style.top = 'auto';
el.style.zIndex = 'auto';
}
});
}
unstick();
var observer = new MutationObserver(unstick);
observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });
})();
}
} catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
Home · devuxd/active-doc-client Wiki · GitHub
Skip to content
Home
Jump to bottom

Sahar Mehrpour edited this page Sep 28, 2023
·
14 revisions
ActiveDocumentation is implemented as IntelliJ plugin.
This tool has 2 components. The IDE connector and the Main component.
The IDE connector must be installed as a plugin for IntelliJ.
The Main component is a web-application and is executable in the browser.
Installing srcML
Install srcML version 0.9.5 from http://131.123.42.38/lmcrs/beta/
macOs
If the operating system is macOS and the installation failed with incompatible version errors, use the following instruction:
  1. Install the following packages with homebrew:

    • antlr2
    • boost
    • cmake
  2. Then from the El Capitan package (also available in this package), put the executable srcml file in /usr/local/bin and libsrcml.dylib in /usr/local/lib.
Windows
  1. Make sure you are installing srcML 0.9.5. The current srcML version is 1.0.0, so you will have to go to the "previous releases" link at the bottom of the "srcML Download" page.
  2. On Windows, use the installation wizard to install srcML.
  3. Make sure the path that is selected for installation is "C:\Program Files\srcML 0.9.5". On Windows, this is likely not the default installation path, so be sure to change it if not.
In the case that you install srcML, but run the console and get the error:
Cannot run program “C:\Program Files\srcML 0.9.5\bin\srcml” 
Because the system cannot find the file specified
In the bin folder there is a srcml.exe, it is likely that you have not:
  • installed the right version of srcML 0.9.5, and/or
  • installed srcML in the right path
Uninstall all places where srcML has been installed. Make sure you have the right srcML version. Follow the installation wizard and be sure to select the correct path for installation: "C:\Program Files\srcML 0.9.5".
Linux
When installing srcml, you may encounter the following error message: srcml: error while loading shared libraries: libcrypto.so.1.1: cannot open shared object file: No such file or directory.
This issue may arise due to differences in OpenSSL versions on modern Linux systems. To resolve this problem, please follow these steps:
  1. Download the required libssl package:
wget http://nz2.archive.ubuntu.com/ubuntu/pool/main/o/openssl/libssl1.1_1.1.1f-1ubuntu2.19_amd64.deb
  2. Install the downloaded package using dpkg (replace libssl1.1_1.1.1f-1ubuntu2.19_amd64.deb with the actual filename if it has changed):
sudo dpkg -i libssl1.1_1.1.1f-1ubuntu2.19_amd64.deb
Ensure that you are using the most up-to-date .deb files.
To verify the successful installation of the correct version of srcml and check its version:
  1. Use the following command to list the installed srcml packages:
apt list --installed | grep srcml
  2. To confirm whether srcml is correctly installed and functioning, run:
srcml <supported_file_name>
Preparing the Environment for using the tool
Download the crowdCode source code to play with the app (learningDR branch):
https://github.com/devuxd/CrowdCoding-ActiveDocumentation
There might be some errors in code (unknown libraries). As we are not going to run CrowdCode (at least for now), you can ignore them.
(Note the 3 files: ruleTable.json, tagTable.json, and spmf.jar)
Installing the IntelliJ plugin
Download the latest version of ActiveDocumentation plugin:
https://github.com/devuxd/ActiveDocumentation/blob/version4-learning-DR/ActiveDocumentationPlugin.zip
ActiveDocumentationPlugin.zip is the plugin file (Do NOT unzip the file).
Install ActiveDocumentationPlugin.zip as instructed in the official website.
https://www.jetbrains.com/help/idea/managing-plugins.html#install_plugin_from_disk
After installing the plugin, the tool starts upon opening projects in the IDE.
Installing the Web App
Download the web app of ActiveDocumentation: (learningDR branch)
https://github.com/devuxd/active-doc-client
Install the dependencies (node modules) for the app: npm install --legacy-peer-deps
Run the app:
  • Mac: npm run start-Mac
  • Linux: npm run start-Linux
  • Windows: npm run start-Windows
Notes
  • Only one project should be open in IntelliJ.
  • There should be 2 files in the root directory of the project: ruleTable.json and tagTable.json.
  • To work with mining rules, place a copy of spmf.jar in the root directory of the project.
Troubleshooting
Error in ChromePossible solution
npm run start* takes too long to startOpen active-doc-client project in Webstorm or Visual Studio (not IntelliJ) and run the script from the IDE terminal - Restart the system (to free ports)
The tool fails to connect to the IDE WebSocket connection to 'ws://localhost:8887/' failed: Error in connection establishment: net::ERR_CONNECTION_REFUSEDCheck if a project is open in IntelliJ - Restart IntelliJ - Restart the system (to free ports)
The tool doesn't show rules and tagsCheck the open project in the IDE - Restart the IDE and refresh the web app
The rules are shown, but no match or violation is detectedCheck whether srcML created the ASTs - Check the srcML version
The mined rules are not shownCheck if srcMl works properly - Check if spmf.jar library exists in the root directory of the project
Clone this wiki locally

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Universal Dark Mode - works on any site
(function() {
var enabled = true;
function applyDarkMode() {
if (!enabled) return;
// Create style element if it doesn't exist
var style = document.getElementById('universal-dark-mode-style');
if (!style) {
style = document.createElement('style');
style.id = 'universal-dark-mode-style';
document.head.appendChild(style);
}
// Dark mode CSS - inverts colors but preserves images/video
style.textContent = '
/* Invert everything except media */
html {
filter: invert(1) hue-rotate(180deg) !important;
background: #1a1a2e !important;
}
/* Restore images, videos, iframes, canvas */
img, video, iframe, canvas, svg, picture, [style*="background-image"] {
filter: invert(1) hue-rotate(180deg) !important;
}
/* Preserve specific elements that should not be inverted */
.no-dark-mode, .no-dark-mode *,
[data-theme="light"], [data-theme="light"],
.ace_editor, .ace_editor *,
.CodeMirror, .CodeMirror *,
.monaco-editor, .monaco-editor *,
.markdown-body pre, .markdown-body pre *,
.highlight, .highlight *,
pre code, pre code * {
filter: none !important;
}
/* Fix common UI elements */
.modal, .popup, .dropdown-menu, .tooltip, .popover {
filter: invert(1) hue-rotate(180deg) !important;
background: #2d2d44 !important;
border-color: #444 !important;
}
/* Scrollbars */
::-webkit-scrollbar { background: #1a1a2e !important; }
::-webkit-scrollbar-thumb { background: #444 !important; }
::-webkit-scrollbar-thumb:hover { background: #555 !important; }
/* Selection */
::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }
::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }
';
}
function removeDarkMode() {
var style = document.getElementById('universal-dark-mode-style');
if (style) style.remove();
}
// Toggle with Alt+Shift+D
document.addEventListener('keydown', function(e) {
if (e.altKey && e.shiftKey && e.key === 'D') {
e.preventDefault();
enabled = !enabled;
if (enabled) {
applyDarkMode();
console.log('[Universal Dark Mode] Enabled');
} else {
removeDarkMode();
console.log('[Universal Dark Mode] Disabled');
}
}
});
// Apply on load
applyDarkMode();
// Re-apply on dynamic content
var observer = new MutationObserver(function(mutations) {
if (enabled && !document.getElementById('universal-dark-mode-style')) {
applyDarkMode();
}
});
observer.observe(document.head, { childList: true });
console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');
})();
}
} catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); }
})();
})();
Home · devuxd/active-doc-client Wiki · GitHub
Skip to content
Home
Jump to bottom

Sahar Mehrpour edited this page Sep 28, 2023
·
14 revisions
ActiveDocumentation is implemented as IntelliJ plugin.
This tool has 2 components. The IDE connector and the Main component.
The IDE connector must be installed as a plugin for IntelliJ.
The Main component is a web-application and is executable in the browser.
Installing srcML
Install srcML version 0.9.5 from http://131.123.42.38/lmcrs/beta/
macOs
If the operating system is macOS and the installation failed with incompatible version errors, use the following instruction:
  1. Install the following packages with homebrew:

    • antlr2
    • boost
    • cmake
  2. Then from the El Capitan package (also available in this package), put the executable srcml file in /usr/local/bin and libsrcml.dylib in /usr/local/lib.
Windows
  1. Make sure you are installing srcML 0.9.5. The current srcML version is 1.0.0, so you will have to go to the "previous releases" link at the bottom of the "srcML Download" page.
  2. On Windows, use the installation wizard to install srcML.
  3. Make sure the path that is selected for installation is "C:\Program Files\srcML 0.9.5". On Windows, this is likely not the default installation path, so be sure to change it if not.
In the case that you install srcML, but run the console and get the error:
Cannot run program “C:\Program Files\srcML 0.9.5\bin\srcml” 
Because the system cannot find the file specified
In the bin folder there is a srcml.exe, it is likely that you have not:
  • installed the right version of srcML 0.9.5, and/or
  • installed srcML in the right path
Uninstall all places where srcML has been installed. Make sure you have the right srcML version. Follow the installation wizard and be sure to select the correct path for installation: "C:\Program Files\srcML 0.9.5".
Linux
When installing srcml, you may encounter the following error message: srcml: error while loading shared libraries: libcrypto.so.1.1: cannot open shared object file: No such file or directory.
This issue may arise due to differences in OpenSSL versions on modern Linux systems. To resolve this problem, please follow these steps:
  1. Download the required libssl package:
wget http://nz2.archive.ubuntu.com/ubuntu/pool/main/o/openssl/libssl1.1_1.1.1f-1ubuntu2.19_amd64.deb
  2. Install the downloaded package using dpkg (replace libssl1.1_1.1.1f-1ubuntu2.19_amd64.deb with the actual filename if it has changed):
sudo dpkg -i libssl1.1_1.1.1f-1ubuntu2.19_amd64.deb
Ensure that you are using the most up-to-date .deb files.
To verify the successful installation of the correct version of srcml and check its version:
  1. Use the following command to list the installed srcml packages:
apt list --installed | grep srcml
  2. To confirm whether srcml is correctly installed and functioning, run:
srcml <supported_file_name>
Preparing the Environment for using the tool
Download the crowdCode source code to play with the app (learningDR branch):
https://github.com/devuxd/CrowdCoding-ActiveDocumentation
There might be some errors in code (unknown libraries). As we are not going to run CrowdCode (at least for now), you can ignore them.
(Note the 3 files: ruleTable.json, tagTable.json, and spmf.jar)
Installing the IntelliJ plugin
Download the latest version of ActiveDocumentation plugin:
https://github.com/devuxd/ActiveDocumentation/blob/version4-learning-DR/ActiveDocumentationPlugin.zip
ActiveDocumentationPlugin.zip is the plugin file (Do NOT unzip the file).
Install ActiveDocumentationPlugin.zip as instructed in the official website.
https://www.jetbrains.com/help/idea/managing-plugins.html#install_plugin_from_disk
After installing the plugin, the tool starts upon opening projects in the IDE.
Installing the Web App
Download the web app of ActiveDocumentation: (learningDR branch)
https://github.com/devuxd/active-doc-client
Install the dependencies (node modules) for the app: npm install --legacy-peer-deps
Run the app:
  • Mac: npm run start-Mac
  • Linux: npm run start-Linux
  • Windows: npm run start-Windows
Notes
  • Only one project should be open in IntelliJ.
  • There should be 2 files in the root directory of the project: ruleTable.json and tagTable.json.
  • To work with mining rules, place a copy of spmf.jar in the root directory of the project.
Troubleshooting
Error in ChromePossible solution
npm run start* takes too long to startOpen active-doc-client project in Webstorm or Visual Studio (not IntelliJ) and run the script from the IDE terminal - Restart the system (to free ports)
The tool fails to connect to the IDE WebSocket connection to 'ws://localhost:8887/' failed: Error in connection establishment: net::ERR_CONNECTION_REFUSEDCheck if a project is open in IntelliJ - Restart IntelliJ - Restart the system (to free ports)
The tool doesn't show rules and tagsCheck the open project in the IDE - Restart the IDE and refresh the web app
The rules are shown, but no match or violation is detectedCheck whether srcML created the ASTs - Check the srcML version
The mined rules are not shownCheck if srcMl works properly - Check if spmf.jar library exists in the root directory of the project
Clone this wiki locally