Upload 3 files

README.md

@@ -1,19 +1,109 @@
----
-title: SCC
-emoji: 🚀
-colorFrom: red
-colorTo: red
-sdk: docker
-app_port: 8501
-tags:
-- streamlit
-pinned: false
-short_description: Smart Context Citation Tool
----
-
-# Welcome to Streamlit!
-
-Edit `/src/streamlit_app.py` to customize this app to your heart's desire. :heart:
-
-If you have any questions, checkout our [documentation](https://docs.streamlit.io) and [community
-forums](https://discuss.streamlit.io).
+# Smart Context Citation (SCC) Tool
+
+A Python-based tool designed for Hugging Face Spaces that automates the implementation of the Smart Context Citation (SCC) referencing style.
+
+## Overview
+
+The Smart Context Citation (SCC) style is a next-generation digital referencing system designed to address the evolving landscape of academic writing in the age of Generative AI (GenAI) and online information dependency. It redefines citation practices by embedding citation context directly in the document, eliminating the need for traditional reference lists, and using cryptographic hash signatures to ensure citation integrity.
+
+## Features
+
+### Citation Generator Tab
+- Input fields for username, task name, author name, publication year, source URL, and cited text
+- Automatic date and time display (Melbourne, Australia timezone)
+- Generation of SCC-compliant citations in HTML and plaintext formats
+- SHA-256 hash generation for citation integrity
+- Copy-to-clipboard functionality for all outputs
+- Warning system for URLs that already contain text fragments
+- Comprehensive SCC style documentation and instructions
+
+### Verify Citation Tab
+- Hash verification system to check citation authenticity
+- Table display of verification history
+- Download verification history as CSV file
+- Support for multiple hash verification
+
+## SCC Style Benefits
+
+- **Integrity**: Prevents citation manipulation or fabrication
+- **Transparency**: Readers see exactly what was cited
+- **Efficiency**: Eliminates duplication in reference lists
+- **Digital Fluency**: Reflects real-world web-based research behavior
+- **AI-Resistant**: Makes it difficult for GenAI tools to generate fake or superficial citations
+
+## Installation and Setup
+
+### For Hugging Face Spaces
+
+1. Create a new Space on Hugging Face
+2. Upload the following files:
+   - `app.py` (main application)
+   - `requirements.txt` (dependencies)
+   - `README.md` (this file)
+3. Set the Space SDK to "Streamlit"
+4. The app will automatically deploy
+
+### For Local Development
+
+1. Clone or download the repository
+2. Install dependencies:
+   ```bash
+   pip install -r requirements.txt
+   ```
+3. Run the application:
+   ```bash
+   streamlit run app.py
+   ```
+
+## Usage Examples
+
+### Example Citation Generation
+
+**Input:**
+- Author: `Abuseif et al.`
+- Year: `2025`
+- URL: `https://www.sciencedirect.com/science/article/pii/S2772411523000046`
+- Text: `A proposed design framework for green roof settings in general and trees on buildings`
+
+**Output (HTML):**
+```html
+<a href="https://www.sciencedirect.com/science/article/pii/S2772411523000046#:~:text=A%20proposed%20design%20framework%20for%20green%20roof%20settings%20in%20general%20and%20trees%20on%20buildings" data-hash="[GENERATED_HASH]">(Abuseif et al., 2025)</a>
+```
+
+**Output (Plaintext):**
+```
+(Abuseif et al., 2025) [hash: a78c45f91e2d...]
+```
+
+## Technical Details
+
+### Hash Generation
+The SHA-256 hash is generated from the concatenated string:
+```
+Author, Year | URL | Fragment text | Cited text | username | task name | date | time
+```
+
+### Text Fragment Support
+The tool uses the Text Fragments WICG specification to create URLs that highlight specific text passages in modern browsers using the `#:~:text=` syntax.
+
+## Dependencies
+
+- `streamlit`: Web application framework
+- `pytz`: Timezone handling for Melbourne, Australia timezone
+- `pandas`: Data manipulation for verification history
+
+## Creator
+
+Developed by: Dr Majed Abuseif  
+School of Architecture and Built Environment  
+Deakin University  
+© 2025
+
+## Technical Legitimacy
+
+This tool references the [Text Fragments WICG specification](https://wicg.github.io/scroll-to-text-fragment/) to reinforce the technical legitimacy of the approach.
+
+## License
+
+© 2025 Dr Majed Abuseif, Deakin University. All rights reserved.
+

app.py

@@ -0,0 +1,480 @@
+
+import streamlit as st
+import hashlib
+import urllib.parse
+from datetime import datetime
+import pytz
+import pandas as pd
+import json
+
+# --- Constants ---
+MELBOURNE_TIMEZONE = 'Australia/Melbourne'
+
+# --- Custom CSS for enhanced UI ---
+def load_css():
+    st.markdown("""
+    <style>
+    .main-header {
+        background: linear-gradient(90deg, #667eea 0%, #764ba2 100%);
+        padding: 2rem;
+        border-radius: 10px;
+        color: white;
+        text-align: center;
+        margin-bottom: 2rem;
+        box-shadow: 0 4px 6px rgba(0, 0, 0, 0.1);
+    }
+    
+    .citation-output {
+        background: #f8f9fa;
+        border: 2px solid #e9ecef;
+        border-radius: 8px;
+        padding: 1rem;
+        margin: 1rem 0;
+        font-family: 'Courier New', monospace;
+        position: relative;
+    }
+    
+    .copy-button {
+        background: #28a745;
+        color: white;
+        border: none;
+        padding: 0.5rem 1rem;
+        border-radius: 5px;
+        cursor: pointer;
+        font-size: 0.9rem;
+        margin-top: 0.5rem;
+        transition: background-color 0.3s;
+    }
+    
+    .copy-button:hover {
+        background: #218838;
+    }
+    
+    .warning-box {
+        background: #fff3cd;
+        border: 1px solid #ffeaa7;
+        border-radius: 8px;
+        padding: 1rem;
+        margin: 1rem 0;
+        color: #856404;
+    }
+    
+    .success-box {
+        background: #d4edda;
+        border: 1px solid #c3e6cb;
+        border-radius: 8px;
+        padding: 1rem;
+        margin: 1rem 0;
+        color: #155724;
+    }
+    
+    .info-card {
+        background: white;
+        border-radius: 10px;
+        padding: 1.5rem;
+        box-shadow: 0 2px 4px rgba(0, 0, 0, 0.1);
+        margin: 1rem 0;
+        border-left: 4px solid #667eea;
+    }
+    
+    .creator-info {
+        background: linear-gradient(135deg, #667eea 0%, #764ba2 100%);
+        color: white;
+        padding: 1rem;
+        border-radius: 8px;
+        text-align: center;
+        margin: 2rem 0;
+        font-size: 0.9rem;
+    }
+    
+    .hash-display {
+        background: #f1f3f4;
+        border: 1px solid #dadce0;
+        border-radius: 6px;
+        padding: 1rem;
+        font-family: 'Courier New', monospace;
+        font-size: 0.85rem;
+        word-break: break-all;
+        margin: 0.5rem 0;
+    }
+    
+    .tab-content {
+        padding: 2rem 0;
+    }
+    
+    .form-section {
+        background: white;
+        padding: 2rem;
+        border-radius: 10px;
+        box-shadow: 0 2px 8px rgba(0, 0, 0, 0.1);
+        margin: 1rem 0;
+    }
+    
+    .datetime-display {
+        background: #e3f2fd;
+        border-radius: 6px;
+        padding: 0.8rem;
+        margin: 0.5rem 0;
+        border-left: 4px solid #2196f3;
+    }
+    
+    .verification-table {
+        margin: 1rem 0;
+        border-radius: 8px;
+        overflow: hidden;
+        box-shadow: 0 2px 4px rgba(0, 0, 0, 0.1);
+    }
+    </style>
+    """, unsafe_allow_html=True)
+
+# --- Helper Functions ---
+def generate_citation_hash(author, year, url, fragment_text, cited_text, username, task_name, current_date, current_time):
+    data = f"{author}, {year} | {url} | {fragment_text} | {cited_text} | {username} | {task_name} | {current_date} | {current_time}"
+    return hashlib.sha256(data.encode('utf-8')).hexdigest()
+
+def format_citation_html(url, fragment_text, author, year, scc_hash):
+    encoded_fragment = urllib.parse.quote(fragment_text)
+    full_url = f"{url}#:~:text={encoded_fragment}"
+    return f'<a href="{full_url}" data-hash="{scc_hash}">({author}, {year})</a>'
+
+def format_citation_plaintext(author, year, scc_hash):
+    return f'({author}, {year}) [hash: {scc_hash[:12]}...]'
+
+def check_for_fragment(url):
+    return '#:~:text=' in url
+
+def copy_to_clipboard_js(text, button_id):
+    """Generate JavaScript for copying text to clipboard"""
+    return f"""
+    <script>
+    function copyToClipboard_{button_id}() {{
+        navigator.clipboard.writeText(`{text}`).then(function() {{
+            document.getElementById('copy_status_{button_id}').innerHTML = '✅ Copied!';
+            setTimeout(function() {{
+                document.getElementById('copy_status_{button_id}').innerHTML = '';
+            }}, 2000);
+        }}, function(err) {{
+            document.getElementById('copy_status_{button_id}').innerHTML = '❌ Copy failed';
+            console.error('Could not copy text: ', err);
+        }});
+    }}
+    </script>
+    <button onclick="copyToClipboard_{button_id}()" class="copy-button">📋 Copy to Clipboard</button>
+    <span id="copy_status_{button_id}" style="margin-left: 10px; color: green; font-weight: bold;"></span>
+    """
+
+# --- Streamlit App ---
+st.set_page_config(layout="wide", page_title="Smart Context Citation Tool", page_icon="📚")
+
+# Load custom CSS
+load_css()
+
+# Main header
+st.markdown("""
+<div class="main-header">
+    <h1>📚 Smart Context Citation (SCC) Tool</h1>
+    <p>Next-generation digital referencing system for the age of Generative AI</p>
+</div>
+""", unsafe_allow_html=True)
+
+# Creator information
+st.markdown("""
+<div class="creator-info">
+    <strong>Developed by:</strong> Dr Majed Abuseif<br>
+    School of Architecture and Built Environment<br>
+    Deakin University<br>
+    © 2025
+</div>
+""", unsafe_allow_html=True)
+
+st.sidebar.header("📖 About SCC")
+st.sidebar.markdown("""
+<div class="info-card">
+The Smart Context Citation (SCC) style is a next-generation digital referencing system designed for the age of Generative AI. It embeds citation context directly in the document, uses cryptographic hash signatures for integrity, and eliminates traditional reference lists.
+
+<strong>🎯 Purpose:</strong> Transparency, integrity, and digital fluency in citations.
+
+<strong>🏗️ Structure:</strong>
+• Inline general author name and date style citation
+• Hyperlinked URL with text fragment (#:~:text=)
+• SHA-256 hash for verification
+
+<strong>✨ Benefits:</strong> Enhances fairness, integrates with source contexts, promotes digital fluency, prevents fabrication, and eliminates traditional reference lists.
+
+<strong>🔗 Technical Legitimacy:</strong> Referencing the <a href="https://wicg.github.io/scroll-to-text-fragment/" target="_blank">Text Fragments WICG specification</a> for technical legitimacy.
+</div>
+""", unsafe_allow_html=True)
+
+st.sidebar.header("💡 Example Citation")
+st.sidebar.markdown("""
+<div class="info-card">
+<strong>📝 Input:</strong><br>
+• Author: <code>Abuseif et al.</code><br>
+• Year: <code>2025</code><br>
+• URL: <code>https://www.sciencedirect.com/science/article/pii/S2772411523000046</code><br>
+• Text: <code>A proposed design framework for green roof settings in general and trees on buildings</code>
+
+<strong>📤 Output (HTML - example hash):</strong><br>
+<div class="hash-display">
+&lt;a href="https://www.sciencedirect.com/science/article/pii/S2772411523000046#:~:text=A%20proposed%20design%20framework%20for%20green%20roof%20settings%20in%20general%20and%20trees%20on%20buildings" data-hash="[GENERATED_HASH]"&gt;(Abuseif et al., 2025)&lt;/a&gt;
+</div>
+</div>
+""", unsafe_allow_html=True)
+
+tabs = st.tabs(["🔧 Citation Generator", "✅ Verify Citation"])
+
+with tabs[0]:
+    st.markdown('<div class="tab-content">', unsafe_allow_html=True)
+    st.header("🔧 Generate New Citation")
+
+    with st.container():
+        st.markdown('<div class="form-section">', unsafe_allow_html=True)
+        
+        col1, col2 = st.columns(2)
+        
+        with col1:
+            username = st.text_input("👤 Username", help="Your username for tracking purposes", placeholder="e.g., john_doe")
+            task_name = st.text_input("📋 Task Name", help="The name of the task or project", placeholder="e.g., Literature Review Assignment")
+            author_name = st.text_input("✍️ Author Name", help="The author(s) of the source", placeholder="e.g., Smith or Smith et al.")
+        
+        with col2:
+            publication_year = st.text_input("📅 Publication Year", help="The year of publication", placeholder="e.g., 2023")
+            source_url = st.text_input("🔗 Source URL", help="The full URL of the source", placeholder="https://example.com/article")
+        
+        cited_text = st.text_area("📝 Quoted or Paraphrased Text", 
+                                 help="The exact text quoted or paraphrased from the source", 
+                                 placeholder="e.g., Thermal comfort thresholds are exceeded frequently in Australian schools",
+                                 height=100)
+
+        # Get current date and time in Melbourne timezone
+        melbourne_tz = pytz.timezone(MELBOURNE_TIMEZONE)
+        current_datetime_melbourne = datetime.now(melbourne_tz)
+        current_date = current_datetime_melbourne.strftime("%Y-%m-%d")
+        current_time = current_datetime_melbourne.strftime("%H:%M:%S")
+
+        st.markdown(f"""
+        <div class="datetime-display">
+            <strong>🕐 Current Date & Time (Melbourne, Australia):</strong><br>
+            📅 Date: {current_date}<br>
+            ⏰ Time: {current_time}
+        </div>
+        """, unsafe_allow_html=True)
+
+        generate_button = st.button("🚀 Generate Citation", type="primary", use_container_width=True)
+        
+        st.markdown('</div>', unsafe_allow_html=True)
+
+        if generate_button:
+            if not all([username, task_name, author_name, publication_year, source_url, cited_text]):
+                st.error("⚠️ Please fill in all fields before generating a citation.")
+            elif check_for_fragment(source_url):
+                st.markdown("""
+                <div class="warning-box">
+                    <strong>⚠️ Warning:</strong> It seems like your URL already contains a text fragment (<code>#:~:text=</code>). 
+                    This suggests you may have used AI assistance in generating this link. Please go back to the original source, 
+                    read the context carefully, and copy the source link again without any existing fragment.
+                </div>
+                """, unsafe_allow_html=True)
+            else:
+                scc_hash = generate_citation_hash(author_name, publication_year, source_url, cited_text, cited_text, username, task_name, current_date, current_time)
+
+                st.markdown("## 🎉 Generated Citations")
+
+                # HTML Citation - Start of text
+                st.markdown("### 📝 HTML Citation (Start of Text)")
+                html_citation_start = f'"{cited_text}" ' + format_citation_html(source_url, cited_text, author_name, publication_year, scc_hash)
+                
+                st.markdown('<div class="citation-output">', unsafe_allow_html=True)
+                st.code(html_citation_start, language='html')
+                st.markdown(copy_to_clipboard_js(html_citation_start.replace('`', '\\`'), "html_start"), unsafe_allow_html=True)
+                st.markdown('</div>', unsafe_allow_html=True)
+
+                # HTML Citation - End of text
+                st.markdown("### 📝 HTML Citation (End of Text)")
+                html_citation_end = format_citation_html(source_url, cited_text, author_name, publication_year, scc_hash) + f' "{cited_text}"'
+                
+                st.markdown('<div class="citation-output">', unsafe_allow_html=True)
+                st.code(html_citation_end, language='html')
+                st.markdown(copy_to_clipboard_js(html_citation_end.replace('`', '\\`'), "html_end"), unsafe_allow_html=True)
+                st.markdown('</div>', unsafe_allow_html=True)
+
+                # Plaintext Citation
+                st.markdown("### 📄 Plaintext Citation")
+                plaintext_citation = format_citation_plaintext(author_name, publication_year, scc_hash)
+                
+                st.markdown('<div class="citation-output">', unsafe_allow_html=True)
+                st.code(plaintext_citation)
+                st.markdown(copy_to_clipboard_js(plaintext_citation, "plaintext"), unsafe_allow_html=True)
+                st.markdown('</div>', unsafe_allow_html=True)
+
+                # Citation Hash Details
+                st.markdown("### 🔐 Citation Hash Details (for Verification)")
+                hash_details = {
+                    "author": author_name,
+                    "year": publication_year,
+                    "url": source_url,
+                    "fragment_text": cited_text,
+                    "cited_text": cited_text,
+                    "username": username,
+                    "task_name": task_name,
+                    "date": current_date,
+                    "time": current_time,
+                    "hash": scc_hash
+                }
+                
+                st.markdown('<div class="hash-display">', unsafe_allow_html=True)
+                st.json(hash_details)
+                st.markdown('</div>', unsafe_allow_html=True)
+
+    # Instructions section
+    st.markdown("## 📋 Instructions for Copying to Word")
+    st.markdown("""
+    <div class="info-card">
+    <strong>To use the generated HTML citation in Microsoft Word:</strong><br><br>
+    1. 📋 Copy the desired HTML citation (Start or End of Text) using the 'Copy to Clipboard' button<br>
+    2. 📄 In Word, go to the 'Insert' tab<br>
+    3. 🔗 Click on 'Object' → 'Text from File...'<br>
+    4. 📁 Select 'HTML Document' from the file type dropdown<br>
+    5. 💾 Paste the copied HTML into a new text file (e.g., using Notepad) and save it with a <code>.html</code> extension<br>
+    6. ✅ Select this <code>.html</code> file in the 'Text from File...' dialog<br><br>
+    
+    <strong>Alternative method:</strong> You might be able to paste directly into Word and then right-click and choose 'Keep Source Formatting' or 'Merge Formatting' if available, but the 'Text from File' method is more reliable for preserving hyperlinks and data attributes.
+    </div>
+    """, unsafe_allow_html=True)
+
+    st.markdown("## 🔍 Guidance on Verifying Citations")
+    st.markdown("""
+    <div class="info-card">
+    To verify a citation, you can recompute the hash using the original input data and compare it to the embedded hash. 
+    The <strong>'Verify Citation'</strong> tab allows you to do this easily.
+    </div>
+    """, unsafe_allow_html=True)
+    
+    st.markdown('</div>', unsafe_allow_html=True)
+
+with tabs[1]:
+    st.markdown('<div class="tab-content">', unsafe_allow_html=True)
+    st.header("✅ Verify Citation")
+    st.markdown("""
+    <div class="info-card">
+    Enter the citation details below to recompute and verify the hash. This ensures the citation hasn't been tampered with or fabricated.
+    </div>
+    """, unsafe_allow_html=True)
+
+    # Initialize session state for storing verified hashes
+    if 'verified_hashes' not in st.session_state:
+        st.session_state.verified_hashes = []
+
+    with st.container():
+        st.markdown('<div class="form-section">', unsafe_allow_html=True)
+        
+        col1, col2 = st.columns(2)
+        
+        with col1:
+            verify_username = st.text_input("👤 Username (for verification)", placeholder="e.g., john_doe")
+            verify_task_name = st.text_input("📋 Task Name (for verification)", placeholder="e.g., Literature Review Assignment")
+            verify_author_name = st.text_input("✍️ Author Name (for verification)", placeholder="e.g., Smith or Smith et al.")
+            verify_publication_year = st.text_input("📅 Publication Year (for verification)", placeholder="e.g., 2023")
+        
+        with col2:
+            verify_source_url = st.text_input("🔗 Source URL (for verification)", placeholder="https://example.com/article")
+            verify_date = st.text_input("📅 Date (YYYY-MM-DD) (for verification)", placeholder="e.g., 2025-01-08")
+            verify_time = st.text_input("⏰ Time (HH:MM:SS) (for verification)", placeholder="e.g., 14:30:25")
+            expected_hash = st.text_input("🔐 Expected Hash (from the citation)", placeholder="Enter the full hash from the citation")
+        
+        verify_cited_text = st.text_area("📝 Quoted or Paraphrased Text (for verification)", 
+                                        placeholder="e.g., Thermal comfort thresholds are exceeded frequently in Australian schools",
+                                        height=100)
+
+        verify_button = st.button("🔍 Verify Hash", type="primary", use_container_width=True)
+        
+        st.markdown('</div>', unsafe_allow_html=True)
+
+        if verify_button:
+            if not all([verify_username, verify_task_name, verify_author_name, verify_publication_year, 
+                       verify_source_url, verify_cited_text, verify_date, verify_time, expected_hash]):
+                st.error("⚠️ Please fill in all fields before verifying the hash.")
+            else:
+                recomputed_hash = generate_citation_hash(
+                    verify_author_name, verify_publication_year, verify_source_url,
+                    verify_cited_text, verify_cited_text, verify_username, verify_task_name,
+                    verify_date, verify_time
+                )
+
+                if recomputed_hash == expected_hash:
+                    st.markdown("""
+                    <div class="success-box">
+                        <strong>✅ Hash verified successfully!</strong> The citation is authentic and hasn't been tampered with.
+                    </div>
+                    """, unsafe_allow_html=True)
+                    
+                    st.session_state.verified_hashes.append({
+                        "Author": verify_author_name,
+                        "Year": verify_publication_year,
+                        "URL": verify_source_url,
+                        "Fragment text": verify_cited_text,
+                        "Cited text": verify_cited_text,
+                        "Username": verify_username,
+                        "Task name": verify_task_name,
+                        "Date": verify_date,
+                        "Time": verify_time,
+                        "Original Hash": expected_hash,
+                        "Recomputed Hash": recomputed_hash,
+                        "Status": "✅ Verified"
+                    })
+                else:
+                    st.markdown("""
+                    <div class="warning-box">
+                        <strong>❌ Hash verification failed!</strong> The citation may have been altered or is not authentic.
+                    </div>
+                    """, unsafe_allow_html=True)
+                    
+                    st.session_state.verified_hashes.append({
+                        "Author": verify_author_name,
+                        "Year": verify_publication_year,
+                        "URL": verify_source_url,
+                        "Fragment text": verify_cited_text,
+                        "Cited text": verify_cited_text,
+                        "Username": verify_username,
+                        "Task name": verify_task_name,
+                        "Date": verify_date,
+                        "Time": verify_time,
+                        "Original Hash": expected_hash,
+                        "Recomputed Hash": recomputed_hash,
+                        "Status": "❌ Failed"
+                    })
+
+    if st.session_state.verified_hashes:
+        st.markdown("## 📊 Verification History")
+        df = pd.DataFrame(st.session_state.verified_hashes)
+        
+        st.markdown('<div class="verification-table">', unsafe_allow_html=True)
+        st.dataframe(df, use_container_width=True)
+        st.markdown('</div>', unsafe_allow_html=True)
+
+        # Download as CSV
+        @st.cache_data
+        def convert_df_to_csv(df):
+            return df.to_csv(index=False).encode('utf-8')
+
+        csv = convert_df_to_csv(df)
+
+        st.download_button(
+            label="📥 Download Verification History as CSV",
+            data=csv,
+            file_name="scc_verification_history.csv",
+            mime="text/csv",
+            use_container_width=True
+        )
+        
+        # Clear history button
+        if st.button("🗑️ Clear Verification History", type="secondary"):
+            st.session_state.verified_hashes = []
+            st.experimental_rerun()
+    
+    st.markdown('</div>', unsafe_allow_html=True)
+
+
+
+
+

requirements.txt

@@ -1,3 +1,4 @@
-altair
+streamlit
+pytz
 pandas
-streamlit
+