mabuseif commited on
Commit
6be408d
·
verified ·
1 Parent(s): 690cf25

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +14 -109
README.md CHANGED
@@ -1,109 +1,14 @@
1
- # Smart Context Citation (SCC) Tool
2
-
3
- A Python-based tool designed for Hugging Face Spaces that automates the implementation of the Smart Context Citation (SCC) referencing style.
4
-
5
- ## Overview
6
-
7
- 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.
8
-
9
- ## Features
10
-
11
- ### Citation Generator Tab
12
- - Input fields for username, task name, author name, publication year, source URL, and cited text
13
- - Automatic date and time display (Melbourne, Australia timezone)
14
- - Generation of SCC-compliant citations in HTML and plaintext formats
15
- - SHA-256 hash generation for citation integrity
16
- - Copy-to-clipboard functionality for all outputs
17
- - Warning system for URLs that already contain text fragments
18
- - Comprehensive SCC style documentation and instructions
19
-
20
- ### Verify Citation Tab
21
- - Hash verification system to check citation authenticity
22
- - Table display of verification history
23
- - Download verification history as CSV file
24
- - Support for multiple hash verification
25
-
26
- ## SCC Style Benefits
27
-
28
- - **Integrity**: Prevents citation manipulation or fabrication
29
- - **Transparency**: Readers see exactly what was cited
30
- - **Efficiency**: Eliminates duplication in reference lists
31
- - **Digital Fluency**: Reflects real-world web-based research behavior
32
- - **AI-Resistant**: Makes it difficult for GenAI tools to generate fake or superficial citations
33
-
34
- ## Installation and Setup
35
-
36
- ### For Hugging Face Spaces
37
-
38
- 1. Create a new Space on Hugging Face
39
- 2. Upload the following files:
40
- - `app.py` (main application)
41
- - `requirements.txt` (dependencies)
42
- - `README.md` (this file)
43
- 3. Set the Space SDK to "Streamlit"
44
- 4. The app will automatically deploy
45
-
46
- ### For Local Development
47
-
48
- 1. Clone or download the repository
49
- 2. Install dependencies:
50
- ```bash
51
- pip install -r requirements.txt
52
- ```
53
- 3. Run the application:
54
- ```bash
55
- streamlit run app.py
56
- ```
57
-
58
- ## Usage Examples
59
-
60
- ### Example Citation Generation
61
-
62
- **Input:**
63
- - Author: `Abuseif et al.`
64
- - Year: `2025`
65
- - URL: `https://www.sciencedirect.com/science/article/pii/S2772411523000046`
66
- - Text: `A proposed design framework for green roof settings in general and trees on buildings`
67
-
68
- **Output (HTML):**
69
- ```html
70
- <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>
71
- ```
72
-
73
- **Output (Plaintext):**
74
- ```
75
- (Abuseif et al., 2025) [hash: a78c45f91e2d...]
76
- ```
77
-
78
- ## Technical Details
79
-
80
- ### Hash Generation
81
- The SHA-256 hash is generated from the concatenated string:
82
- ```
83
- Author, Year | URL | Fragment text | Cited text | username | task name | date | time
84
- ```
85
-
86
- ### Text Fragment Support
87
- The tool uses the Text Fragments WICG specification to create URLs that highlight specific text passages in modern browsers using the `#:~:text=` syntax.
88
-
89
- ## Dependencies
90
-
91
- - `streamlit`: Web application framework
92
- - `pytz`: Timezone handling for Melbourne, Australia timezone
93
- - `pandas`: Data manipulation for verification history
94
-
95
- ## Creator
96
-
97
- Developed by: Dr Majed Abuseif
98
- School of Architecture and Built Environment
99
- Deakin University
100
- © 2025
101
-
102
- ## Technical Legitimacy
103
-
104
- This tool references the [Text Fragments WICG specification](https://wicg.github.io/scroll-to-text-fragment/) to reinforce the technical legitimacy of the approach.
105
-
106
- ## License
107
-
108
- © 2025 Dr Majed Abuseif, Deakin University. All rights reserved.
109
-
 
1
+ ---
2
+ title: SCC
3
+ emoji: 🚀
4
+ colorFrom: red
5
+ colorTo: red
6
+ sdk: docker
7
+ app_port: 8501
8
+ tags:
9
+ - streamlit
10
+ pinned: false
11
+ short_description: Smart Context Citation Tool
12
+ ---
13
+
14
+ # Welcome to Streamlit!