Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Spell check (URL traversal + Navigation Menus) #87

Merged
merged 8 commits into from
Jul 17, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 16 additions & 0 deletions .custom_wordlist.txt
Original file line number Diff line number Diff line change
Expand Up @@ -57,6 +57,7 @@ changelog
changeset
changesets
charmcraft
CanonicalUrlData
Cmd
CMDLINE
Cobol
Expand All @@ -65,6 +66,8 @@ Codehosting
codeimport
codeimportscheduler
CodeReviewChecklist
codereviewmessage
CodeReviewMessageView
config
configs
ConfiguringWebApplications
Expand Down Expand Up @@ -174,6 +177,10 @@ https
https
iframe
iharness
IBranchMergeProposal
IBranchTarget
ICanonicalUrlData
ICodeReviewMessage
IMailDelivery
IMailer
importances
Expand All @@ -183,6 +190,7 @@ initialized
integrations
io
ip
IPerson
IPv
IPython
irc
Expand All @@ -202,9 +210,11 @@ LandingChanges
langpack
LaunchpadAuthentication
LaunchpadDatabaseRevision
LaunchpadFormView
LaunchpadProductionStatus
LaunchpadObjectFactory
LaunchpadPpa
LaunchpadView
lazr
libera
libgit
Expand Down Expand Up @@ -255,6 +265,8 @@ mockups
mojo
mozilla
natively
NavigationMenu
NavigationMenus
newsampledata
NPM
Expand Down Expand Up @@ -357,6 +369,7 @@ RESTful
rocketfuel
rollout
rollouts
rootsite
rosetta
RPC
rst
Expand Down Expand Up @@ -401,6 +414,7 @@ SSO
StagingServer
standardized
stdin
stepto
steve
stg
StormMigrationGuide
Expand Down Expand Up @@ -469,6 +483,8 @@ untriaged
untrusted
upstreams
unsuffixed
url
urls
userbase
VBScript
vbuilder
Expand Down
2 changes: 1 addition & 1 deletion .sphinx/spellingcheck.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ matrix:
- .custom_wordlist.txt
output: .sphinx/.wordlist.dic
sources:
- _build/**/*.html|!_build/explanation/code/index.html|!_build/explanation/security-policy/index.html|!_build/explanation/database-performance/index.html|!_build/explanation/url-traversal/index.html|!_build/explanation/navigation-menus/index.html|!_build/explanation/storm-migration-guide/index.html
- _build/**/*.html|!_build/explanation/code/index.html|!_build/explanation/security-policy/index.html|!_build/explanation/database-performance/index.html|!_build/explanation/storm-migration-guide/index.html
pipeline:
- pyspelling.filters.html:
comments: false
Expand Down
6 changes: 3 additions & 3 deletions explanation/navigation-menus.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,9 @@ Navigation menus
.. include:: ../includes/important_not_revised.rst

When linking different views in Launchpad page templates it is recommend
to use the !NavigationMenu attached to each facet of that object.
to use the NavigationMenu attached to each facet of that object.

The !NavigationMenus are defined in the *browser* code.
The NavigationMenus are defined in the *browser* code.

An object can have multiple *facets*. For example IPerson has a 'code',
'overview', 'translation' .. etc facets.
Expand Down Expand Up @@ -37,7 +37,7 @@ An

will only return the text without the anchor tag.

From withing a page template, you can use the following TAL expresion to
From withing a page template, you can use the following TAL expression to
generate a link:

::
Expand Down
6 changes: 3 additions & 3 deletions explanation/url-traversal.rst
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ This specifies:
2. attribute_to_parent defines the attribute of this interface that
refers to the parent interface. Remember, we are starting from a
leaf, and working back to the root URL.
3. We are adding comments/${id } to the path of the parent Interface.
3. We are adding comments/${id} to the path of the parent Interface.
Where id is the id field of the instance.
4. rootsite is the subdomain this URL should be rooted at

Expand Down Expand Up @@ -84,8 +84,8 @@ Next, you need to implement the factory:
The function decorators helps reduce the ZCML needed for registration,
they specify:

1. The interface that the adapter will provide: \`ICanonicalUrlData`.
2. The objects that the adapter works with: \`IBranchTarget`.
1. The interface that the adapter will provide: ``ICanonicalUrlData``.
2. The objects that the adapter works with: ``IBranchTarget``.

Note that this is using the context of the view to get the
ICanonicalUrlData. If it were only using the view, you'd get infinite
Expand Down
Loading