From 6cd782cd4154f3ef0fa37c601eb9353bd2b2114f Mon Sep 17 00:00:00 2001 From: MythoAway7 <58316242+MythoAway7@users.noreply.github.com> Date: Sat, 6 Jan 2024 12:22:49 -0600 Subject: [PATCH 1/2] Move docs to subdomain --- .../Selection/AttributeSelection.razor | 41 ----- Pages/Docs/Content/Selection/Insertion.razor | 36 ----- Pages/Docs/Content/Selection/Limit.razor | 26 ---- Pages/Docs/Content/Selection/Selection.razor | 54 ------- .../Docs/Content/Selection/TagSelection.razor | 30 ---- .../Content/Tools/AttrubuteModifier.razor | 62 -------- Pages/Docs/Content/Tools/ColorReplacer.razor | 62 -------- Pages/Docs/Content/Tools/ListGenerator.razor | 59 ------- Pages/Docs/Content/Tools/TableGenerator.razor | 59 ------- Pages/Docs/Content/Tools/TagGenerator.razor | 59 ------- Pages/Docs/Content/Tools/Tools.razor | 32 ---- Pages/Docs/Documentation.razor | 12 -- Pages/Docs/_Imports.razor | 2 - Pages/Index.razor | 2 +- Pages/Tools/ColorReplacer.razor | 2 +- README.md | 2 +- Shared/DocumentationLayout.razor | 50 ------ Shared/DocumentationLayout.razor.css | 37 ----- Shared/LocalNavigation.razor | 17 -- Shared/MainLayout.razor | 2 +- Shared/NavMenu.razor | 145 +++++------------- 21 files changed, 40 insertions(+), 751 deletions(-) delete mode 100644 Pages/Docs/Content/Selection/AttributeSelection.razor delete mode 100644 Pages/Docs/Content/Selection/Insertion.razor delete mode 100644 Pages/Docs/Content/Selection/Limit.razor delete mode 100644 Pages/Docs/Content/Selection/Selection.razor delete mode 100644 Pages/Docs/Content/Selection/TagSelection.razor delete mode 100644 Pages/Docs/Content/Tools/AttrubuteModifier.razor delete mode 100644 Pages/Docs/Content/Tools/ColorReplacer.razor delete mode 100644 Pages/Docs/Content/Tools/ListGenerator.razor delete mode 100644 Pages/Docs/Content/Tools/TableGenerator.razor delete mode 100644 Pages/Docs/Content/Tools/TagGenerator.razor delete mode 100644 Pages/Docs/Content/Tools/Tools.razor delete mode 100644 Pages/Docs/Documentation.razor delete mode 100644 Pages/Docs/_Imports.razor delete mode 100644 Shared/DocumentationLayout.razor delete mode 100644 Shared/DocumentationLayout.razor.css delete mode 100644 Shared/LocalNavigation.razor diff --git a/Pages/Docs/Content/Selection/AttributeSelection.razor b/Pages/Docs/Content/Selection/AttributeSelection.razor deleted file mode 100644 index daa2720..0000000 --- a/Pages/Docs/Content/Selection/AttributeSelection.razor +++ /dev/null @@ -1,41 +0,0 @@ -@* Copyright (C) Jonathan Shull - See license file at github.com/amytho/pdf-acc-toolset *@ -@layout DocumentationLayout -@using Pdf_Acc_Toolset.Services.UI; -@page "/docs/selection/attribute" - -
This selection allows you to target a tag with a specific attribute. You can use this to target a specific tag anywhere in the document. You can also target multiple tags with a given attribute.
- -- You can choose any of the below attributes: -
- -- Title is the preferred attribute because most PDF programs display the title of the tag in the tree. This makes it easy to modify and see the result. You should remove the title when you are done. -
- - - - -This selection may have multiple targets. Use the limit selection feature accordingly.
- -@code { - protected override void OnInitialized() - { - // Make a new list of toc items - ListMany tools insert tags into the document. If your tools does that, you will need to choose an insertion point. The below points are available:
-- You can only insert a tag in a valid position. For example, using the before/after insertion on the document root will not work. -
- -- If your tool does not insert a tag, you can ignore this part of the selection interface. In a future version this part will be hidden in such cases. -
- -@code { - protected override void OnInitialized() - { - // Make a new list of toc items - ListMany selections will target more than one element. If this is the case, consider adding a limit. The selection will target each element. If the next element is more than the limit placed, the selection will stop.
- -- You can use the Check Matches button in the interface to see the amount of tags that were targeted. This includes the limit! If you want to see all of the tags that match a selection regardless of the limit, set the limit to its max value of 999. -
- - -@code { - protected override void OnInitialized() - { - // Make a new list of toc items - ListThe selection input allows you to modify many parts of your PDF at the same time. However, it may seem complicated to those who are not familar with it. It is well worth learning as it can save a ton of time in the remediation process.
- - -Choosing a selection can be done by asking the below questions.
-
- Do I need to run the current tool once? If so, am I comfortable moving the tag to its intended position?
-
-
- If you answered yes, choose the Document Root as the selection type. This will add the selection to the root of the document. This is the default selection because it works for most users. The tool output is easy to find and it doesn't require much thought to set up. You do have to move the tag to its final destination though.
-
-
- If you need to run the tool once, but you want it in a specific position, you must use a different selection type.
-
- If you answered no either of the above questions, you need one of the special types listed below. -
- -Once you have your selection, use the below features to finetune it. These are optional.
- - -@code { - protected override void OnInitialized() - { - // Make a new list of toc items - ListThis selection allows you to target a type of tag. This selection is commonly used for:
-This selection will likely have multiple targets. Use the limit selection feature accordingly.
- -@code { - protected override void OnInitialized() - { - // Make a new list of toc items - ListThis tool allows for mass attribute modification. You can add, edit, or remove an attribute. This tool supports the ID, Title, and Actual/Alt text attributes.
- -- Adding will add the attribute if it doesn't exist. Editing will modify the attribute regardless of if it exists. Deletion will remove the attribute. For most attributes, this will result in a blank string. -
- -Parameter | -Purpose | -
---|---|
Attribute | -The attribute to modify. | -
Action | -Add, edit, or remove a tag | -
Value (optional) | -If in add or edit mode, this will be the value of the attribute. If an attribute is being removed, this property is not used. | -
- Output of setting every image to have an alt text of "Our Logo". -
- - - -@code { - protected override void OnInitialized() - { - // Make a new list of toc items - ListThis tool allows for colors of text and shapes to be changed without breaking the tag structure. Adobe Acrobat can change the colors, but it breaks the document structure. This tool will not do that.
- -- You can modify the fill and stroke color. The document will show all of the available colors below the UI. These are what you are able to replace. This may take some time to appear depending on the size of the document. -
- -Parameter | -Purpose | -
---|---|
Color Category | -Replace the fill (inner) or the stroke (outer). Stroke is commonly used for underlining links. | -
Target Color | -This color will be replaced. Select one of the available colors from below the main UI. | -
Replacement Color | -This color will replace the target color. It uses the RGB format. | -
- Changing the text color to meet color contrast requirements. -
- - - -@code { - protected override void OnInitialized() - { - // Make a new list of toc items - ListThis tool lets you create accessible lists with ease. Each list contains all of the tags needed for accessibility. Every list has a parent List tag, a specified amount of List Items, List Item Bodies (dependent on amount of list items), and Labels (optional, also dependent on amount of list items).
- -Since this is just a tagging operation, you will still need to assign content to the list in a PDF editor.
- -Parameter | -Purpose | -
---|---|
Title (Optional) | -The title of the parent List tag. Used by the remediator for identification. | -
List Amount | -The amount of List Items to generate. | -
Add labels | -If selected, each List Item will contain a Label tag. | -
- Output with a title of "Example", 20 list items, and labels. -
- - - -@code { - protected override void OnInitialized() - { - // Make a new list of toc items - ListThis tool lets you create a table with all the required elements. You must enter the amount of rows and columns that you want generated. The first row will automatically contain header cells. You can optionally enter a title.
- -Since this is just a tagging operation, you will still need to assign content to the table in a PDF editor.
- -Parameter | -Purpose | -
---|---|
Title (Optional) | -The title of the parent Table tag. Used by the remediator for identification. | -
Column Amount | -The amount of columns to generate. This determines the amount of Table Data Cells (TD) per row. | -
Row Amount | -The amount of rows to generate. | -
- Output with a title of "Example", 20 rows, and 4 columns. -
- - - -@code { - protected override void OnInitialized() - { - // Make a new list of toc items - ListThis tool lets you create any tag dynamically. Simply enter the type of tag that you want and the amount. The tag(s) will be generated when the task is ran. Unlike the List/Table generators, this Task only generates the specified tag. Generating a List will not generate the required LI, Lbls, and LBody tags. If you need the full structure consider using those other tools instead.
- -Since this is just a tagging operation, you will still need to assign content to the tag in a PDF editor.
- -Parameter | -Purpose | -
---|---|
Group Title (Optional) | -If a title is chosen, a parent Div tag will be generated. All the tags will be contained within that parent. Used by the remediator for identification. | -
Tag Amount | -The amount of tags to generate. | -
Tag Type | -The type of tag to generate. You can generate any tag, but you are responsible for making sure that the structure conforms to accessibility requirements. | -
- Output with a group title of "Example" and 5 H6 tags. -
- - - -@code { - protected override void OnInitialized() - { - // Make a new list of toc items - ListTools are the primary way to modify a PDF using the toolset. Each tool has a specific purpose.
- -- Welcome to the docs! These pages contain all of the info related to the project. If you can't find what you are looking for, consider making an issue. -
- -- Select a page from the left-hand navigation menu. When you are done reading, return to the edit section. To avoid losing any PDF that is in the edit process, do not close this tab! You must return to the edit section from the nav menu as opening a new tab counts as a new instance of the application. -
\ No newline at end of file diff --git a/Pages/Docs/_Imports.razor b/Pages/Docs/_Imports.razor deleted file mode 100644 index ca195b4..0000000 --- a/Pages/Docs/_Imports.razor +++ /dev/null @@ -1,2 +0,0 @@ -@* Copyright (C) Jonathan Shull - See license file at github.com/amytho/pdf-acc-toolset *@ -@layout DocumentationLayout \ No newline at end of file diff --git a/Pages/Index.razor b/Pages/Index.razor index b91c27e..22d1f45 100644 --- a/Pages/Index.razor +++ b/Pages/Index.razor @@ -9,7 +9,7 @@Welcome to the Toolset! This app will help you with the accessibility remediation process of PDFs. Feel free to read - our Documentation or experiment yourself.
+ our Documentation or experiment yourself.We suggest you keep your original document in case you decide to revert changes.
Find a given color of text or a path and replace it. This is primarily used to fix color contrast issues. - See Documentation for more information. + See Documentation for more information.
This tool requires a target and replacement color to be specified. This only applies to paths (shapes) and text. Images, X-Objects, and other elements are not included. Fill is the inner color and stroke is the outer color.
diff --git a/README.md b/README.md index 08178a3..390c6fe 100644 --- a/README.md +++ b/README.md @@ -24,7 +24,7 @@ While the end goal is to remove Acrobat (and any paid tool) from the accessibili ![Task Queue](https://github.com/aMytho/Pdf-Acc-Toolset/assets/58316242/907eb38b-eb18-421a-acd2-8cd2fae5e56b) ## Documentation -The project docs are built into the application. They can be accessed [here](https://pdf-accessibility.tools/docs) +The project docs are hosted on a separate website. They can be accessed [here](https://docs.pdf-accessibility.tools/docs) ## Installation for Development diff --git a/Shared/DocumentationLayout.razor b/Shared/DocumentationLayout.razor deleted file mode 100644 index 3d3f0b9..0000000 --- a/Shared/DocumentationLayout.razor +++ /dev/null @@ -1,50 +0,0 @@ -@* Copyright (C) Jonathan Shull - See license file at github.com/amytho/pdf-acc-toolset *@ -@inherits LayoutComponentBase -@using Pdf_Acc_Toolset.Services.UI - -Find a given color of text or a path and replace it. This is primarily used to fix color contrast issues. - See Documentation for more information. + See Documentation for more information.
This tool requires a target and replacement color to be specified. This only applies to paths (shapes) and text. Images, X-Objects, and other elements are not included. Fill is the inner color and stroke is the outer color.
diff --git a/README.md b/README.md index 390c6fe..d7c97fd 100644 --- a/README.md +++ b/README.md @@ -24,7 +24,7 @@ While the end goal is to remove Acrobat (and any paid tool) from the accessibili ![Task Queue](https://github.com/aMytho/Pdf-Acc-Toolset/assets/58316242/907eb38b-eb18-421a-acd2-8cd2fae5e56b) ## Documentation -The project docs are hosted on a separate website. They can be accessed [here](https://docs.pdf-accessibility.tools/docs) +The project docs are hosted on a separate website. They can be accessed [here](https://docs.pdf-accessibility.tools/docs/workflow/) ## Installation for Development