diff --git a/docs/source/development.rst b/docs/source/development.rst index 7d58b500..fa80db8e 100644 --- a/docs/source/development.rst +++ b/docs/source/development.rst @@ -202,13 +202,13 @@ Site check fixes using LLM -------------------------- .. note:: - The ``LLM/`` directory at the root of the repository contains detailed instructions for editing site checks (in Markdown format): checklist, full guide to ``checkType`` / ``data.json`` / ``urlProbe``, handling false positives, searching for public JSON APIs, and the proposal log for ``socid_extractor``. + The ``LLM/`` directory at the root of the repository contains detailed instructions for editing site checks (in Markdown format): checklist, full guide to ``checkType`` / ``data.json`` / ``urlProbe``, handling false positives, searching for public JSON APIs, and the proposal log for `socid_extractor `_. Main files: - `site-checks-playbook.md `_ — short checklist - `site-checks-guide.md `_ — detailed guide -- `socid_extractor_improvements.log `_ — template and entries for identity extractor improvements +- `socid_extractor_improvements.log `_ — template and entries for identity extractor improvements; the upstream how-to is `Adding a scheme `_ These files should be kept up-to-date whenever changes are made to the check logic in the code or in ``data.json``. diff --git a/docs/source/features.rst b/docs/source/features.rst index 329d9132..519e22a8 100644 --- a/docs/source/features.rst +++ b/docs/source/features.rst @@ -50,7 +50,7 @@ installing anything locally. Personal info gathering ----------------------- -Maigret does the `parsing of accounts webpages and extraction `_ of personal info, links to other profiles, etc. +Maigret does the `parsing of accounts webpages and extraction `_ of personal info, links to other profiles, etc. Extracted info displayed as an additional result in CLI output and as tables in HTML and PDF reports. Also, Maigret use found ids and usernames from links to start a recursive search. diff --git a/docs/source/library-usage.rst b/docs/source/library-usage.rst index c54e8029..3ba3e146 100644 --- a/docs/source/library-usage.rst +++ b/docs/source/library-usage.rst @@ -52,7 +52,7 @@ A working end-to-end search against the top 500 sites: Key points: - ``maigret_search`` is an ``async`` function — wrap it with ``asyncio.run(...)`` or ``await`` it from inside your own event loop. -- ``is_parsing_enabled=True`` turns on ``socid_extractor`` so ``result["ids_data"]`` is populated with profile fields (bio, linked accounts, uids, etc.). +- ``is_parsing_enabled=True`` turns on ``socid_extractor`` so ``result["ids_data"]`` is populated with profile fields (bio, linked accounts, uids, etc.). See its `Library usage `_ page for calling it directly, and `Maigret integration `_ for how the two projects fit together. - Each entry in the returned dict has a ``"status"`` object with ``is_found()``, plus ``url_user``, ``http_status``, ``rank``, ``ids_data``, and more. Filtering sites diff --git a/docs/source/locale/zh_CN/LC_MESSAGES/development.po b/docs/source/locale/zh_CN/LC_MESSAGES/development.po index c1a0f849..a2b68111 100644 --- a/docs/source/locale/zh_CN/LC_MESSAGES/development.po +++ b/docs/source/locale/zh_CN/LC_MESSAGES/development.po @@ -645,11 +645,11 @@ msgid "" "instructions for editing site checks (in Markdown format): checklist, " "full guide to ``checkType`` / ``data.json`` / ``urlProbe``, handling " "false positives, searching for public JSON APIs, and the proposal log for" -" ``socid_extractor``." +" `socid_extractor `_." msgstr "" "仓库根目录下的 ``LLM/`` 目录中,以 Markdown 形式保存了编辑站点检查的详细指南:检查清单、关于 ``checkType`` / " "``data.json`` / ``urlProbe`` 的完整说明、处理误报的方法、寻找公开 JSON API 的思路,以及面向 " -"``socid_extractor`` 的改动提案日志。" +"`socid_extractor `_ 的改动提案日志。" #: ../../source/development.rst:199 5d8b27e0fd99416a9e92869bc4ac64e5 msgid "Main files:" @@ -675,11 +675,14 @@ msgstr "" msgid "" "`socid_extractor_improvements.log " "`_" -" — template and entries for identity extractor improvements" +" — template and entries for identity extractor improvements; the upstream " +"how-to is `Adding a scheme " +"`_" msgstr "" "`socid_extractor_improvements.log " "`_" -" —— 身份信息抽取器改进项的模板与记录" +" —— 身份信息抽取器改进项的模板与记录;上游的操作指南参见 `Adding a scheme " +"`_" #: ../../source/development.rst:205 53286ba37db94831adda43dee21158c6 msgid "" diff --git a/docs/source/locale/zh_CN/LC_MESSAGES/features.po b/docs/source/locale/zh_CN/LC_MESSAGES/features.po index 649da966..1713508b 100644 --- a/docs/source/locale/zh_CN/LC_MESSAGES/features.po +++ b/docs/source/locale/zh_CN/LC_MESSAGES/features.po @@ -98,12 +98,14 @@ msgstr "个人信息收集" #: ../../source/features.rst:53 2913acff61f8466e80dc03285b75c54b msgid "" "Maigret does the `parsing of accounts webpages and extraction " -"`_ of personal info, links to " +"`_" +" of personal info, links to " "other profiles, etc. Extracted info displayed as an additional result in " "CLI output and as tables in HTML and PDF reports. Also, Maigret use found" " ids and usernames from links to start a recursive search." msgstr "" -"Maigret 会\\ `解析账号网页并抽取 `_ " +"Maigret 会\\ `解析账号网页并抽取 " +"`_ " "个人信息、指向其它主页的链接等内容。抽取结果会以附加信息的形式出现在 CLI 输出中,并在 HTML 和 PDF " "报告中以表格呈现。此外,Maigret 还会用从链接中发现的 ID 和用户名,启动递归搜索。" diff --git a/docs/source/locale/zh_CN/LC_MESSAGES/library-usage.po b/docs/source/locale/zh_CN/LC_MESSAGES/library-usage.po index 59346d78..4d490a20 100644 --- a/docs/source/locale/zh_CN/LC_MESSAGES/library-usage.po +++ b/docs/source/locale/zh_CN/LC_MESSAGES/library-usage.po @@ -66,10 +66,18 @@ msgstr "" msgid "" "``is_parsing_enabled=True`` turns on ``socid_extractor`` so " "``result[\"ids_data\"]`` is populated with profile fields (bio, linked " -"accounts, uids, etc.)." +"accounts, uids, etc.). See its `Library usage " +"`_ " +"page for calling it directly, and `Maigret integration " +"`_" +" for how the two projects fit together." msgstr "" "``is_parsing_enabled=True`` 会启用 ``socid_extractor``,从而把个人主页中" "的字段(个人简介、关联账号、各类 uid 等)填充到 ``result[\"ids_data\"]``\ 。" +"直接调用该库的方法参见 `Library usage " +"`_\\ ," +"两个项目如何协同参见 `Maigret integration " +"`_\\ 。" #: ../../source/library-usage.rst:56 886c9269cbf346819fd029eb0c86b1ff msgid "" diff --git a/docs/source/locale/zh_CN/LC_MESSAGES/philosophy.po b/docs/source/locale/zh_CN/LC_MESSAGES/philosophy.po index 4d8d11f4..65c445f3 100644 --- a/docs/source/locale/zh_CN/LC_MESSAGES/philosophy.po +++ b/docs/source/locale/zh_CN/LC_MESSAGES/philosophy.po @@ -87,12 +87,14 @@ msgstr "由此衍生出两个想法:" #: ../../source/philosophy.rst:35 bb7a5044518943068fff752a527be1eb msgid "" -"`socid-extractor `_ — a library" -" focused on pulling structured identity data (user IDs, full names, " +"`socid-extractor `_ " +"(`documentation `_) — a library " +"focused on pulling structured identity data (user IDs, full names, " "linked accounts, bios, timestamps, etc.) out of account pages and public " "API responses, so that finding an account is not the end of the pipeline." msgstr "" -"`socid-extractor `_ —— 一个专注于从账号页面和公开 API 响应中抽取结构化身份数据(用户 ID、真实姓名、关联账号、个人简介、时间戳等)的库,让“找到账号”不再是流水线的终点。" +"`socid-extractor `_\\ (`文档 " +"`_\\ )—— 一个专注于从账号页面和公开 API 响应中抽取结构化身份数据(用户 ID、真实姓名、关联账号、个人简介、时间戳等)的库,让“找到账号”不再是流水线的终点。" #: ../../source/philosophy.rst:38 d8778348b35e4514998f83f1ba7bb49a msgid "" diff --git a/docs/source/philosophy.rst b/docs/source/philosophy.rst index 4ff44dbc..9fae7198 100644 --- a/docs/source/philosophy.rst +++ b/docs/source/philosophy.rst @@ -32,7 +32,8 @@ For a broader landscape of username-checking tools, see the curated Two ideas grew out of that research: -- `socid-extractor `_ — a library focused on pulling +- `socid-extractor `_ + (`documentation `_) — a library focused on pulling structured identity data (user IDs, full names, linked accounts, bios, timestamps, etc.) out of account pages and public API responses, so that finding an account is not the end of the pipeline. - **Maigret** itself — which started as a fork of